TSExport
Represents a single exported symbol. There is a 1:M relationship between an ExportStatement and an Export
View source on GitHub
Inherits from
HasValue, Export, Editable, Exportable, Usable, Importable, Expression, HasName
Attributes
declared_symbol
Returns the symbol that was defined in this export.
descendant_symbols
Returns a list of all descendant symbols from this export's declared symbol.
export
Returns the export object that exports this symbol.
export_statement
The statement representing the export.
exported_name
Retrieves the exported name of a symbol from its file.
exported_symbol
Returns the symbol, file, or import being exported from this export object.
extended
Returns a SymbolGroup of all extended nodes associated with this element.
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 a list of all function calls contained within this expression.
is_exported
Indicates if the symbol is exported from its defining file.
is_external_export
Determines if this export is exporting a symbol from an external (non-relative) module.
is_reexported
Determines if the symbol is re-exported from a different file.
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_symbol
Returns the Symbol, SourceFile or External module that this export resolves to.
resolved_value
Returns the resolved type of an Expression.
source
Returns the source code of the symbol.
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
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 Editable with new_src.
View source on GitHub
Parameters
new_srcrequiredThe new source text to replace the current text with.
fix_indentationdefault: FalseIf True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.
prioritydefault: 0The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.
dedupedefault: TrueIf True, deduplicates identical transactions. 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_import_string
Returns the import string for this export.
View source on GitHub
Parameters
aliasdefault: NoneOptional alias to use when importing the symbol.
moduledefault: NoneOptional module name to import from.
import_typedefault: ImportType.UNKNOWNThe type of import to generate.
is_type_importdefault: FalseWhether this is a type-only import.
Returns
The formatted import string.
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 this node's source with optional indentation and newline handling.
View source on GitHub
Parameters
new_srcrequiredThe text to insert before this node.
fix_indentationdefault: FalseWhether to fix the indentation of new_src to match the current node. Defaults to False.
newlinedefault: TrueWhether to add a newline after new_src. Defaults to True.
prioritydefault: 0Transaction priority for managing multiple edits. Defaults to 0.
dedupedefault: TrueWhether to deduplicate identical transactions. Defaults to True.
Returns
is_aliased
Determines if the Export object is aliased.
View source on GitHub
Returns
True if the exported symbol has a different name than the name it is exported as, False otherwise.
is_child_of
Checks if this node is a descendant of the given editable instance in the AST.
View source on GitHub
Returns
is_default_export
Determines if an export is the default export for a file.
View source on GitHub
Returns
True if this is a default export, False otherwise.
is_default_symbol_export
Returns True if this is exporting a default symbol, as opposed to a default object export.
View source on GitHub
Parameters
selfrequiredThe export object being checked.
Returns
True if this is a default symbol export, False otherwise.
is_module_export
Determines if the export is exporting a module rather than a symbol.
View source on GitHub
Returns
True if the export represents a module export, False otherwise.
is_named_export
Determines whether this export is a named export.
View source on GitHub
Returns
True if this is a named export, False if it is a default export.
is_reexport
Returns whether the export is re-exporting an import or export.
View source on GitHub
Parameters
selfrequiredThe export node being checked.
Returns
True if this export re-exports an imported/exported symbol or entire module, False otherwise.
is_type_export
Determines if this export is exclusively exporting a type.
View source on GitHub
Returns
True if this is a type-only export, False otherwise.
is_wildcard_export
Determines if the export is a wildcard export.
View source on GitHub
Returns
True if the export is a wildcard export (e.g. 'export * from "./module"'), False otherwise.
is_wrapped_in
Check if this node is contained another node of the given class
View source on GitHub
Returns
make_non_default
Converts the export to a named export.
View source on GitHub
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
reexport_symbol
Returns the import object that is re-exporting this symbol.
View source on GitHub
Returns
The import object being re-exported, or None if this is not a re-export or no import was found.
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_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.
to_import_string
Converts this export into its equivalent import string representation.
View source on GitHub
Returns
The import string representation of this export. Examples: - For `export { foo } from './bar'` -> `import { foo } from './bar'` - For `export * from './bar'` -> `import * as _namespace from './bar'` - For `export { default as foo } from './bar'` -> `import foo from './bar'`
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.