rope_library_rename_refactoring_quickstart_example.py

1from rope.base.project import Project
2from rope.refactor.rename import Rename
3
4# 1. Create a project in the current directory
5project = Project('.')
6
7# 2. Get the resource (file) you want to refactor
8# For this example, assume 'my_module.py' exists
9resource = project.get_resource('my_module.py')
10
11# 3. Create a Rename refactoring object
12# We are renaming the identifier at offset 10 to 'new_name'
13refactoring = Rename(project, resource, 10)
14
15# 4. Calculate the changes (a ChangeSet object)
16changes = refactoring.get_changes('new_name')
17
18# 5. Preview and apply the changes to the project
19print(f"Changes to be applied:\n{changes.get_description()}")
20project.do(changes)
21
22# 6. Close the project to save any metadata
23project.close()