Class

The attribute to add to the class.

Whether to include the attribute's dependencies. If True, adds any necessary imports to the class's file. Defaults to False.

The source code of the attribute to be added.

The comment text to add.

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 source code to be added to the class definition. The code should be properly formatted

The maximum depth of superclass traversal. None means no limit, 0 means only this class.

Whether to include private attributes. Defaults to True.

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.

The name of the attribute to search for.

The name of the method to find.

The name of the nested class to find.

The name of the parameter to retrieve.

The index of the parameter to retrieve.

The type to search for.

The name of the parent class to find.

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 parent class to check for. Can be specified either as a class name string or Class object.

Maximum inheritance depth to search. None means no limit.

Include parent classes up to max_depth. None means no limit, 0 means only current class. Defaults to 0.

Whether to include private methods. Defaults to True.

Whether to include magic methods. Defaults to False.

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'.

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 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 set.

The new docstring content to set.

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

The new name to set for the object.

Maximum inheritance depth to search. If None, searches all depths. Defaults to None.

The maximum depth to traverse up the inheritance tree. If None, traverses the entire tree.

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

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