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

extended

extended_source

file

filepath

full_name

function_calls

name

parameters

parent

parent_class

parent_function

parent_statement

resolved_value

return_type

source

variable_usages

Methods

ancestors

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

View 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 Editable 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_string_literals

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

View Source on Github

Parameters

flag

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

View Source on Github

from_import

Creates an ExternalModule instance from an Import instance.

View Source on Github

Parameters

get_import_string

Returns the import string used to import this module.

View Source on Github

Parameters

get_name

Returns the name node of the object.

View Source on Github

get_parameter

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

View Source on Github

Parameters

get_parameter_by_index

Returns the parameter at the given index.

View Source on Github

Parameters

get_parameter_by_type

Retrieves a parameter from the callable by its type.

View Source on Github

Parameters

get_variable_usages

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

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 class

View Source on Github

parent_of_type

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

View Source on Github

parent_of_types

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

View Source on Github

reduce_condition

Reduces an editable to the following condition

View Source on Github

remove

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

View Source on Github

Parameters

rename

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

View Source on Github

Parameters

replace

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

View Source on Github

Parameters

search

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

View Source on Github

Parameters

set_name

Sets the name of a code element.

View Source on Github

Parameters

symbol_usages

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

View Source on Github

Parameters

usages

Returns a list of usages of the exportable object.

View Source on Github

Parameters