ExternalModule

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.

View Source on Github

Inherits from

Callable, Usable, Importable, Expression, HasName, Editable

Attributes

call_sites

list[ FunctionCall ]

Returns all call sites (invocations) of this callable in the codebase.

extended

SymbolGroup

Returns a SymbolGroup of all extended nodes associated with this element.

extended_source

str

Returns the source text representation of all extended nodes.

file

None

File property for ExternalModule class.

filepath

str

Returns the filepath of the module.

full_name

str | None

Returns the full name of the object, including the namespace path.

function_calls

list[ FunctionCall ]

Returns a list of all function calls contained within this expression.

name

str | None

Retrieves the base name of the object without namespace prefixes.

parameters

list[ Parameter ]

Returns list of named parameters from an external function symbol.

parent

Editable

The parent node of this Editable instance.

parent_class

Class | None

Find the class this node is contained in

parent_function

Function | None

Find the function this node is contained in

parent_statement

Statement | None

Find the statement this node is contained in

resolved_value

Expression | list[ Expression ]

Returns the resolved type of an Expression.

return_type

Type | Placeholder [ ExternalModule ]

The type of value returned by the callable, or a placeholder.

source

str

Text representation of the Editable instance.

variable_usages

list[ Editable ]

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

list[ Editable ]

dependencies

Returns a list of symbols that this symbol depends on.

View Source on Github

Parameters

usage_types

UsageType | None

default:UsageType.DIRECT

The types of dependencies to search for. Defaults to UsageType.DIRECT.

max_depth

int | None

default:None

Maximum depth to traverse in the dependency graph. If provided, will recursively collect

Returns

list[Union[ Symbol , Import ]]

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_src

str

required

The new source text to replace the current text with.

fix_indentation

bool

default:False

If True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.

priority

int

default:0

The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.

dedupe

bool

default:True

If True, deduplicates identical transactions. Defaults to True.

Returns

None

find

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

View Source on Github

Parameters

strings_to_match

Union[list[str], str]

required

One or more strings to search for.

exact

bool

default:False

If True, only return nodes whose source exactly matches one of the strings_to_match.

Returns

list[ Editable ]

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_match

list[str]

required

A list of strings to search for in string literals.

fuzzy_match

bool

default:False

If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.

Returns

list[ Editable [ ExternalModule ]]

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

CodeFlag[ ExternalModule ]

from_import

Creates an ExternalModule instance from an Import instance.

View Source on Github

Parameters

imp

Import

required

An Import instance containing the module information.

Returns

ExternalModule

A new ExternalModule instance representing the external module.

get_import_string

Returns the import string used to import this module.

View Source on Github

Parameters

alias

str | None, optional

default:None

An alternative name for the imported module.

module

str | None, optional

default:None

The module from which to import.

import_type

ImportType , optional

default:ImportType.UNKNOWN

The type of import to generate. Defaults to ImportType.UNKNOWN.

is_type_import

bool, optional

default:False

Whether this is a type import. Defaults to False.

Returns

str

The import string that can be used to import this module.

get_name

Returns the name node of the object.

View Source on Github

Returns

Name | ChainedAttribute | None

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_parameter

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

View Source on Github

Parameters

name

str

required

The name of the parameter to retrieve.

Returns

Parameter | None

The parameter with the specified name, or None if no parameter with that name exists or if there are no parameters.

get_parameter_by_index

Returns the parameter at the given index.

View Source on Github

Parameters

index

int

required

The index of the parameter to retrieve.

Returns

Parameter | None

The parameter at the specified index, or None if the parameter list is empty or the index does not exist.

get_parameter_by_type

Retrieves a parameter from the callable by its type.

View Source on Github

Parameters

type

Symbol

required

The type to search for.

Returns

Parameter | None

The parameter with the specified type, or None if no parameter is found or if the callable has no parameters.

get_variable_usages

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

View Source on Github

Parameters

var_name

str

required

The variable name to search for.

fuzzy_match

bool

default:False

If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.

Returns

Sequence[ Editable [ ExternalModule ]]

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_src

str

required

The source code to insert after this node.

fix_indentation

bool, optional

default:False

Whether to adjust the indentation of new_src to match the current node. Defaults to False.

newline

bool, optional

default:True

Whether to add a newline before the new_src. Defaults to True.

priority

int, optional

default:0

Priority of the insertion transaction. Defaults to 0.

dedupe

bool, optional

default:True

Whether to deduplicate identical transactions. Defaults to True.

Returns

None

insert_before

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

View Source on Github

Parameters

new_src

str

required

The text to insert before this node.

fix_indentation

bool

default:False

Whether to fix the indentation of new_src to match the current node. Defaults to False.

newline

bool

default:True

Whether to add a newline after new_src. Defaults to True.

priority

int

default:0

Transaction priority for managing multiple edits. Defaults to 0.

dedupe

bool

default:True

Whether to deduplicate identical transactions. Defaults to True.

Returns

None

is_child_of

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

View Source on Github

Returns

bool

is_wrapped_in

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

View Source on Github

Returns

bool

parent_of_type

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

View Source on Github

Returns

Editable | None

parent_of_types

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

View Source on Github

Returns

Editable | None

reduce_condition

Reduces an editable to the following condition

View Source on Github

Returns

None

remove

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

View Source on Github

Parameters

delete_formatting

bool

default:True

Whether to delete surrounding whitespace and formatting. Defaults to True.

priority

int

default:0

Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.

dedupe

bool

default:True

Whether to deduplicate removal transactions at the same location. Defaults to True.

Returns

None

rename

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

View Source on Github

Parameters

new_name

str

required

The new name for the symbol.

priority

int

default:0

Priority of the edit operation. Defaults to 0.

Returns

tuple[NodeId, NodeId]

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

old

str

required

The text or pattern to search for.

new

str

required

The text to replace matches with.

count

int, optional

default:-1

Maximum number of replacements to make. Defaults to -1 (replace all).

is_regex

bool, optional

default:False

Whether to treat 'old' as a regex pattern. Defaults to False.

priority

int, optional

default:0

Priority of the replacement operation. Defaults to 0.

Returns

int

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_pattern

str

required

The regular expression pattern to search for.

include_strings

bool

default:True

When False, excludes the contents of string literals from the search. Defaults to True.

include_comments

bool

default:True

When False, excludes the contents of comments from the search. Defaults to True.

Returns

list[ Editable ]

A list of Editable objects corresponding to the matches found.

set_name

Sets the name of a code element.

View Source on Github

Parameters

name

str

required

The new name to set for the object.

Returns

None

symbol_usages

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

View Source on Github

Parameters

usage_types

UsageType | None

default:None

The types of usages to search for. Defaults to any.

Returns

list[ Import | Symbol | TSExport ]

A list of symbols that use or import the exportable object.

usages

Returns a list of usages of the exportable object.

View Source on Github

Parameters

usage_types

UsageType | None

default:None

Specifies which types of usages to include in the results. Default is any usages.

Returns

list[ Usage ]

A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse.