PyImport

Extends Import for Python codebases.

View Source on Github

Inherits from

Import, Usable, Editable, Importable, Expression, HasName

Attributes

alias

Editable | None

dependencies

list[Union[ Symbol , Import ]]

Returns a list of symbols that this symbol depends on.

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

SourceFile

The file object that this Editable instance belongs to.

file_node_id

NodeId

filepath

str

The file path of the file that this Editable instance belongs to.

from_file

SourceFile | None

Returns the SourceFile that an Import is importing from.

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.

import_specifier

Editable

Retrieves the import specifier node for this import.

import_statement

ImportStatement

the ImportStatement that this import belongs to

import_type

ImportType

imported_exports

list[ Exportable ]

Returns a list of exports from an import statement.

imported_symbol

Symbol | ExternalModule | SourceFile | Import | None

Returns the symbol directly being imported, including an indirect import and an External

module

Editable | None

name

str | None

Returns the name or alias of the symbol being imported.

namespace

str | None

Returns the namespace of the import if it imports a file, or None otherwise.

node_type

Literal[NodeType.IMPORT]

parent

Editable

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_symbol

Symbol | ExternalModule | SourceFile | None

Returns the symbol, source file, or external module that this import ultimately resolves

resolved_value

Expression | list[ Expression ]

Returns the resolved type of an Expression.

source

str

Text representation of the Editable instance.

symbol_name

Editable | None

The name of the symbol being imported. For instance import a as b has a symbol_name of a.

to_file

SourceFile

SourceFile that this import resides in.

to_file_id

NodeId

ts_node

TSNode

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 ]

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 ]

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[ PyImport ]

get_import_string

Generates an import string for a Python import statement.

View Source on Github

Parameters

alias

str | None

default:None

Optional alias name for the imported symbol.

module

str | None

default:None

Optional module name to import from. If not provided, uses the file's import module name.

import_type

ImportType

default:ImportType.UNKNOWN

Type of import to generate. Defaults to UNKNOWN.

is_type_import

bool

default:False

Whether this is a type import. Defaults to False.

Returns

str

A formatted import statement string.

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_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

list[ Editable ]

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_aliased_import

Returns True if this import is aliased.

View Source on Github

Returns

bool

True if the import has an alias different from its original name, False otherwise.

is_module_import

Determines if the import is a module-level or wildcard import.

View Source on Github

Returns

bool

True if the import is a module-level or wildcard import, False otherwise.

is_reexport

Returns true if the Import object is also an Export object.

View Source on Github

Returns

bool

True if the import is re-exported, False otherwise.

is_symbol_import

Returns True if this import is importing a symbol rather than a module.

View Source on Github

Returns

bool

True if this import is a symbol import, False if it is a module import.

is_wildcard_import

Returns True if the import symbol is a wildcard import.

View Source on Github

Returns

bool

True if this is a wildcard import, False otherwise.

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

reduce_condition

Reduces an editable to the following condition

View Source on Github

Returns

None

remove

Remove this import from the import statement.

View Source on Github

Parameters

delete_formatting

bool, optional

default:True

Whether to delete any associated formatting. Defaults to True.

priority

int, optional

default:0

The priority of the operation. Defaults to 0.

dedupe

bool, optional

default:True

Whether to deduplicate imports. Defaults to True.

Returns

None

rename

Renames the import symbol and updates all its usages throughout the codebase.

View Source on Github

Parameters

new_name

str

required

The new name to give the imported symbol.

priority

int, optional

default:0

Priority of the rename operation. Defaults to 0.

Returns

tuple[NodeId, NodeId]

A tuple containing (file_node_id, new_import_node_id).

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_import_module

Sets the module of an import.

View Source on Github

Parameters

new_module

str

required

The new module path to import from.

Returns

None

set_import_symbol_alias

Sets alias or name of an import at the declaration level.

View Source on Github

Parameters

new_alias

str

required

The new name to use for the imported symbol.

Returns

None

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 | Export ]

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.