← All recipes
Moderne licensed

Upgrade Python version in project files

Recipe IDorg.openrewrite.python.migrate.UpgradePythonVersionArtifactorg.openrewrite.recipe:rewrite-migrate-python

Update the Python version referenced in project metadata and packaging files to a target version. Updates Pipfile (python_version / python_full_version), pyproject.toml ([project] requires-python and Poetry's [tool.poetry.dependencies] python), setup.cfg (python_requires), and .python-version files. When a lock file (uv.lock or Pipfile.lock) is present, it is regenerated natively to match, without executing the package manager or requiring one on PATH. Only references older than the target are changed; a file already on a newer version is left as-is. Dockerfile base images are handled separately by UpgradePythonDockerImage, CloudFormation/SAM templates by UpgradePythonCloudFormationRuntime, Mend .whitesource files by UpgradePythonWhitesourceConfig, and requirements.txt is not modified because it pins package versions, not the interpreter version.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.python.migrate.UpgradePythonVersion")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-python:0.14.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.python.migrate.UpgradePythonVersion --recipe-option "version=3.12"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-python:RELEASE

Options

NameTypeDescription
versionrequiredStringThe target Python version as MAJOR.MINOR (for example 3.12). Any patch component is dropped; the minor release is the upgrade target.
e.g. 3.12

Data tables

Structured output this recipe can produce.

  • 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