Skip to main content
View Source on Github

​
Inherits from

Usable, AssignmentStatement, Editable, Importable, HasValue, Statement, Expression, HasName

​
Attributes

​
assignment

The assignment associated with the attribute.

​
assignments

A list of assignments within the statement.

​
extended

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

​
extended_source

Returns the source text representation of all extended nodes.

​
file

The file object that this Editable instance belongs to.

​
filepath

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

​
full_name

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

​
function_calls

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

​
index

The 0-based index of the statement in the parent code block.

​
is_optional

Returns whether the attribute is optional.

​
is_private

Indicates whether the attribute is private.

​
left

The left-hand side expression of the first assignment.

​
name

Retrieves the base name of the object without namespace prefixes.

​
nested_code_blocks

Returns all nested code blocks within the statement.

​
nested_statements

Returns a list of statement collections within nested code blocks.

​
parent

The parent node of this Editable instance.

​
parent_class

Find the class this node is contained in

​
parent_function

Find the function this node is contained in

​
parent_statement

Find the statement this node is contained in

​
resolved_value

Returns the resolved type of an Expression.
The right-hand side expression of the first assignment, or None if not applicable.

​
source

Text representation of the Editable instance.

​
value

Gets the value node of the object.

​
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
View Source on Github

Returns

​
dependencies

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

Parameters

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

Returns

A list of symbols and imports that this symbol depends on, sorted by file location.

​
edit

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

Parameters

new_src
required
The new source text to replace the current text with.
fix_indentation
default:False
If True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.
priority
default:0
The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.
dedupe
default:True
If True, deduplicates identical transactions. Defaults to True.

Returns

​
find

Find and return matching nodes or substrings within an Editable instance.
View Source on Github

Parameters

strings_to_match
required
One or more strings to search for.
exact
default:False
If 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
View Source on Github

Parameters

strings_to_match
required
A list of strings to search for in string literals.
fuzzy_match
default:False
If 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.
View Source on Github

Returns

​
get_name

Returns the name node of the object.
View Source on Github

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
View Source on Github

Parameters

var_name
required
The variable name to search for.
fuzzy_match
default:False
If 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.
View Source on Github

Parameters

new_src
required
The source code to insert after this node.
fix_indentation
default:False
Whether to adjust the indentation of new_src to match the current node. Defaults to False.
newline
default:True
Whether to add a newline before the new_src. Defaults to True.
priority
default:0
Priority of the insertion transaction. Defaults to 0.
dedupe
default:True
Whether to deduplicate identical transactions. Defaults to True.

Returns

​
insert_before

Inserts text before this node’s source with optional indentation and newline handling.
View Source on Github

Parameters

new_src
required
The text to insert before this node.
fix_indentation
default:False
Whether to fix the indentation of new_src to match the current node. Defaults to False.
newline
default:True
Whether to add a newline after new_src. Defaults to True.
priority
default:0
Transaction priority for managing multiple edits. Defaults to 0.
dedupe
default:True
Whether to deduplicate identical transactions. Defaults to True.

Returns

​
is_wrapped_in

Check if this node is contained another node of the given class
View Source on Github

Returns

​
parent_of_type

Find the first ancestor of the node of the given type. Does not return itself
View Source on Github

Returns

​
parent_of_types

Find the first ancestor of the node of the given type. Does not return itself
View Source on Github

Returns

​
reduce_condition

Reduces an editable to the following condition
View Source on Github

Returns

​
remove

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

Parameters

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

Returns

​
rename

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

Parameters

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

Returns

A tuple containing the file node ID and the new node ID of the renamed symbol.

​
replace

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

Parameters

old
required
The text or pattern to search for.
new
required
The text to replace matches with.
count
default:-1
Maximum number of replacements to make. Defaults to -1 (replace all).
is_regex
default:False
Whether to treat 'old' as a regex pattern. Defaults to False.
priority
default:0
Priority of the replacement operation. Defaults to 0.

Returns

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
required
The regular expression pattern to search for.
include_strings
default:True
When False, excludes the contents of string literals from the search. Defaults to True.
include_comments
default:True
When False, excludes the contents of comments from the search. Defaults to True.

Returns

A list of Editable objects corresponding to the matches found.

​
set_name

Sets the name of a code element.
View Source on Github

Parameters

name
required
The new name to set for the object.

Returns

​
set_value

Sets the value of a node’s assignment.
View Source on Github

Parameters

value
required
The new value to set for the assignment.

Returns

​
symbol_usages

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

Parameters

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

Returns

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
default:None
Specifies which types of usages to include in the results. Default is any usages.

Returns

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