Skip to main content
View Source on Github

​
Inherits from

HasBlock, Callable, Symbol, Editable, Expression, Usable, Importable, HasName

​
Attributes

​
call_sites

list[ FunctionCall ]
Returns all call sites (invocations) of this callable in the codebase.

​
code_block

CodeBlock
The block of code associated with the code object.

​
comment

CommentGroup | None
Returns the comment group associated with the symbol, if any.

​
decorators

list[ Decorator ]
Returns list of all decorators on this Symbol.

​
docstring

CommentGroup | None
Retrieves the docstring of the expression.

​
extended

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

​
extended_nodes

list[ Editable ]
Returns a list of Editable nodes associated with this symbol, including extended symbols.

​
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 ]
Gets all function calls within the function and its parameters.

​
function_signature

str
Returns the signature of the function as a string.

​
inferred_return_type

str | None
Gets the inferred type of the function from the language's native language engine / compiler.

​
inline_comment

CommentGroup | None
Returns the inline comment group associated with the symbol, if any.

​
is_async

bool
Returns True if the function is asynchronous.

​
is_constructor

bool
Determines if the current function is a constructor method.

​
is_decorated

bool
Check if the symbol has decorators.

​
is_magic

bool
Returns True if function is a magic method.

​
is_method

bool
Returns whether the function is a method of a class.

​
is_overload

bool
Indicates whether the function is an overloaded function in a multi-function definition.

​
is_private

bool
Determines if a function has a private access modifier.

​
is_property

bool
Returns whether this function is a property.

​
name

str | None
Retrieves the base name of the object without namespace prefixes.

​
nested_functions

list[ Function ]
Returns a list of nested functions defined within this function's code block.

​
parameters

SymbolGroup [ Parameter , Function ] | list[ Parameter ]
Retrieves all parameters of a callable symbol.

​
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
Find the function this node is contained in

​
parent_statement

Statement | None
Find the statement this node is contained in

​
resolved_value

Expression | list[ Expression ]
Returns the resolved type of an Expression.

​
return_statements

list[ ReturnStatement ]
Returns a list of all return statements within this function's body.

​
return_type

Type | Placeholder [ Function ]
The type of value returned by the callable, or a placeholder.

​
source

str
Returns the source code of the symbol.

​
symbol_type

The type of symbol, set to SymbolType.Function.

​
type_parameters

TypeParameters[ Type , Function ] | None
The type parameters of the symbol, if any.

​
variable_usages

list[ Editable ]
Returns Editables for all TreeSitter node instances of variable usages within this node's

​
Methods

​
add_comment

Adds a comment to the symbol.
View Source on Github

Parameters

comment
str
required
The comment text to add.

Returns

None

​
add_decorator

Adds a decorator to a function or method.
View Source on Github

Parameters

new_decorator
str
required
The decorator to add, including the '@' symbol.
skip_if_exists
bool, optional
default:False
If True, skips adding if the decorator exists.

Returns

bool
True if the decorator was added, False if skipped.

​
add_keyword

Insert a keyword in the appropriate place before this symbol if it doesn’t already exist.
View Source on Github

Parameters

keyword
str
required
The keyword to be inserted. Must be a valid keyword in the language context.

Returns

None

​
add_statements

Adds statements to the end of a function body.
View Source on Github

Parameters

lines
str
required
The lines of code to be added at the end of the function body.

Returns

None

​
ancestors

Find all ancestors of the node of the given type. Does not return itself
View Source on Github

Returns

list[ Editable ]

​
asyncify

Modifies the function to be asynchronous.
View Source on Github

Returns

None

​
dependencies

Returns a list of symbols that this symbol depends on.
View Source on Github

Parameters

usage_types
UsageType | None
default:UsageType.DIRECT
The types of dependencies to search for. Defaults to UsageType.DIRECT.
max_depth
int | None
default:None
Maximum depth to traverse in the dependency graph. If provided, will recursively collect

Returns

list[Union[ Symbol , Import ]]
A list of symbols and imports that this symbol depends on, sorted by file location.

​
edit

Replace the source of this node with new_src.
View Source on Github

Parameters

new_src
str
required
The new source code to replace the current source with.
fix_indentation
bool
default:False
If True, adjusts the indentation of new_src to match the current text's indentation. Defaults to False.
priority
int
default:0
The priority of this edit. Higher priority edits take precedence. Defaults to 0.
dedupe
bool
default:True
If True, prevents duplicate edits. 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 [ Function ]]
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[ Function ]

​
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_parameter

Gets a specific parameter from the callable’s parameters list by name.
View Source on Github

