Find Python files that import a module
Recipe ID
org.openrewrite.python.search.UsesImportArtifact
org.openrewrite:rewrite-pythonMarks Python source files that import the given module, matching the as-written import path rather than type attribution. Robust to type-checker canonicalization and to removed or unresolvable symbols, which makes it usable as a precondition for import-migration recipes where HasType would miss the file.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.python.search.UsesImport --recipe-option "module=datetime"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 |
|---|---|---|
modulerequired | String | The dotted module path to match against import statements, e.g. datetime or os.path. A file matches if it imports that module, a submodule of it, or a parent module of it. Matched against import syntax, not type attribution.e.g. datetime |
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