PySymbol

Extends Symbol for Python codebases.

View Source on Github

Inherits from

Symbol, Usable, Importable, Expression, HasName, Editable

Attributes

comment

PyCommentGroup | None

Retrieves the comment group associated with a Python symbol.

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_nodes

list[ Editable ]

Returns a list of Editable nodes associated with this symbol, including extended symbols.

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.

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.

inline_comment

PyCommentGroup | None

Returns the inline comment group associated with this symbol.

is_exported

bool

Indicates whether a Python symbol is exported.

name

str | None

Retrieves the base name of the object without namespace prefixes.

node_type

Literal[NodeType.SYMBOL]

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_value

Expression | list[ Expression ]

Returns the resolved type of an Expression.

source

str

Returns the source code of the symbol.

symbol_type

SymbolType

ts_node

TSNode

variable_usages

list[ Editable ]

Returns Editables for all TreeSitter node instances of variable usages within this node's

Methods

add_comment

Adds a new comment to the symbol.

View Source on Github

Parameters

comment

str

required

The comment text to be added.

auto_format

bool

default:True

Whether to automatically format the text into a proper comment format.

clean_format

bool

default:True

Whether to clean and normalize the comment text before adding.

comment_type

PyCommentType

default:PyCommentType.SINGLE_LINE

The style of comment to add (e.g., single-line, multi-line).

Returns

None

add_keyword

Insert a keyword in the appropriate place before this symbol if it doesn’t already exist.

View Source on Github

Parameters

keyword

str

required

The keyword to be inserted. Must be a valid keyword in the language context.

Returns

None

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 node with new_src.

View Source on Github

Parameters

new_src

str

required

The new source code to replace the current source with.

fix_indentation

bool

default:False

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

priority

int

default:0

The priority of this edit. Higher priority edits take precedence. Defaults to 0.

dedupe

bool

default:True

If True, prevents duplicate edits. 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[ PySymbol ]

get_import_string

Generates an import string for a Python symbol.

View Source on Github

Parameters

alias

str | None

default:None

Optional alias name for the import. If provided and different from symbol name, creates aliased import.

module

str | None

default:None

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

import_type

ImportType

default:ImportType.UNKNOWN

Type of import to generate. If WILDCARD, generates star import. Defaults to UNKNOWN.

is_type_import

bool

default:False

Whether this is a type import. Currently unused. Defaults to False.

Returns

str

The formatted import string. Will be one of: - "from {module} import * as {file_name}" (for WILDCARD imports) - "from {module} import {name} as {alias}" (for aliased imports) - "from {module} import {name}" (for standard imports)

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 the current symbol node in the Abstract Syntax Tree.

View Source on Github

Parameters

new_src

str

required

The source code text to insert.

fix_indentation

bool

default:False

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

newline

bool

default:True

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

priority

int

default:0

Priority of this edit operation. Higher priority edits are applied first. Defaults to 0.

dedupe

bool

default:True

Whether to remove duplicate insertions. Defaults to True.

extended

bool

default:True

Whether to insert before extended nodes like comments and decorators. Defaults to True.

Returns

None

is_wrapped_in

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

View Source on Github

Returns

bool

move_to_file

Moves the given symbol to a new file and updates its imports and references.

View Source on Github

Parameters

file

SourceFile

required

The destination file to move the symbol to.

include_dependencies

bool

default:True

If True, moves all dependencies of the symbol to the new file. If False, adds imports for the dependencies. Defaults to True.

strategy

str

default:"update_all_imports"

The strategy to use for updating imports. Can be either 'add_back_edge' or 'update_all_imports'. Defaults to 'update_all_imports'.

Returns

None

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

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_comment

Sets a comment for the Python symbol.

View Source on Github

Parameters

comment

str

required

The comment text to be added or set.

auto_format

bool, optional

default:True

If True, automatically formats the text as a comment.

clean_format

bool, optional

default:True

If True, cleans the format of the comment before

comment_type

PyCommentType , optional

default:PyCommentType.SINGLE_LINE

Type of comment to add (e.g., single line,

Returns

None

This method modifies the symbol's comment in place.

set_inline_comment

Sets an inline comment to the symbol.

View Source on Github

Parameters

comment

str

required

The inline comment text to add.

auto_format

bool, optional

default:True

If True, formats the text into a proper inline

clean_format

bool, optional

default:True

If True, cleans the comment text before insertion

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.