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.75.0.dev20260228071413.tar.gz (246.7 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.75.0.dev20260228071413-py3-none-any.whl (289.5 kB view details)

Uploaded Python 3

File details

Details for the file openrewrite-8.75.0.dev20260228071413.tar.gz.

File metadata

File hashes

Hashes for openrewrite-8.75.0.dev20260228071413.tar.gz
Algorithm Hash digest
SHA256 01af38aadbfd984a51f9c176cf066f2b036bbebfb4f27010d34287b0b98033b2
MD5 6523f9faedce60cdd7532a4e9615cad5
BLAKE2b-256 e0ed8bbd45a17655278394b89a73509a53de11469d30b5125094016366fffaa8

See more details on using hashes here.

File details

Details for the file openrewrite-8.75.0.dev20260228071413-py3-none-any.whl.

File metadata

File hashes

Hashes for openrewrite-8.75.0.dev20260228071413-py3-none-any.whl
Algorithm Hash digest
SHA256 bb221d7780b87fa24110b5f88c48b05217966da05f429b8604882041b4a6e19f
MD5 1fc140194edd1863b5acaf4ef0257dd4
BLAKE2b-256 e1380624213b81e9f75489f574e0944802cc66bb71528329d08c23e46c4633dc

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