Function

Abstract representation of a Function.

View Source on Github

Inherits from

HasBlock, Callable, Symbol, Editable, Expression, Usable, Importable, HasName

Attributes

call_sites

Returns all call sites (invocations) of this callable in the codebase.

code_block

The block of code associated with the code object.

comment

Returns the comment group associated with the symbol, if any.

decorators

Returns list of all decorators on this Symbol.

docstring

Retrieves the docstring of the expression.

extended

Returns a SymbolGroup of all extended nodes associated with this element.

extended_nodes

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

extended_source

Returns the source text representation of all extended nodes.

file

The file object that this Editable instance belongs to.

filepath

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

full_name

Returns the full name of the object, including the namespace path.

function_calls

Gets all function calls within the function and its parameters.

function_signature

Returns the signature of the function as a string.

inferred_return_type

Gets the inferred type of the function from the language's native language engine / compiler.

inline_comment

Returns the inline comment group associated with the symbol, if any.

is_async

Returns True if the function is asynchronous.

is_constructor

Determines if the current function is a constructor method.

is_decorated

Check if the symbol has decorators.

is_magic

Returns True if function is a magic method.

is_method

Returns whether the function is a method of a class.

is_overload

Indicates whether the function is an overloaded function in a multi-function definition.

is_private

Determines if a function has a private access modifier.

is_property

Returns whether this function is a property.

name

Retrieves the base name of the object without namespace prefixes.

nested_functions

Returns a list of nested functions defined within this function's code block.

parameters

Retrieves all parameters of a callable symbol.

parent

The parent node of this Editable instance.

parent_class

Find the class this node is contained in

parent_function

Find the function this node is contained in

parent_statement

Find the statement this node is contained in

resolved_value

Returns the resolved type of an Expression.

return_statements

Returns a list of all return statements within this function's body.

return_type

The type of value returned by the callable, or a placeholder.

source

Returns the source code of the symbol.

symbol_type

The type of symbol, set to SymbolType.Function.

type_parameters

The type parameters of the symbol, if any.

variable_usages

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

Methods

add_comment

Adds a comment to the symbol.

View Source on Github

Parameters

comment

required

The comment text to add.

Returns

add_decorator

Adds a decorator to a function or method.

View Source on Github

Parameters

new_decorator

required

The decorator to add, including the '@' symbol.

skip_if_exists

default:False

If True, skips adding if the decorator exists.

Returns

True if the decorator was added, False if skipped.

add_keyword

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

View Source on Github

Parameters

keyword

required

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

Returns

add_statements

Adds statements to the end of a function body.

View Source on Github

Parameters

lines

required

The lines of code to be added at the end of the function body.

Returns

ancestors

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

View Source on Github

Returns

asyncify

Modifies the function to be asynchronous.

View Source on Github

Returns

dependencies

Returns a list of symbols that this symbol depends on.

View Source on Github

Parameters

usage_types

default:UsageType.DIRECT

The types of dependencies to search for. Defaults to UsageType.DIRECT.

max_depth

default:None

Maximum depth to traverse in the dependency graph. If provided, will recursively collect

Returns

A list of symbols and imports that this symbol depends on, sorted by file location.

edit

Replace the source of this node with new_src.

View Source on Github

Parameters

new_src

required

The new source code to replace the current source with.

fix_indentation

default:False

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

priority

default:0

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

dedupe

default:True

If True, prevents duplicate edits. Defaults to True.

Returns

find

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

View Source on Github

Parameters

strings_to_match

required

One or more strings to search for.

exact

default:False

If True, only return nodes whose source exactly matches one of the strings_to_match.

Returns

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

required

A list of strings to search for in string literals.

fuzzy_match

default:False

If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.

Returns

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

get_name

Returns the name node of the object.

View Source on Github

Returns

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_parameter

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

View Source on Github

Parameters

name

required

The name of the parameter to retrieve.

Returns

The parameter with the specified name, or None if no parameter with that name exists or if there are no parameters.

get_parameter_by_index

Returns the parameter at the given index.

View Source on Github

Parameters

index

required

The index of the parameter to retrieve.

Returns

The parameter at the specified index, or None if the parameter list is empty or the index does not exist.

