Skip to main content

Find Python function and method usages

org.openrewrite.python.migrate.FindMethods

Find function and method calls by pattern. Covers standalone functions, class methods, static methods, and constructor calls.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringmethodPatternA method pattern used to find matching function and method calls. The pattern format is <module-or-type> <function-name>(<arg-patterns>). The module or type part is optional; when omitted, any declaring type matches. .. matches any number of arguments. For example, dumps(..) finds all calls to any function named dumps, json dumps(..) finds only calls to json.dumps(), and os.path join(..) finds calls to os.path.join().dumps(..)
BooleanmatchOverridesOptional. When enabled, find methods that are overrides of the method pattern.

Example​

Parameters​
ParameterValue
methodPatternbuiltins len(..)
matchOverridesnull
Before​
x = len("hello")
After​
x = /*~~>*/len("hello")

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.FindMethodsExample
displayName: Find Python function and method usages example
recipeList:
  - org.openrewrite.python.migrate.FindMethods:
      methodPattern: dumps(..)

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

shell
mod run . --recipe FindMethods --recipe-option "methodPattern=dumps(..)"

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

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

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​

Method calls​

org.openrewrite.java.table.MethodCalls

The text of matching method invocations.

Column NameDescription
Source fileThe source file that the method call occurred in.
Method callThe text of the method call.
Class nameThe class name of the method call.
Method nameThe method name of the method call.
Argument typesThe argument types of the method call.