View Source on Github
Inherits from
Usable, HasBlock, File, Importable, Expression, Editable, HasNameAttributes
classes
code_block
content
decorators
directory
docstring
extended
extended_source
extension
file
file_path
filepath
full_name
function_calls
functions
global_vars
import_module_name
import_statements
importers
imports
inbound_imports
is_binary
is_decorated
name
owners
parent
parent_class
parent_function
parent_statement
path
resolved_value
source
start_byte
symbols_sorted_topologically
variable_usages
Methods
add_decorator
Adds a decorator to a function or method.View Source on Github
Parameters
add_import
Adds an import to the file.View Source on Github
Parameters
add_symbol
Addssymbol to the file.
View Source on Github
Parameters
add_symbol_from_source
Adds a symbol to a file from a string representation.View Source on Github
Parameters
ancestors
Find all ancestors of the node of the given type. Does not return itselfView Source on Github
dependencies
Returns a list of symbols that this symbol depends on.View Source on Github
Parameters
edit
Replace the source of this file 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_by_byte_range
Finds all editable objects that overlap with the given byte range in the file.View Source on Github
Parameters
find_string_literals
Returns a list of string literals within this node’s source that match any of the givenView Source on Github
Parameters
flag
Adds a visual flag comment to the end of this Editable’s source text.View Source on Github
get_class
Returns a specific Class by full name. Returns None if not found.View Source on Github
Parameters
get_function
Returns a specific Function by name.View Source on Github
Parameters
get_global_var
Returns a specific global var by name. Returns None if not found.View Source on Github
Parameters
get_import
Returns the import with matching alias. Returns None if not found.View Source on Github
Parameters
get_name
Returns the name node of the object.View Source on Github
get_symbol
Gets a symbol by its name from the file.View Source on Github
Parameters
get_variable_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usageView Source on Github
Parameters
has_import
Returns True if the file has an import with the given alias.View Source on Github
Parameters
insert_after
Inserts code after this node.View Source on Github
Parameters
insert_before
Inserts text before this node’s source with optional indentation and newline handling.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_wrapped_in
Check if this node is contained another node of the given classView Source on Github
parent_of_type
Find the first ancestor of the node of the given type. Does not return itselfView Source on Github
parent_of_types
Find the first ancestor of the node of the given type. Does not return itselfView Source on Github
reduce_condition
Reduces an editable to the following conditionView Source on Github
remove
Removes the file from the file system and graph.View Source on Github
remove_unused_exports
Removes unused exports from the file.View Source on Github
rename
Renames a symbol and updates all its references in the codebase.View Source on Github
Parameters
replace
Replace occurrences of text in the file.View Source on Github
Parameters
search
Returns a list of all regex match ofregex_pattern, similar to python’s re.search().
View Source on Github
Parameters
set_docstring
Sets or updates the docstring for the current entity.View Source on Github
Parameters
set_name
Sets the name of a code element.View Source on Github
Parameters
symbol_can_be_added
Checks if the file type supports adding the given symbol.View Source on Github
Parameters
symbol_usages
Returns a list of symbols that use or import the exportable object.View Source on Github
Parameters
symbols
Returns all Symbols in the file, sorted by position in the file.View Source on Github
update_filepath
Renames the file and updates all imports to point to the new location.View Source on Github
Parameters
usages
Returns a list of usages of the exportable object.View Source on Github