Change Python dependency
Recipe ID
org.openrewrite.python.ChangeDependencyArtifact
org.openrewrite:rewrite-pythonChange a dependency to a different package. Supports pyproject.toml, requirements.txt, and Pipfile. Searches all dependency scopes. For pyproject.toml, uv.lock, poetry.lock, and pdm.lock are regenerated natively without executing the package manager. For Pipfile, Pipfile.lock is regenerated natively by consulting the project's package index over the network. Not safe to use as a precondition: invokes the package manager or the network and publishes per-project state shared with other dependency recipes.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.python.ChangeDependency --recipe-option "oldPackageName=requests" --recipe-option "newPackageName=httpx"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-python:8.88.0Options
| Name | Type | Description |
|---|---|---|
oldPackageNamerequired | String | The current PyPI package name to replace. e.g. requests |
newPackageNamerequired | String | The new PyPI package name. e.g. httpx |
newVersion | String | Optional new PEP 508 version constraint. If not specified, the original version constraint is preserved. e.g. >=0.24.0 |
Data tables
Structured output this recipe can produce.
- Python lock regeneration failuresLock files that could not be regenerated after a dependency edit, and why.
org.openrewrite.python.table.PythonLockRegenerationFailures - Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats