PyFunction

The comment text to be added.

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

Whether to clean and normalize the comment text before adding.

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

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

If True, skips adding if the decorator exists.

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

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

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

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

The new source code to replace the current source with.

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

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

If True, prevents duplicate edits. Defaults to True.

One or more strings to search for.

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

A list of strings to search for in string literals.

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

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

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

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

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

The name of the parameter to retrieve.

The index of the parameter to retrieve.

The type to search for.

The variable name to search for.

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

The source code to insert after this node.

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

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

Priority of the insertion transaction. Defaults to 0.

Whether to deduplicate identical transactions. Defaults to True.

The source code text to insert.

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

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

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

Whether to remove duplicate insertions. Defaults to True.

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

The code lines to insert into the function body.

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

The destination file to move the symbol to.

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

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

The code statements to prepend to the function body.

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

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

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

The new name for the symbol.

Priority of the edit operation. Defaults to 0.

The current name of the local variable to be renamed.

The new name to give to the local variable.

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

The text or pattern to search for.

The text to replace matches with.

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

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

Priority of the replacement operation. Defaults to 0.

The regular expression pattern to search for.

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

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

The comment text to be added or set.

If True, automatically formats the text as a comment.

If True, cleans the format of the comment before

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

The docstring content to set.

Whether to format the text into a proper docstring format. Defaults to True.

Whether to clean and normalize the docstring format before insertion. Defaults to True.

Whether to force single-line comments to be converted to multi-line format. Defaults to False.

The inline comment text to add.

If True, formats the text into a proper inline

If True, cleans the comment text before insertion

The new name to set for the object.

The new return type annotation to set. Provide an empty string to remove the return type annotation.

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

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