Skip to main content
Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Change import

Recipe IDorg.openrewrite.python.ChangeImport
Artifactorg.openrewrite:rewrite-python

Change a Python import from one module/name to another, updating all type attributions.

Single recipePythonModerne Proprietary License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

5 parameters
2 required3 optional
ParameterExampleTypeRequired
new_modulecollections.abcStringRequired
The module to change imports to
old_modulecollectionsStringRequired
The module to change imports from
new_aliasStringOptional
Optional alias for the new import
new_nameMappingStringOptional
The new name. If not specified, uses the old name.
old_nameMappingStringOptional
The name to change (for 'from X import name' style). Leave empty for direct imports.

Usage

Run this recipe

In order to run Python recipes, you will need to use the Moderne CLI.

Once the CLI is installed, you can install this Python recipe package by running the following command:

Install the recipe package
mod config recipes pip install openrewrite

Then, you can run the recipe via:

Run the recipe
mod run . --recipe org.openrewrite.python.ChangeImport