Skip to main content

OpenRewrite automated refactoring for Python.

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openrewrite-8.79.0.dev20260407131854.tar.gz (257.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openrewrite-8.79.0.dev20260407131854-py3-none-any.whl (302.3 kB view details)

Uploaded Python 3

File details

Details for the file openrewrite-8.79.0.dev20260407131854.tar.gz.

File metadata

File hashes

Hashes for openrewrite-8.79.0.dev20260407131854.tar.gz
Algorithm Hash digest
SHA256 b1d11850aabf855d4385681ec76c6e0fba1754f41dab2dab578fb100c1372b26
MD5 c53cb00c9b16d9ee801d34fc725dec49
BLAKE2b-256 6021871ca380d669c923a719ee6e5b58ce6b5606b743896f8b0c6375e027a90a

See more details on using hashes here.

File details

Details for the file openrewrite-8.79.0.dev20260407131854-py3-none-any.whl.

File metadata

File hashes

Hashes for openrewrite-8.79.0.dev20260407131854-py3-none-any.whl
Algorithm Hash digest
SHA256 b04c9467d453db54db5253850c75e659324c15b275a7dcc30f26a4196f2ca6d6
MD5 1fc5abc75dabdc5a57129dcbbef3fbf4
BLAKE2b-256 d0314eeca639cdc8800e9a74b3d375b12bad7a69b7a0b400bef52b2fca2e90e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page