TypeAlias
Abstract representation of a Type object. Only applicable for some programming languages like TypeScript.
View source on GitHub
Inherits from
HasValue, HasBlock, Symbol, Expression, Usable, Editable, Importable, HasName
Attributes
attributes
List of expressions defined in this Type object.
code_block
The code block associated with this type alias.
comment
Returns the comment group associated with the symbol, if any.
decorators
Returns list of all decorators on this Symbol.
docstring
Retrieves the docstring of the expression.
extended
Returns a SymbolGroup of all extended nodes associated with this element.
extended_nodes
Returns a list of Editable nodes associated with this symbol, including extended symbols.
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 all function calls within the code block and its decorators.
inline_comment
Returns the inline comment group associated with the symbol, if any.
is_decorated
Check if the symbol has decorators.
name
Retrieves the base name of the object without namespace prefixes.
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
Returns the source code of the symbol.
symbol_type
The type of symbol, set to SymbolType.Interface.
type_parameters
The type parameters of the symbol, if any.
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
add_comment
Adds a comment to the symbol.
View source on GitHub
Parameters
commentrequiredThe comment text to add.
Returns
add_decorator
Adds a decorator to a function or method.
View source on GitHub
Parameters
new_decoratorrequiredThe decorator to add, including the '@' symbol.
skip_if_existsdefault: FalseIf True, skips adding if the decorator exists.
Returns
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
keywordrequiredThe keyword to be inserted. Must be a valid keyword in the language context.
Returns
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_typesdefault: UsageType.DIRECTThe types of dependencies to search for. Defaults to UsageType.DIRECT.
max_depthdefault: NoneMaximum 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 node with new_src.
View source on GitHub
Parameters
new_srcrequiredThe new source code to replace the current source with.
fix_indentationdefault: FalseIf True, adjusts the indentation of new_src to match the current text's indentation. Defaults to False.
prioritydefault: 0The priority of this edit. Higher priority edits take precedence. Defaults to 0.
dedupedefault: TrueIf True, prevents duplicate edits. Defaults to True.
Returns
find
Find and return matching nodes or substrings within an Editable instance.
View source on GitHub
Parameters
strings_to_matchrequiredOne or more strings to search for.
exactdefault: FalseIf 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_matchrequiredA list of strings to search for in string literals.
fuzzy_matchdefault: FalseIf 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_attribute
Get attribute by name.
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_namerequiredThe variable name to search for.
fuzzy_matchdefault: FalseIf 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_srcrequiredThe source code to insert after this node.
fix_indentationdefault: FalseWhether to adjust the indentation of new_src to match the current node. Defaults to False.
newlinedefault: TrueWhether to add a newline before the new_src. Defaults to True.
prioritydefault: 0Priority of the insertion transaction. Defaults to 0.
dedupedefault: TrueWhether to deduplicate identical transactions. Defaults to True.
Returns
insert_before
Inserts text before the current symbol node in the Abstract Syntax Tree.
View source on GitHub
Parameters
new_srcrequiredThe source code text to insert.
fix_indentationdefault: FalseWhether to adjust the indentation of new_src to match current text. Defaults to False.
newlinedefault: TrueWhether to add a newline after insertion. Defaults to True.
prioritydefault: 0Priority of this edit operation. Higher priority edits are applied first. Defaults to 0.
dedupedefault: TrueWhether to remove duplicate insertions. Defaults to True.
extendeddefault: TrueWhether to insert before extended nodes like comments and decorators. Defaults to True.
Returns
is_child_of
Checks if this node is a descendant of the given editable instance in the AST.
View source on GitHub
Returns
is_wrapped_in
Check if this node is contained another node of the given class
View source on GitHub
Returns
move_to_file
Moves the given symbol to a new file and updates its imports and references.
View source on GitHub
Parameters
filerequiredThe destination file to move the symbol to.
include_dependenciesdefault: TrueIf True, moves all dependencies of the symbol to the new file. If False, adds imports for the dependencies. Defaults to True.
strategydefault: "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
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_formattingdefault: TrueWhether to delete surrounding whitespace and formatting. Defaults to True.
prioritydefault: 0Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.
dedupedefault: TrueWhether 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_namerequiredThe new name for the symbol.
prioritydefault: 0Priority 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
oldrequiredThe text or pattern to search for.
newrequiredThe text to replace matches with.
countdefault: -1Maximum number of replacements to make. Defaults to -1 (replace all).
is_regexdefault: FalseWhether to treat 'old' as a regex pattern. Defaults to False.
prioritydefault: 0Priority of the replacement operation. Defaults to 0.
Returns
The total number of replacements made.
search
Returns a list of all regex match of regex_pattern, similar to python's re.search().
View source on GitHub
Parameters
regex_patternrequiredThe regular expression pattern to search for.
include_stringsdefault: TrueWhen False, excludes the contents of string literals from the search. Defaults to True.
include_commentsdefault: TrueWhen False, excludes the contents of comments from the search. Defaults to True.
Returns
A list of Editable objects corresponding to the matches found.
set_comment
Sets a comment to the symbol.
View source on GitHub
Parameters
commentrequiredThe comment text to set.
Returns
set_docstring
Sets or updates the docstring for the current entity.
View source on GitHub
Parameters
docstringrequiredThe new docstring content to set.
Returns
This method doesn't return anything.
set_inline_comment
Sets an inline comment to the symbol.
View source on GitHub
Parameters
commentrequiredThe text of the inline comment to be added or updated.
Returns
set_name
Sets the name of a code element.
View source on GitHub
Parameters
namerequiredThe new name to set for the object.
Returns
set_value
Sets the value of the node's value Expression.
View source on GitHub
Parameters
valuerequiredThe new value to set.
Returns
symbol_usages
Returns a list of symbols that use or import the exportable object.
View source on GitHub
Parameters
usage_typesdefault: NoneThe 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_typesdefault: NoneSpecifies 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.