PyImport

​

Inherits from

Import, Usable, Editable, Importable, Expression, HasName

​

Attributes

​

alias

​

dependencies

​

extended

​

extended_source

​

file

​

file_node_id

​

filepath

​

from_file

​

full_name

​

function_calls

​

import_specifier

​

import_statement

​

import_type

​

imported_exports

​

imported_symbol

​

module

​

name

​

namespace

​

node_type

​

parent

​

parent_class

​

parent_function

​

parent_statement

​

resolved_symbol

​

resolved_value

​

source

​

symbol_name

​

to_file

​

to_file_id

​

ts_node

​

variable_usages

​

Methods

​

ancestors

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

​

edit

Replace the source of this Editable with new_src.

​

find

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

​

find_string_literals

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

​

flag

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

​

get_import_string

Generates an import string for a Python import statement.

​

get_name

Returns the name node of the object.

​

get_variable_usages

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

​

insert_after

Inserts code after this node.

​

insert_before

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

​

is_aliased_import

Returns True if this import is aliased.

​

is_module_import

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

​

is_reexport

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

​

is_symbol_import

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

​

is_wildcard_import

Returns True if the import symbol is a wildcard import.

​

is_wrapped_in

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

​

parent_of_type

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

​

reduce_condition

Reduces an editable to the following condition

​

remove

Remove this import from the import statement.

​

rename

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

​

replace

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

​

search

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

​

set_import_module

Sets the module of an import.

​

set_import_symbol_alias

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

​

set_name

Sets the name of a code element.

​

symbol_usages

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

​

usages

Returns a list of usages of the exportable object.