Pre-release
This release is a pre-release and may not be stable for production use.
OpenRewrite Python
OpenRewrite automated refactoring for Python source code.
Installation
pip install openrewrite
Quick Start
from rewrite.python import PythonParser
from rewrite import ExecutionContext
# Parse Python source code
parser = PythonParser()
ctx = ExecutionContext()
source_files = parser.parse(ctx, "example.py")
# Apply recipes to transform code
# ...
Writing Recipes
from dataclasses import dataclass, field
from rewrite import Recipe, option
from rewrite.python import PythonVisitor
@dataclass
class ChangeImport(Recipe):
"""Changes an import from one module to another."""
old_module: str = field(metadata=option(
display_name="Old module",
description="The module to change imports from",
example="flask"
))
new_module: str = field(metadata=option(
display_name="New module",
description="The module to change imports to",
example="flask_restful"
))
@property
def name(self) -> str:
return "org.openrewrite.python.ChangeImport"
@property
def display_name(self) -> str:
return "Change import"
@property
def description(self) -> str:
return "Changes an import from one module to another."
def editor(self) -> PythonVisitor:
# Implementation...
pass
Documentation
See docs.openrewrite.org for full documentation.
License
Moderne Source Available License - see LICENSE.md
2 maintainers
Metadata
2 maintainers
Release files for openrewrite 8.83.0.dev20260518112859
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openrewrite-8.83.0.dev20260518112859.tar.gz | 279.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openrewrite-8.83.0.dev20260518112859-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 601.0 kB
Release files / openrewrite-8.83.0.dev20260518112859.tar.gz
| Download URL | openrewrite-8.83.0.dev20260518112859.tar.gz |
|---|---|
| Size | 279.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dbbed40085e0a3a1e285eb0dd1f9e0f440d589dad804483d0930be86863f03f5
|
|
BLAKE2b-256 checksum How to use checksums |
1239b58e082af202d5f99984784048c20dcae82a12eb8ac8eb30f618d0197294
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / openrewrite-8.83.0.dev20260518112859-py3-none-any.whl
| Download URL | openrewrite-8.83.0.dev20260518112859-py3-none-any.whl |
|---|---|
| Size | 321.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f2ea2c147997f695ff0b7fd341ce94d0eb78ce44a086e186c7dd20828c343b8f
|
|
BLAKE2b-256 checksum How to use checksums |
c428aa29f42e7e66e7f7230b15a90695c8fc809c6944020c2f83eef3b89a7503
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
