FunctionCall
Abstract representation of a function invocation, e.g. in Python: def f(): g() # FunctionCall
Inherits from
Attributes
args
Returns a list of arguments passed into the function invocation.
base
Returns the base object of this function call chain.
call_chain
Returns a list of all function calls in this function call chain, including this call. Does not include calls made after this one.
extended
Returns a SymbolGroup of all extended nodes associated with this element.
extended_source
strReturns the source text representation of all extended nodes.
file
The file object that this Editable instance belongs to.
file_node_id
NodeId
filepath
strThe file path of the file that this Editable instance belongs to.
full_name
str | NoneReturns the full name of the object, including the namespace path.
function_calls
Returns a list of all function calls contained within this function call.
function_definition
Returns the resolved function definition that is being called.
function_definitions
Returns a list of callable objects that could potentially be the target of this function
is_awaited
boolDetermine if this function call is ultimately awaited in the TypeScript AST.
name
str | NoneRetrieves the base name of the object without namespace prefixes.
node_type
NodeType
parent
parent_class
Find the class this node is contained in
parent_function
Retrieves the parent function of the current function call.
parent_statement
Find the statement this node is contained in
predecessor
Returns the previous function call in a function call chain.
resolved_value
Returns the resolved type of an Expression.
source
strGets the source code representation of this FunctionCall.
ts_node
TSNode
variable_usages
Returns Editables for all TreeSitter node instances of variable usages within this node's
Methods
ancestors
Find all ancestors of the node of the given type. Does not return itself
Returns
asyncify
Converts the function call to an async function call by wrapping it with ‘await’.
Returns
Noneconvert_args_to_kwargs
Converts positional arguments in a function call to keyword arguments.
Parameters
intNumber of leading positional arguments to exclude from conversion. Defaults to 0.
Returns
Noneedit
Replace the source of this Editable with new_src.
Parameters
strThe new source text to replace the current text with.
boolIf True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.
intThe priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.
boolIf True, deduplicates identical transactions. Defaults to True.
Returns
Nonefind
Find and return matching nodes or substrings within an Editable instance.
Parameters
Union[list[str], str]One or more strings to search for.
boolIf True, only return nodes whose source exactly matches one of the strings_to_match.
Returns
A list of Editable instances that match the search criteria.
find_string_literals
Returns a list of string literals within this node’s source that match any of the given
Parameters
list[str]A list of strings to search for in string literals.
boolIf True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.
Returns
A list of Editable objects representing the matching string literals.
flag
Adds a visual flag comment to the end of this Editable’s source text.
Returns
from_usage
Creates a FunctionCall object from an Editable instance that represents a function call.
Parameters
Returns
A new FunctionCall object if the input node represents a function call, None otherwise.
get_arg_by_index
Returns the Argument with the given index from the function call’s argument list.
Parameters
intThe index of the argument to retrieve.
Returns
The Argument object at the specified index, or None if the index is out of bounds.
get_arg_by_parameter_name
Returns an argument by its parameter name.
Parameters
strThe name of the parameter to search for.
Returns
The matching argument if found, None otherwise.
get_name
Returns the name node of the object.
Returns
The name node of the object. Can be a Name node for simple names, a ChainedAttribute for names with namespaces (e.g., a.b), or None if the object has no name.
get_variable_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
Parameters
strThe variable name to search for.
boolIf True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.
Returns
List of Editable objects representing variable usage nodes matching the given name.
insert_after
Inserts code after this node.
Parameters
strThe source code to insert after this node.
bool, optionalWhether to adjust the indentation of new_src to match the current node. Defaults to False.
bool, optionalWhether to add a newline before the new_src. Defaults to True.
int, optionalPriority of the insertion transaction. Defaults to 0.
bool, optionalWhether to deduplicate identical transactions. Defaults to True.
Returns
Noneinsert_before
Inserts text before this node’s source with optional indentation and newline handling.
Parameters
strThe text to insert before this node.
boolWhether to fix the indentation of new_src to match the current node. Defaults to False.
boolWhether to add a newline after new_src. Defaults to True.
intTransaction priority for managing multiple edits. Defaults to 0.
boolWhether to deduplicate identical transactions. Defaults to True.
Returns
Noneis_wrapped_in
Check if this node is contained another node of the given class
Returns
boolparent_of_type
Find the first ancestor of the node of the given type. Does not return itself
Returns
reduce_condition
Reduces an editable to the following condition
Returns
Noneremove
Removes a node and optionally its related extended nodes.
Parameters
bool, optionalWhether to delete associated formatting nodes. Defaults to True.
int, optionalPriority level for the removal operation. Defaults to 0.
bool, optionalWhether to deduplicate identical removals. Defaults to True.
Returns
Nonerename
Sets the name of an object and updates all its usages.
Parameters
strThe new name to assign to the object.
Returns
Nonereplace
Search and replace occurrences of text within this node’s source and its extended nodes.
Parameters
strThe text or pattern to search for.
strThe text to replace matches with.
int, optionalMaximum number of replacements to make. Defaults to -1 (replace all).
bool, optionalWhether to treat 'old' as a regex pattern. Defaults to False.
int, optionalPriority of the replacement operation. Defaults to 0.
Returns
intThe total number of replacements made.
search
Returns a list of all regex match of regex_pattern, similar to python’s re.search().
Parameters
strThe regular expression pattern to search for.
boolWhen False, excludes the contents of string literals from the search. Defaults to True.
boolWhen False, excludes the contents of comments from the search. Defaults to True.
Returns
A list of Editable objects corresponding to the matches found.
set_kwarg
Set a keyword argument in a function call.
Parameters
strThe name of the parameter/argument to set.
strThe value to set the argument to.
bool, optionalIf True, creates a new keyword argument if it doesn't exist. Defaults to True.
bool, optionalIf True, modifies the value of existing argument. Defaults to True.
Returns
Noneset_name
Sets the name of a code element.
Parameters
strThe new name to set for the object.
Returns
NoneWas this page helpful?