| title | ExternalModule |
|---|---|
| sidebarTitle | ExternalModule |
| icon | |
| description | Represents an external module, like `datetime`, that can be referenced. These are only added to the graph during import resolution and will not exist in a local file's subgraph. This is because we don't know what an import is referencing or resolves to until we see the full codebase. |
import {Parameter} from '/snippets/Parameter.mdx'; import {ParameterWrapper} from '/snippets/ParameterWrapper.mdx'; import {Return} from '/snippets/Return.mdx'; import {HorizontalDivider} from '/snippets/HorizontalDivider.mdx'; import {GithubLinkNote} from '/snippets/GithubLinkNote.mdx'; import {Attribute} from '/snippets/Attribute.mdx';
Callable, Usable, Importable, Expression, HasName, Editable
### call_sites list[ FunctionCall ] } description="Returns all call sites (invocations) of this callable in the codebase." /> list[Union[ Symbol , Import ]] } description="Returns a list of symbols that this symbol depends on." /> SymbolGroup } description="Returns a SymbolGroup of all extended nodes associated with this element." /> str } description="Returns the source text representation of all extended nodes." /> None } description="File property for ExternalModule class." /> NodeId } description=" " /> str } description="Returns the filepath of the module." /> str | None } description="Returns the full name of the object, including the namespace path." /> list[ FunctionCall ] } description="Returns a list of all function calls contained within this expression." /> str | None } description="Retrieves the base name of the object without namespace prefixes." /> Literal[NodeType.EXTERNAL] } description=" " /> list[ Parameter ] } description="Returns list of named parameters from an external function symbol." /> Editable } description=" " /> Class | None } description="Find the class this node is contained in" /> Function | None } description="Find the function this node is contained in" /> Statement | None } description="Find the statement this node is contained in" /> Expression | list[ Expression ] } description="Returns the resolved type of an Expression." /> Type | Placeholder [ ExternalModule ] } description=" " /> str } description="Text representation of the Editable instance." /> TSNode } description=" " /> list[ Editable ] } description="Returns Editables for all TreeSitter node instances of variable usages within this node's" /> ### ancestors Find all ancestors of the node of the given type. Does not return itself<Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description=""/>
Replace the source of this Editable with new_src.
<Return return_type={ None } description=""/>
Find and return matching nodes or substrings within an Editable instance.
Union[list[str], str] } description="One or more strings to search for." defaultValue="" /> bool } description="If True, only return nodes whose source exactly matches one of the strings_to_match." defaultValue="False" /><Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description="A list of Editable instances that match the search criteria."/>
Returns a list of string literals within this node's source that match any of the given
list[str] } description="A list of strings to search for in string literals." defaultValue="" /> bool } description="If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False." defaultValue="False" /><Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description="A list of Editable objects representing the matching string literals."/>
Adds a visual flag comment to the end of this Editable's source text.
<Return return_type={ <>CodeFlag[ <a href="/api-reference/core/ExternalModule" style={ {fontWeight: "inherit", fontSize: "inherit"} }>ExternalModule ]</> } description=""/>
Creates an ExternalModule instance from an Import instance.
Import } description="An Import instance containing the module information." defaultValue="" /><Return return_type={ <><a href="/api-reference/core/ExternalModule" style={ {fontWeight: "inherit", fontSize: "inherit"} }>ExternalModule</> } description="A new ExternalModule instance representing the external module."/>
Returns the import string used to import this module.
str | None, optional } description="An alternative name for the imported module." defaultValue="None" /> str | None, optional } description="The module from which to import." defaultValue="None" /> ImportType, optional } description="The type of import to generate. Defaults to ImportType.UNKNOWN." defaultValue="ImportType.UNKNOWN" /> bool, optional } description="Whether this is a type import. Defaults to False." defaultValue="False" /><Return return_type={ str } description="The import string that can be used to import this module."/>
Returns the name node of the object.
<Return return_type={ <><a href="/api-reference/core/Name" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Name | <a href="/api-reference/core/ChainedAttribute" style={ {fontWeight: "inherit", fontSize: "inherit"} }>ChainedAttribute | None</> } description="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."/>
Gets a specific parameter from the callable's parameters list by name.
str } description="The name of the parameter to retrieve." defaultValue="" /><Return return_type={ <><a href="/api-reference/core/Parameter" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Parameter | None</> } description="The parameter with the specified name, or None if no parameter with that name exists or if there are no parameters."/>
Returns the parameter at the given index.
int } description="The index of the parameter to retrieve." defaultValue="" /><Return return_type={ <><a href="/api-reference/core/Parameter" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Parameter | None</> } description="The parameter at the specified index, or None if the parameter list is empty or the index does not exist."/>
Retrieves a parameter from the callable by its type.
Symbol } description="The type to search for." defaultValue="" /><Return return_type={ <><a href="/api-reference/core/Parameter" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Parameter | None</> } description="The parameter with the specified type, or None if no parameter is found or if the callable has no parameters."/>
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
str } description="The variable name to search for." defaultValue="" /> bool } description="If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False." defaultValue="False" /><Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description="List of Editable objects representing variable usage nodes matching the given name."/>
Inserts code after this node.
str } description="The source code to insert after this node." defaultValue="" /> bool, optional } description="Whether to adjust the indentation of new_src to match the current node. Defaults to False." defaultValue="False" /> bool, optional } description="Whether to add a newline before the new_src. Defaults to True." defaultValue="True" /> int, optional } description="Priority of the insertion transaction. Defaults to 0." defaultValue="0" /> bool, optional } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" /><Return return_type={ None } description=""/>
Inserts text before this node's source with optional indentation and newline handling.
str } description="The text to insert before this node." defaultValue="" /> bool } description="Whether to fix the indentation of new_src to match the current node. Defaults to False." defaultValue="False" /> bool } description="Whether to add a newline after new_src. Defaults to True." defaultValue="True" /> int } description="Transaction priority for managing multiple edits. Defaults to 0." defaultValue="0" /> bool } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" /><Return return_type={ None } description=""/>
Check if this node is contained another node of the given class
<Return return_type={ bool } description=""/>
Find the first ancestor of the node of the given type. Does not return itself
<Return return_type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable | None</> } description=""/>
Reduces an editable to the following condition
<Return return_type={ None } description=""/>
Deletes this Node and its related extended nodes (e.g. decorators, comments).
bool } description="Whether to delete surrounding whitespace and formatting. Defaults to True." defaultValue="True" /> int } description="Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0." defaultValue="0" /> bool } description="Whether to deduplicate removal transactions at the same location. Defaults to True." defaultValue="True" /><Return return_type={ None } description=""/>
Renames a symbol and updates all its references in the codebase.
str } description="The new name for the symbol." defaultValue="" /> int } description="Priority of the edit operation. Defaults to 0." defaultValue="0" /><Return return_type={ tuple[NodeId, NodeId] } description="A tuple containing the file node ID and the new node ID of the renamed symbol."/>
Search and replace occurrences of text within this node's source and its extended nodes.
str } description="The text or pattern to search for." defaultValue="" /> str } description="The text to replace matches with." defaultValue="" /> int, optional } description="Maximum number of replacements to make. Defaults to -1 (replace all)." defaultValue="-1" /> bool, optional } description="Whether to treat 'old' as a regex pattern. Defaults to False." defaultValue="False" /> int, optional } description="Priority of the replacement operation. Defaults to 0." defaultValue="0" /><Return return_type={ int } description="The total number of replacements made."/>
Returns a list of all regex match of regex_pattern, similar to python's re.search().
<Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description="A list of Editable objects corresponding to the matches found."/>
Sets the name of a code element.
str } description="The new name to set for the object." defaultValue="" /><Return return_type={ None } description=""/>
Returns a list of symbols that use or import the exportable object.
UsageType | None } description="The types of usages to search for. Defaults to any." defaultValue="None" /><Return return_type={ <>list[ <a href="/api-reference/core/Import" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Import | <a href="/api-reference/core/Symbol" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Symbol | <a href="/api-reference/core/Export" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Export ]</> } description="A list of symbols that use or import the exportable object."/>
Returns a list of usages of the exportable object.
UsageType | None } description="Specifies which types of usages to include in the results. Default is any usages." defaultValue="None" /><Return return_type={ <>list[ <a href="/api-reference/core/Usage" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Usage ]</> } description="A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse."/>