Skip to main content

Change package

org.openrewrite.python.ChangePackage

Change package/module references from one name to another.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Usage​

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.ChangePackage

--- | --- | | String | oldPackageName | The package name to replace. | com.yourorg.foo | | String | newPackageName | New package name to replace the old package name with. | com.yourorg.bar | | Boolean | recursive | Optional. Recursively change subpackage names | |

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
oldPackageNameorg.openrewrite
newPackageNameopenrewrite
recursivefalse
Before​
import org.openrewrite.Foo;
class Test {
}
After​
import openrewrite.Foo;
class Test {
}

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangePackageExample
displayName: Rename package name example
recipeList:
  - org.openrewrite.java.ChangePackage:
      oldPackageName: com.yourorg.foo
      newPackageName: com.yourorg.bar

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe ChangePackage --recipe-option "oldPackageName=com.yourorg.foo" --recipe-option "newPackageName=com.yourorg.bar"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-java:8.75.5

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.