Skip to main content
View Source on Github

​
Inherits from

Editable

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

​
next_named_sibling

Returns the next named sibling of the last symbol in the group.

​
next_sibling

Returns the next sibling of the last symbol in the symbol group.

​
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

​
source

Returns the concatenated source code of all symbols in the group.

​
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

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

Parameters

new_src
required
The new source text to replace the current text with.
fix_indentation
default:False
Adjusts the indentation of new_src to match the current text's indentation. Defaults to False.
priority
default:0
Priority of the edit operation. Higher priority edits take precedence. Defaults to 0.
dedupe
default:True
Prevents duplicate edits at the same location. Defaults to True.

Returns

​
find

Search for substrings in the given symbols that match strings_to_match.
View Source on Github

Parameters

strings_to_match
required
The string or list of strings to search for.
exact
default:False
If True, only return nodes that exactly match the query.

Returns

A list of Editable objects representing each match found.

​
find_string_literals

Search for string literals matching given strings in the SymbolGroup.
View Source on Github

Parameters

strings_to_match
required
List of strings to search for in string literals.
fuzzy_match
default:False
If True, performs fuzzy matching instead of exact matching.

Returns

List of Editable nodes representing the matching string literals found within the symbols.

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

​
insert_after

Inserts source code after this node in the codebase.
View Source on Github

Parameters

new_src
required
The source code to insert.
fix_indentation
default:False
Adjust indentation to match current text.
newline
default:True
Add a newline before the inserted code.
priority
default:0
Priority of the edit operation.
dedupe
default:True
Deduplicate identical edits.

Returns

​
insert_before

Inserts source code before this symbol group.
View Source on Github

Parameters

new_src
required
The source code to insert.
fix_indentation
default:False
Whether to adjust the indentation of the inserted code to match the current code. Defaults to False.
newline
default:True
Whether to add a newline after the inserted code. Defaults to True.
priority
default:0
The priority of this edit operation. Higher priority edits are applied first. Defaults to 0.
dedupe
default:True
Whether to prevent duplicate insertions of the same code. 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 this node and its related extended nodes from the codebase.
View Source on Github

Parameters

delete_formatting
default:True
Whether to delete related extended nodes like decorators and comments. Defaults to True.
priority
default:0
Priority level of the removal operation. Defaults to 0.
dedupe
default:True
Whether to deduplicate removal operations. Defaults to True.

Returns

​
replace

Replaces all instances of a string with a new string in all symbols within the group.
View Source on Github

Parameters

old
required
The string to be replaced.
new
required
The string to replace with.
count
default:-1
Maximum number of replacements to make. Defaults to -1 (replace all).
priority
default:0
Priority of the replacement operation. Defaults to 0.

Returns

Number of replacements made.
Searches for regex matches in the codebase.
View Source on Github

Parameters

regex_pattern
required
The regular expression pattern to search for.
include_strings
default:True
Whether to include string literals in the search. Defaults to True.
include_comments
default:True
Whether to include comments in the search. Defaults to True.

Returns

A list of Editable objects representing matched text nodes in the codebase.