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

Find Python types

Recipe IDorg.openrewrite.python.migrate.FindTypes

Artifactorg.openrewrite.recipe:rewrite-migrate-python

Find type references by name. Identifies classes matching a type pattern. In Python, all type definitions use the class keyword, covering regular classes, abstract base classes, protocols, enums, dataclasses, named tuples, typed dicts, and more.

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

2 parameters

1 required1 optional

Parameter	Example	Type	Required
typeName	OrderedDict	String	Required
A type name used to find matching type references. Can be a simple class name (e.g., OrderedDict) or a module-qualified name (e.g., collections.OrderedDict). Simple names match against the class name only, while qualified names match against the full module path. Supports glob expressions. collections..* finds every type from every submodule of the collections module.
checkAssignability	—	Boolean	Optional
When enabled, find type references that are assignable to (i.e., subclasses of) the provided type.

Examples

python

Parameter	Value
typeName	OrderedDict
checkAssignability	null

python

Before

from collections import OrderedDict
x = OrderedDict()

After

from collections import OrderedDict
x = /*~~>*/OrderedDict()

Diff

@@ -2,1 +2,1 @@
from collections import OrderedDict
-x = OrderedDict()
+x = /*~~>*/OrderedDict()

Usage

Run this recipe

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

This recipe calls into other OpenRewrite packages as it runs, and the CLI needs every one of them in its marketplace. Once the CLI is installed, install all of the following:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

Install the recipe packages

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

LATEST

Install the recipe packages

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

Pinned version

Install the recipe packages

mod config recipes pip install openrewrite-migrate-python==0.12.0
mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-python:0.12.0
mod config recipes jar install org.openrewrite:rewrite-python:8.89.0

Then, you can run the recipe via:

Run the recipe

mod run . --recipe org.openrewrite.python.migrate.FindTypes --recipe-option "typeName=OrderedDict"

Data tables

Type uses

org.openrewrite.java.table.TypeUses

The source code of matching type uses.

Column	Description
Source file	The source file that the method call occurred in.
Source	The source code of the type use.
Concrete type	The concrete type in use, which may be a subtype of a searched type.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.