FunctionCall

Abstract representation of a function invocation, e.g. in Python: def f(): g() # FunctionCall

View Source on Github

Inherits from

Expression, HasName, Editable

Attributes

args

Collection[ Argument , FunctionCall ]

Returns a list of arguments passed into the function invocation.

attribute_chain

list[ FunctionCall | Name ]

Returns a list of elements in the chainedAttribute that the function call belongs in.

base

Editable | None

Returns the base object of this function call chain.

call_chain

list[ FunctionCall ]

Returns a list of all function calls in this function call chain, including this call. Does not include calls made after this one.

extended

SymbolGroup

Returns a SymbolGroup of all extended nodes associated with this element.

extended_source

str

Returns the source text representation of all extended nodes.

file

SourceFile

The file object that this Editable instance belongs to.

filepath

str

The file path of the file that this Editable instance belongs to.

full_name

str | None

Returns the full name of the object, including the namespace path.

function_calls

list[ FunctionCall ]

Returns a list of all function calls contained within this function call.

function_definition

Callable | None

Returns the resolved function definition that is being called.

function_definitions

list[ Callable ]

Returns a list of callable objects that could potentially be the target of this function

is_awaited

bool

Determine if this function call is ultimately awaited in the TypeScript AST.

name

str | None

Retrieves the base name of the object without namespace prefixes.

parent

Editable

The parent node of this Editable instance.

parent_class

Class | None

Find the class this node is contained in

parent_function

Function | None

Retrieves the parent function of the current function call.

parent_statement

Statement | None

Find the statement this node is contained in

predecessor

FunctionCall [ Editable ] | None

Returns the previous function call in a function call chain.

promise_chain

TSPromiseChain | None

Return the promise chain associated with this function call, if a then call is found.

resolved_value

Expression | list[ Expression ]

Returns the resolved type of an Expression.

source

str

Gets the source code representation of this FunctionCall.

successor

FunctionCall [ Editable ] | None

Returns the next function call in a function call chain.

variable_usages

list[ Editable ]

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

View Source on Github

Returns

list[ Editable ]

asyncify

Converts the function call to an async function call by wrapping it with ‘await’.

View Source on Github

Returns

None

convert_args_to_kwargs

Converts positional arguments in a function call to keyword arguments.

View Source on Github

Parameters

exclude

int

default:0

Number of leading positional arguments to exclude from conversion. Defaults to 0.

Returns

None

edit

Replace the source of this Editable with new_src.

View Source on Github

Parameters

new_src

str

required

The new source text to replace the current text with.

fix_indentation

bool

default:False

If True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.

priority

int

default:0

The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.

dedupe

bool

default:True

If True, deduplicates identical transactions. Defaults to True.

Returns

None

find

Find and return matching nodes or substrings within an Editable instance.

View Source on Github

Parameters

strings_to_match

Union[list[str], str]

required

One or more strings to search for.

exact

bool

default:False

If True, only return nodes whose source exactly matches one of the strings_to_match.

Returns

list[ Editable ]

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

View Source on Github

Parameters

strings_to_match

list[str]

required

A list of strings to search for in string literals.

fuzzy_match

bool

default:False

If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.

Returns

list[ Editable [ FunctionCall ]]

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.

View Source on Github

Returns

CodeFlag[ FunctionCall ]

from_usage

Creates a FunctionCall object from an Editable instance that represents a function call.

View Source on Github

Parameters

node

Editable [ Editable ]

required

The Editable node that potentially represents a function call.

parent

Editable | None

default:None

The parent node for the new FunctionCall. If None, uses the parent from the input node.

Returns

FunctionCall | None

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.

View Source on Github

Parameters

arg_idx

int

required

The index of the argument to retrieve.

Returns

Argument | None

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.

View Source on Github

Parameters

param_name

str

required

The name of the parameter to search for.

Returns

Argument | None

The matching argument if found, None otherwise.

get_name

Returns the name node of the object.

View Source on Github

Returns

Name | ChainedAttribute | None

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

View Source on Github

Parameters

var_name

str

required

The variable name to search for.

fuzzy_match

bool

default:False

If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.

Returns

Sequence[ Editable [ FunctionCall ]]

List of Editable objects representing variable usage nodes matching the given name.

insert_after

Inserts code after this node.

View Source on Github

Parameters

new_src

str

required

The source code to insert after this node.

fix_indentation

bool, optional

default:False

Whether to adjust the indentation of new_src to match the current node. Defaults to False.

newline

bool, optional

default:True

Whether to add a newline before the new_src. Defaults to True.

priority

int, optional

default:0

Priority of the insertion transaction. Defaults to 0.

dedupe

bool, optional

default:True

Whether to deduplicate identical transactions. Defaults to True.

Returns

None

insert_before

Inserts text before this node’s source with optional indentation and newline handling.

View Source on Github

Parameters

new_src

str

required

The text to insert before this node.

fix_indentation

bool

default:False

Whether to fix the indentation of new_src to match the current node. Defaults to False.

newline

bool

default:True

Whether to add a newline after new_src. Defaults to True.

priority

int

default:0

Transaction priority for managing multiple edits. Defaults to 0.

dedupe

bool

default:True

Whether to deduplicate identical transactions. Defaults to True.

Returns

None

is_child_of

Checks if this node is a descendant of the given editable instance in the AST.

View Source on Github

Returns

bool

is_wrapped_in

Check if this node is contained another node of the given class

View Source on Github

Returns

bool

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

View Source on Github

Returns

Editable | None

parent_of_types

Find the first ancestor of the node of the given type. Does not return itself

View Source on Github

Returns

Editable | None

reduce_condition

Reduces an editable to the following condition

View Source on Github

Returns

None

remove

Removes a node and optionally its related extended nodes.

View Source on Github

Parameters

delete_formatting

bool, optional

default:True

Whether to delete associated formatting nodes. Defaults to True.

priority

int, optional

default:0

Priority level for the removal operation. Defaults to 0.

dedupe

bool, optional

default:True

Whether to deduplicate identical removals. Defaults to True.

Returns

None

rename

Sets the name of an object and updates all its usages.

View Source on Github

Parameters

name

str

required

The new name to assign to the object.

Returns

None

replace

Search and replace occurrences of text within this node’s source and its extended nodes.

View Source on Github

Parameters

old

str

required

The text or pattern to search for.

new

str

required

The text to replace matches with.

count

int, optional

default:-1

Maximum number of replacements to make. Defaults to -1 (replace all).

is_regex

bool, optional

default:False

Whether to treat 'old' as a regex pattern. Defaults to False.

priority

int, optional

default:0

Priority of the replacement operation. Defaults to 0.

Returns

int

The total number of replacements made.

search

Returns a list of all regex match of regex_pattern, similar to python’s re.search().

View Source on Github

Parameters

regex_pattern

str

required

The regular expression pattern to search for.

include_strings

bool

default:True

When False, excludes the contents of string literals from the search. Defaults to True.

include_comments

bool

default:True

When False, excludes the contents of comments from the search. Defaults to True.

Returns

list[ Editable ]

A list of Editable objects corresponding to the matches found.

set_kwarg

Set a keyword argument in a function call.

View Source on Github

Parameters

name

str

required

The name of the parameter/argument to set.

value

str

required

The value to set the argument to.

create_on_missing

bool, optional

default:True

If True, creates a new keyword argument if it doesn't exist. Defaults to True.

override_existing

bool, optional

default:True

If True, modifies the value of existing argument. Defaults to True.

Returns

None

set_name

Sets the name of a code element.

View Source on Github

Parameters

name

str

required

The new name to set for the object.

Returns

None