get_parameter_by_type

Retrieves a parameter from the callable by its type.

View Source on Github

Parameters

type

required

The type to search for.

Returns

The parameter with the specified type, or None if no parameter is found or if the callable has no parameters.

get_variable_usages

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

View Source on Github

Parameters

var_name

required

The variable name to search for.

fuzzy_match

default:False

If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.

Returns

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

required

The source code to insert after this node.

fix_indentation

default:False

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

newline

default:True

Whether to add a newline before the new_src. Defaults to True.

priority

default:0

Priority of the insertion transaction. Defaults to 0.

dedupe

default:True

Whether to deduplicate identical transactions. Defaults to True.

Returns

insert_before

Inserts text before the current symbol node in the Abstract Syntax Tree.

View Source on Github

Parameters

new_src

required

The source code text to insert.

fix_indentation

default:False

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

newline

default:True

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

priority

default:0

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

dedupe

default:True

Whether to remove duplicate insertions. Defaults to True.

extended

default:True

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

Returns

insert_statements

Inserts lines of code into the function body at the specified index.

View Source on Github

Parameters

lines

required

The code lines to insert into the function body.

index

default:0

The position in the function body where the lines should be inserted. Defaults to 0.

Returns

is_wrapped_in

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

View Source on Github

Returns

move_to_file

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

View Source on Github

Parameters

file

required

The destination file to move the symbol to.

include_dependencies

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

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

parent_of_type

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

View Source on Github

Returns

parent_of_types

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

View Source on Github

Returns

prepend_statements

Prepends the provided code to the beginning of the function body.

View Source on Github

Parameters

lines

required

The code to be prepended to the function body.

Returns

reduce_condition

Reduces an editable to the following condition

View Source on Github

Returns

remove

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

View Source on Github

Parameters

delete_formatting

default:True

Whether to delete surrounding whitespace and formatting. Defaults to True.

priority

default:0

Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.

dedupe

default:True

Whether to deduplicate removal transactions at the same location. Defaults to True.

Returns

rename

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

View Source on Github

Parameters

new_name

required

The new name for the symbol.

priority

default:0

Priority of the edit operation. Defaults to 0.

Returns

A tuple containing the file node ID and the new node ID of the renamed symbol.

rename_local_variable

Renames a local variable and all its usages within a function body.

View Source on Github

Parameters

old_var_name

required

The current name of the local variable to be renamed.

new_var_name

required

The new name to give to the local variable.

fuzzy_match

default:False

If True, matches variable names that contain old_var_name. Defaults to False.

Returns

The method modifies the AST in place.

replace

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

View Source on Github

Parameters

old

required

The text or pattern to search for.

new

required

The text to replace matches with.

count

default:-1

Maximum number of replacements to make. Defaults to -1 (replace all).

is_regex

default:False

Whether to treat 'old' as a regex pattern. Defaults to False.

priority

default:0

Priority of the replacement operation. Defaults to 0.

Returns

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

required

The regular expression pattern to search for.

include_strings

default:True

When False, excludes the contents of string literals from the search. Defaults to True.

include_comments

default:True

When False, excludes the contents of comments from the search. Defaults to True.

Returns

A list of Editable objects corresponding to the matches found.

set_comment

Sets a comment to the symbol.

View Source on Github

Parameters

comment

required

The comment text to set.

Returns

set_docstring

Sets or updates the docstring for the current entity.

View Source on Github

Parameters

docstring

required

The new docstring content to set.

Returns

This method doesn't return anything.

set_inline_comment

Sets an inline comment to the symbol.

View Source on Github

Parameters

comment

required

The text of the inline comment to be added or updated.

Returns

set_name

Sets the name of a code element.

View Source on Github

Parameters

name

required

The new name to set for the object.

Returns

set_return_type

Sets the return type annotation for the function.

View Source on Github

Parameters

new_return_type

required

The new return type annotation to be set. Use an empty string to remove

Returns

symbol_usages

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

View Source on Github

Parameters

usage_types

default:None

The types of usages to search for. Defaults to any.

Returns

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

default:None

Specifies which types of usages to include in the results. Default is any usages.

Returns

A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse.