Skip to main content
View Source on Github

​
Inherits from

Parameter, HasValue, Expression, Typeable, Usable, Editable, Importable, HasName

​
Attributes

​
default

str | None
Returns the default value of a parameter if one exists.

​
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

PyFile
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 expression.

​
index

int
Returns the 0-based index of this parameter within its parent function's parameter list.

​
is_optional

bool
Determines if the parameter is optional in Python code.

​
is_typed

bool
Indicates if a node has an explicit type annotation.

​
is_variadic

bool
Determines if a parameter is a variadic parameter.

​
name

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

​
parent

Editable
The parent node of this Editable instance.

​
parent_class

PyClass | None
Find the class this node is contained in

​
parent_function

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

​
source

str
Text representation of the Editable instance.

​
type

Type | TypePlaceholder [ PyParameter ]
The type annotation associated with this node

​
value

Expression | None
Gets the value node of the object.

​
variable_usages

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

​
Methods

​
add_trailing_comment

Add a trailing comment to a parameter in a function signature.
View Source on Github

Parameters

comment
str
required
The comment text to be added after the parameter.

Returns

None

​
ancestors

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

Returns

list[ Editable ]

​
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[ PySymbol , PyImport ]]
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
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 [ PyParameter ]]
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[ PyParameter ]

​
get_name

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

Returns

Name | PyChainedAttribute | 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 [ PyParameter ]]
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 the parameter from the function definition and all its call sites.
View Source on Github

Parameters

delete_formatting
bool, optional
default:True
Whether to delete formatting around the parameter. 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 removal operations. Defaults to True.

Returns

None

​
rename

Renames a parameter in a function definition and updates all related references.
View Source on Github

Parameters

new_name
str
required
The new name for the parameter.
priority
int, optional
default:0
The priority of the edit operation. Defaults to 0.

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

Sets the type annotation of a parameter.
View Source on Github

Parameters

type_annotation
str
required
The type annotation to set for the parameter.
include_comment
str, optional
default:""
A comment to include with the type annotation. Defaults to "".

Returns

None
Use `type.edit` instead.

​
set_value

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

Parameters

value
str
required
The new value to set.

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[ PyImport | PySymbol | Export ]
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.