Upgrade Python dependency version
Recipe ID
org.openrewrite.python.UpgradeDependencyVersionArtifact
org.openrewrite:rewrite-pythonUpgrade the version constraint for a dependency. Supports pyproject.toml (with scope/group targeting), requirements.txt, and Pipfile. 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.UpgradeDependencyVersion --recipe-option "packageName=requests" --recipe-option "newVersion=>=2.31.0"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 |
|---|---|---|
packageNamerequired | String | The PyPI package name to update. e.g. requests |
newVersionrequired | String | The new PEP 508 version constraint (e.g., >=2.31.0).e.g. >=2.31.0 |
scope | String | The dependency scope to update in. All scopes are searched by default. e.g. project.dependencies |
groupName | String | The group name, required when scope is project.optional-dependencies or dependency-groups.e.g. dev |
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