Skip to main content
View Source on Github

​
Inherits from

Expression, Editable, SymbolGroup

​
Attributes

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

​
function_calls

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

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

​
source

Get the source code content of the node.

​
symbols

Returns the list of symbols in the group.

​
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

​
edit

Edit the source for this Collection instance.
View Source on Github

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_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.

​
index

Return the index of the first occurrence of value.
View Source on Github

Returns

​
insert

Adds value to the container that this node represents
View Source on Github

Returns

​
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

Removes an element from a Collection.
View Source on Github

Parameters

value
default:None
The element to remove from the Collection. If None, delegates to parent class.

Returns

This method doesn't return anything.

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