Parameters

name
str
required
The name of the parameter to retrieve.

Returns

Parameter | None
The parameter with the specified name, or None if no parameter with that name exists or if there are no parameters.

​
get_parameter_by_index

Returns the parameter at the given index.
View Source on Github

Parameters

index
int
required
The index of the parameter to retrieve.

Returns

Parameter | None
The parameter at the specified index, or None if the parameter list is empty or the index does not exist.

​
get_parameter_by_type

Retrieves a parameter from the callable by its type.
View Source on Github

Parameters

type
Symbol
required
The type to search for.

Returns

Parameter | None
The parameter with the specified type, or None if no parameter is found or if the callable has no parameters.

​
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 [ Function ]]
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 the current symbol node in the Abstract Syntax Tree.
View Source on Github

Parameters

new_src
str
required
The source code text to insert.
fix_indentation
bool
default:False
Whether to adjust the indentation of new_src to match current text. Defaults to False.
newline
bool
default:True
Whether to add a newline after insertion. Defaults to True.
priority
int
default:0
Priority of this edit operation. Higher priority edits are applied first. Defaults to 0.
dedupe
bool
default:True
Whether to remove duplicate insertions. Defaults to True.
extended
bool
default:True
Whether to insert before extended nodes like comments and decorators. Defaults to True.

Returns

None

​
insert_statements

Inserts lines of code into the function body at the specified index.
View Source on Github

Parameters

lines
str
required
The code lines to insert into the function body.
index
int, optional
default:0
The position in the function body where the lines should be inserted. Defaults to 0.

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

​
move_to_file

Moves the given symbol to a new file and updates its imports and references.
View Source on Github

Parameters

file
SourceFile
required
The destination file to move the symbol to.
include_dependencies
bool
default:True
If True, moves all dependencies of the symbol to the new file. If False, adds imports for the dependencies. Defaults to True.
strategy
str
default:"update_all_imports"
The strategy to use for updating imports. Can be either 'add_back_edge' or 'update_all_imports'. Defaults to 'update_all_imports'.

Returns

None

​
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

​
prepend_statements

Prepends the provided code to the beginning of the function body.
View Source on Github

Parameters

lines
str
required
The code to be prepended to the function body.

Returns

None

​
reduce_condition

Reduces an editable to the following condition
View Source on Github

Returns

None

​
remove

Deletes this Node and its related extended nodes (e.g. decorators, comments).
View Source on Github

Parameters

delete_formatting
bool
default:True
Whether to delete surrounding whitespace and formatting. Defaults to True.
priority
int
default:0
Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.
dedupe
bool
default:True
Whether to deduplicate removal transactions at the same location. Defaults to True.

Returns

None

​
rename

Renames a symbol and updates all its references in the codebase.
View Source on Github

Parameters

new_name
str
required
The new name for the symbol.
priority
int
default:0
Priority of the edit operation. Defaults to 0.

Returns

tuple[NodeId, NodeId]
A tuple containing the file node ID and the new node ID of the renamed symbol.

​
rename_local_variable

Renames a local variable and all its usages within a function body.
View Source on Github

Parameters

old_var_name
str
required
The current name of the local variable to be renamed.
new_var_name
str
required
The new name to give to the local variable.
fuzzy_match
bool, optional
default:False
If True, matches variable names that contain old_var_name. Defaults to False.

Returns

None
The method modifies the AST in place.

​
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.
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_comment

Sets a comment to the symbol.
View Source on Github

Parameters

comment
str
required
The comment text to set.

Returns

None

​
set_docstring

Sets or updates the docstring for the current entity.
View Source on Github

Parameters

docstring
str
required
The new docstring content to set.

Returns

None
This method doesn't return anything.

​
set_inline_comment

Sets an inline comment to the symbol.
View Source on Github

Parameters

comment
str
required
The text of the inline comment to be added or updated.

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

​
set_return_type

Sets the return type annotation for the function.
View Source on Github

Parameters

new_return_type
str
required
The new return type annotation to be set. Use an empty string to remove

Returns

None

​
symbol_usages

Returns a list of symbols that use or import the exportable object.
View Source on Github

Parameters

usage_types
UsageType | None
default:None
The types of usages to search for. Defaults to any.

Returns

list[ Import | Symbol | TSExport ]
A list of symbols that use or import the exportable object.

​
usages

Returns a list of usages of the exportable object.
View Source on Github

Parameters

usage_types
UsageType | None
default:None
Specifies which types of usages to include in the results. Default is any usages.

Returns

list[ Usage ]
A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse.