Export

Represents a single symbol being exported.

Inherits from

Exportable, Usable, Importable, Expression, HasName, Editable

Attributes

export

export_statement

exported_name

exported_symbol

extended

extended_source

file

filepath

full_name

function_calls

is_exported

is_reexported

name

parent

parent_class

parent_function

parent_statement

resolved_symbol

resolved_value

source

variable_usages

Methods

ancestors

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

dependencies

Returns a list of symbols that this symbol depends on.

edit

Replace the source of this Editable with new_src.

find

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

find_string_literals

Returns a list of string literals within this node’s source that match any of the given

flag

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

get_import_string

Returns the import string for a symbol.

get_name

Returns the name node of the object.

get_variable_usages

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

insert_after

Inserts code after this node.

insert_before

Inserts text before this node’s source with optional indentation and newline handling.

is_aliased

Determines if the Export object is aliased.

is_child_of

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

is_module_export

Determines if the export is a module-level export.

is_named_export

Determines if the export is named or default.

is_wrapped_in

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

parent_of_type

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

parent_of_types

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

reduce_condition

Reduces an editable to the following condition

remove

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

rename

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

replace

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

search

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

set_name

Sets the name of a code element.

symbol_usages

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

usages

Returns a list of usages of the exportable object.