PyParameter

Extends Parameter for Python codebases.

Inherits from

Parameter, HasValue, Expression, Typeable, Usable, Editable, Importable, HasName

Attributes

default

extended

extended_source

file

filepath

full_name

function_calls

index

is_optional

is_typed

is_variadic

name

parent

parent_class

parent_function

parent_statement

resolved_value

source

type

value

variable_usages

Methods

add_trailing_comment

Add a trailing comment to a parameter in a function signature.

ancestors

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

dependencies

Returns a list of symbols that this symbol depends on.

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

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

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

parent_of_types

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

Removes the parameter from the function definition and all its call sites.

rename

Renames a parameter in a function definition and updates all related references.

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_name

Sets the name of a code element.

set_type_annotation

Sets the type annotation of a parameter.

set_value

Sets the value of the node’s value Expression.

symbol_usages

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

usages

Returns a list of usages of the exportable object.