Class

Abstract representation of a Class definition.

View Source on Github

Inherits from

HasBlock, Callable, Expression, Usable, Symbol, Editable, Importable, HasName

Attributes

call_sites

code_block

comment

constructor

decorators

docstring

extended

extended_nodes

extended_source

file

filepath

full_name

function_calls

inline_comment

is_decorated

is_subclass

name

nested_classes

parameters

parent

parent_class

parent_class_names

parent_classes

parent_function

parent_statement

resolved_value

return_type

source

symbol_type

type_parameters

variable_usages

Methods

add_attribute

Adds an attribute to a class from another class.

View Source on Github

Parameters

add_attribute_from_source

Adds an attribute to a class from raw source code, placing it in a specific location

View Source on Github

Parameters

add_comment

Adds a comment to the symbol.

View Source on Github

Parameters

add_decorator

Adds a decorator to a function or method.

View Source on Github

Parameters

add_keyword

Insert a keyword in the appropriate place before this symbol if it doesn’t already exist.

View Source on Github

Parameters

add_source

Add a block of source code to the bottom of a class definition.

View Source on Github

Parameters

ancestors

Find all ancestors of the node of the given type. Does not return itself

View Source on Github

attributes

Retrieves all attributes from this Class including those from its superclasses up to a

View Source on Github

Parameters

dependencies

Returns a list of symbols that this symbol depends on.

View Source on Github

Parameters

edit

Replace the source of this node with new_src.

View Source on Github

Parameters

find

Find and return matching nodes or substrings within an Editable instance.

View Source on Github

Parameters

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

flag

Adds a visual flag comment to the end of this Editable’s source text.

View Source on Github

get_attribute

Returns a specific attribute by name.

View Source on Github

Parameters

get_method

Returns a specific method by name from the class or any of its superclasses.

View Source on Github

Parameters

get_name

Returns the name node of the object.

View Source on Github

get_nested_class

Returns a nested class by name from the current class.

View Source on Github

Parameters

get_parameter

Gets a specific parameter from the callable’s parameters list by name.

View Source on Github

Parameters

get_parameter_by_index

Returns the parameter at the given index.

View Source on Github

Parameters

get_parameter_by_type

Retrieves a parameter from the callable by its type.

View Source on Github

Parameters

get_parent_class

Returns the parent class node with the specified name.

View Source on Github

Parameters

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

View Source on Github

Parameters

insert_after

Inserts code after this node.

View Source on Github

Parameters

insert_before

Inserts text before the current symbol node in the Abstract Syntax Tree.

View Source on Github

Parameters

is_child_of

Checks if this node is a descendant of the given editable instance in the AST.

View Source on Github

is_subclass_of

Checks if the class inherits from a specified parent class.

View Source on Github

Parameters

is_wrapped_in

Check if this node is contained another node of the given class

View Source on Github

methods

Retrieves all methods that exist on this Class, including methods from superclasses, with

View Source on Github

Parameters

move_to_file

Moves the given symbol to a new file and updates its imports and references.

View Source on Github

Parameters

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

View Source on Github

parent_of_types

Find the first ancestor of the node of the given type. Does not return itself

View Source on Github

reduce_condition

Reduces an editable to the following condition

View Source on Github

remove

Deletes this Node and its related extended nodes (e.g. decorators, comments).

View Source on Github

Parameters

rename

Renames a symbol and updates all its references in the codebase.

View Source on Github

Parameters

replace

Search and replace occurrences of text within this node’s source and its extended nodes.

View Source on Github

Parameters

search

Returns a list of all regex match of regex_pattern, similar to python’s re.search().

View Source on Github

Parameters

set_comment

Sets a comment to the symbol.

View Source on Github

Parameters

set_docstring

Sets or updates the docstring for the current entity.

View Source on Github

Parameters

set_inline_comment

Sets an inline comment to the symbol.

View Source on Github

Parameters

set_name

Sets the name of a code element.

View Source on Github

Parameters

subclasses

Returns all classes which subclass this class.

View Source on Github

Parameters

superclasses

Returns a list of all classes that this class extends, up to max_depth.

View Source on Github

Parameters

symbol_usages

Returns a list of symbols that use or import the exportable object.

View Source on Github

Parameters

usages

Returns a list of usages of the exportable object.

View Source on Github

Parameters