Class
Abstract representation of a Class definition.
Inherits from
HasBlock, Callable, Expression, Usable, Symbol, Editable, Importable, HasName
Attributes
call_sites
Returns all call sites (invocations) of this callable in the codebase.
code_block
The code block that may trigger an exception
comment
Returns the comment group associated with the symbol, if any.
constructor
Returns the constructor method for this class.
constructor_keyword
decorators
Returns list of all decorators on this Symbol.
dependencies
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
strReturns the source text representation of all extended nodes.
file
The file object that this Editable instance belongs to.
file_node_id
NodeId
filepath
strThe file path of the file that this Editable instance belongs to.
full_name
str | NoneReturns 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
boolCheck if the symbol has decorators.
is_subclass
boolIndicates whether the current class is a subclass of another class.
name
str | NoneRetrieves the base name of the object without namespace prefixes.
nested_classes
Retrieves the nested classes defined within this class.
node_type
NodeType
parameters
Retrieves all parameters of a callable symbol.
parent
parent_class
Find the class this node is contained in
parent_class_names
Returns a list of the parent class names that this class inherits from.
parent_classes
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.
return_type
source
strReturns the source code of the symbol.
symbol_type
ts_node
TSNode
type_parameters
variable_usages
Returns Editables for all TreeSitter node instances of variable usages within this node's
Methods
add_attribute
Adds an attribute to a class from another class.
Parameters
The attribute to add to the class.
bool, optionalWhether to include the attribute's dependencies. If True, adds any necessary imports to the class's file. Defaults to False.
Returns
Noneadd_attribute_from_source
Adds an attribute to a class from raw source code, placing it in a specific location
Parameters
strThe source code of the attribute to be added.
Returns
Noneadd_comment
Adds a comment to the symbol.
Parameters
strThe comment text to add.
Returns
Noneadd_decorator
Adds a decorator to a function or method.
Parameters
strThe decorator to add, including the '@' symbol.
bool, optionalIf True, skips adding if the decorator exists.
Returns
boolTrue 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.
Parameters
strThe keyword to be inserted. Must be a valid keyword in the language context.
Returns
Noneadd_source
Add a block of source code to the bottom of a class definition.
Parameters
strThe source code to be added to the class definition. The code should be properly formatted
Returns
Noneancestors
Find all ancestors of the node of the given type. Does not return itself
Returns
attributes
Retrieves all attributes from this Class including those from its superclasses up to a
Parameters
int | NoneThe maximum depth of superclass traversal. None means no limit, 0 means only this class.
boolWhether to include private attributes. Defaults to True.
Returns
A list of unique attributes from this class and its superclasses. If an attribute is defined in multiple classes, the first definition encountered is used.
edit
Replace the source of this node with new_src.
Parameters
strThe new source code to replace the current source with.
boolIf True, adjusts the indentation of new_src to match the current text's indentation. Defaults to False.
intThe priority of this edit. Higher priority edits take precedence. Defaults to 0.
boolIf True, prevents duplicate edits. Defaults to True.
Returns
Nonefind
Find and return matching nodes or substrings within an Editable instance.
Parameters
Union[list[str], str]One or more strings to search for.
boolIf 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
Parameters
list[str]A list of strings to search for in string literals.
boolIf 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.
Returns
get_attribute
Returns a specific attribute by name.
Parameters
strThe name of the attribute to search for.
Returns
The matching attribute if found, None otherwise. If multiple attributes with the same name exist in the inheritance hierarchy, returns the first one found.
get_method
Returns a specific method by name from the class or any of its superclasses.
Parameters
strThe name of the method to find.
Returns
The method if found, None otherwise.
get_name
Returns the name node of the object.
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_nested_class
Returns a nested class by name from the current class.
Parameters
strThe name of the nested class to find.
Returns
The nested class if found, None otherwise.
get_parameter
Gets a specific parameter from the callable’s parameters list by name.
Parameters
strThe name of the parameter to retrieve.
Returns
The parameter with the specified name, or None if no parameter with that name exists or if there are no parameters.
get_parameter_by_index
Returns the parameter at the given index.
Parameters
intThe index of the parameter to retrieve.
Returns
The parameter at the specified index, or None if the parameter list is empty or the index does not exist.
get_parameter_by_type
Retrieves a parameter from the callable by its type.
Parameters
The type to search for.
Returns
The parameter with the specified type, or None if no parameter is found or if the callable has no parameters.
get_parent_class
Returns the parent class node with the specified name.
Parameters
strThe name of the parent class to find.
Returns
The matching parent class node, or None if no match is found.
get_variable_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
Parameters
strThe variable name to search for.
boolIf 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.
Parameters
strThe source code to insert after this node.
bool, optionalWhether to adjust the indentation of new_src to match the current node. Defaults to False.
bool, optionalWhether to add a newline before the new_src. Defaults to True.
int, optionalPriority of the insertion transaction. Defaults to 0.
bool, optionalWhether to deduplicate identical transactions. Defaults to True.
Returns
Noneinsert_before
Inserts text before the current symbol node in the Abstract Syntax Tree.
Parameters
strThe source code text to insert.
boolWhether to adjust the indentation of new_src to match current text. Defaults to False.
boolWhether to add a newline after insertion. Defaults to True.
intPriority of this edit operation. Higher priority edits are applied first. Defaults to 0.
boolWhether to remove duplicate insertions. Defaults to True.
boolWhether to insert before extended nodes like comments and decorators. Defaults to True.
Returns
Noneis_subclass_of
Checks if the class inherits from a specified parent class.
Parameters
The parent class to check for. Can be specified either as a class name string or Class object.
int | NoneMaximum inheritance depth to search. None means no limit.
Returns
boolTrue if this class inherits from the parent class, False otherwise.
is_wrapped_in
Check if this node is contained another node of the given class
Returns
boolmethods
Retrieves all methods that exist on this Class, including methods from superclasses, with
Parameters
int | None, optionalInclude parent classes up to max_depth. None means no limit, 0 means only current class. Defaults to 0.
bool, optionalWhether to include private methods. Defaults to True.
bool, optionalWhether to include magic methods. Defaults to False.
Returns
move_to_file
Moves the given symbol to a new file and updates its imports and references.
Parameters
The destination file to move the symbol to.
boolIf True, moves all dependencies of the symbol to the new file. If False, adds imports for the dependencies. Defaults to True.
strThe strategy to use for updating imports. Can be either 'add_back_edge' or 'update_all_imports'. Defaults to 'update_all_imports'.
Returns
Noneparent_of_type
Find the first ancestor of the node of the given type. Does not return itself
Returns
reduce_condition
Reduces an editable to the following condition
Returns
Noneremove
Deletes this Node and its related extended nodes (e.g. decorators, comments).
Parameters
boolWhether to delete surrounding whitespace and formatting. Defaults to True.
intPriority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.
boolWhether to deduplicate removal transactions at the same location. Defaults to True.
Returns
Nonerename
Renames a symbol and updates all its references in the codebase.
Parameters
strThe new name for the symbol.
intPriority of the edit operation. Defaults to 0.
Returns
tuple[NodeId, NodeId]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.
Parameters
strThe text or pattern to search for.
strThe text to replace matches with.
int, optionalMaximum number of replacements to make. Defaults to -1 (replace all).
bool, optionalWhether to treat 'old' as a regex pattern. Defaults to False.
int, optionalPriority of the replacement operation. Defaults to 0.
Returns
intThe total number of replacements made.
search
Returns a list of all regex match of regex_pattern, similar to python’s re.search().
Parameters
strThe regular expression pattern to search for.
boolWhen False, excludes the contents of string literals from the search. Defaults to True.
boolWhen 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.
Parameters
strThe comment text to set.
Returns
Noneset_docstring
Sets or updates the docstring for the current entity.
Parameters
strThe new docstring content to set.
Returns
NoneThis method doesn't return anything.
set_inline_comment
Sets an inline comment to the symbol.
Parameters
strThe text of the inline comment to be added or updated.
Returns
Noneset_name
Sets the name of a code element.
Parameters
strThe new name to set for the object.
Returns
Nonesubclasses
Returns all classes which subclass this class.
Parameters
int | None, optionalMaximum inheritance depth to search. If None, searches all depths. Defaults to None.
Returns
A list of Class objects that inherit from this class.
superclasses
Returns a list of all classes that this class extends, up to max_depth.
Parameters
int | NoneThe maximum depth to traverse up the inheritance tree. If None, traverses the entire tree.
Returns
A list of all superclass symbols in MRO order, up to max_depth. Returns an empty list if the class has no parent classes.
symbol_usages
Returns a list of symbols that use or import the exportable object.
Parameters
The types of usages to search for. Defaults to any.
usages
Returns a list of usages of the exportable object.
Parameters
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.
Was this page helpful?