refactor

Refactoring Transformers Module.

This module provides transformers for refactoring Python code using LibCST. It includes functionality to rename functions, classes, and variables while preserving the code structure.

Example

>>> import libcst as cst
>>> from haive.tools.toolkits.dev.python.cst_toolkit.transformers.refactor import RenameTransformer
>>>
>>> # Read and parse source code
>>> with open("script.py", "f") as f:
>>>     tree = cst.parse_module(f.read())
>>>
>>> # Create a rename mapping
>>> rename_map = {"old_function": "new_function", "OldClass": "NewClass"}
>>>
>>> # Apply transformations
>>> modified_tree = tree.visit(RenameTransformer(rename_map))
>>>
>>> # Write updated code back to file
>>> with open("script.py", "w") as f:
>>>     f.write(modified_tree.code)

Classes

RenameTransformer

Renames functions, classes, and variables in Python code.

Module Contents

class refactor.RenameTransformer(rename_map)

Bases: libcst.CSTTransformer

Renames functions, classes, and variables in Python code.

This transformer finds and renames identifiers throughout the code based on a provided mapping, maintaining the structure and semantics of the original code.

rename_map

A dictionary mapping old names to new names

Type:

dict

leave_ClassDef(original_node, updated_node)

Rename class definitions during the AST traversal.

Parameters:

• original_node (cst.ClassDef) – The original class definition node

• updated_node (cst.ClassDef) – The updated class definition node

Returns:

The class definition with the updated name if it’s in

the rename map, otherwise the original node

Return type:

cst.ClassDef

leave_FunctionDef(original_node, updated_node)

Rename function definitions during the AST traversal.

Parameters:

• original_node (cst.FunctionDef) – The original function definition node

• updated_node (cst.FunctionDef) – The updated function definition node

Returns:

The function definition with the updated name if it’s in

the rename map, otherwise the original node

Return type:

cst.FunctionDef

leave_Name(original_node, updated_node)

Rename variable and reference names during the AST traversal.

Parameters:

• original_node (cst.Name) – The original name node

• updated_node (cst.Name) – The updated name node

Returns:

The name node with the updated value if it’s in

the rename map, otherwise the original node

Return type:

cst.Name

rename_map