The MyPy Python type checker (http://mypy-lang.org/).
Backend: <span style="color: purple"><code>pants.backend.python</code></span> Config section: <span style="color: purple"><code>[mypy]</code></span>
## Basic options
<div style="color: purple"> <h3><code>skip</code></h3> <code>--[no-]mypy-skip</code><br> <code>PANTS_MYPY_SKIP</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>False</code></span>
<br>
Don't use MyPy when running `./pants typecheck`.
</div> <br>
<div style="color: purple"> <h3><code>args</code></h3> <code>--mypy-args="[<shell_str>, <shell_str>, ...]"</code><br> <code>PANTS_MYPY_ARGS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Arguments to pass directly to mypy, e.g. `--mypy-args="--python-version 3.7 --disallow-any-expr"`
</div> <br>
## Advanced options
<div style="color: purple"> <h3><code>version</code></h3> <code>--mypy-version=<str></code><br> <code>PANTS_MYPY_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>mypy==0.910</code></span>
<br>
Requirement string for the tool.
</div> <br>
<div style="color: purple"> <h3><code>extra_requirements</code></h3> <code>--mypy-extra-requirements="['<str>', '<str>', ...]"</code><br> <code>PANTS_MYPY_EXTRA_REQUIREMENTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.
</div> <br>
<div style="color: purple"> <h3><code>interpreter_constraints</code></h3> <code>--mypy-interpreter-constraints="['<str>', '<str>', ...]"</code><br> <code>PANTS_MYPY_INTERPRETER_CONSTRAINTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "CPython>=3.6" ]</pre></span>
<br>
Python interpreter constraints for this tool.
</div> <br>
<div style="color: purple"> <h3><code>lockfile</code></h3> <code>--mypy-lockfile=<str></code><br> <code>PANTS_MYPY_LOCKFILE</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code><default></code></span>
<br>
Path to a lockfile used for installing the tool.
Set to the string `<default>` to use a lockfile provided by Pants, so long as you have not changed the `--version` and `--extra-requirements` options, and the tool's interpreter constraints are compatible with the default. Pants will error or warn if the lockfile is not compatible (controlled by `[python].invalid_lockfile_behavior`). See https://github.com/pantsbuild/pants/blob/release_2.10.1rc1/src/python/pants/backend/python/typecheck/mypy/lockfile.txt for the default lockfile contents.
Set to the string `<none>` to opt out of using a lockfile. We do not recommend this, though, as lockfiles are essential for reproducible builds.
To use a custom lockfile, set this option to a file path relative to the build root, then run `./pants generate-lockfiles --resolve=mypy`.
Lockfile generation currently does not wire up the `[python-repos]` options. If lockfile generation fails, you can manually generate a lockfile, such as by using pip-compile or `pip freeze`. Set this option to the path to your manually generated lockfile. When manually maintaining lockfiles, set `[python].invalid_lockfile_behavior = 'ignore'`.
</div> <br>
<div style="color: purple"> <h3><code>console_script</code></h3> <code>--mypy-console-script=<str></code><br> <code>PANTS_MYPY_CONSOLE_SCRIPT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>mypy</code></span>
<br>
The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.
</div> <br>
<div style="color: purple"> <h3><code>entry_point</code></h3> <code>--mypy-entry-point=<str></code><br> <code>PANTS_MYPY_ENTRY_POINT</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>
<br>
The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.
</div> <br>
<div style="color: purple"> <h3><code>config</code></h3> <code>--mypy-config=<file_option></code><br> <code>PANTS_MYPY_CONFIG</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>None</code></span>
<br>
Path to a config file understood by MyPy (https://mypy.readthedocs.io/en/stable/config_file.html).
Setting this option will disable `[mypy].config_discovery`. Use this option if the config is located in a non-standard location.
</div> <br>
<div style="color: purple"> <h3><code>config_discovery</code></h3> <code>--[no-]mypy-config-discovery</code><br> <code>PANTS_MYPY_CONFIG_DISCOVERY</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>True</code></span>
<br>
If true, Pants will include any relevant config files during runs (`mypy.ini`, `.mypy.ini`, and `setup.cfg`).
Use `[mypy].config` instead if your config is in a non-standard location.
</div> <br>
<div style="color: purple"> <h3><code>source_plugins</code></h3> <code>--mypy-source-plugins="[<target_option>, <target_option>, ...]"</code><br> <code>PANTS_MYPY_SOURCE_PLUGINS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
An optional list of `python_sources` target addresses to load first-party plugins.
You must also set `plugins = path.to.module` in your `mypy.ini`, and set the `[mypy].config` option in your `pants.toml`.
To instead load third-party plugins, set the option `[mypy].extra_requirements` and set the `plugins` option in `mypy.ini`.Tip: it's often helpful to define a dedicated 'resolve' via `[python].resolves` for your MyPy plugins such as 'mypy-plugins' so that the third-party requirements used by your plugin, like `mypy`, do not mix with the rest of your project. Read that option's help message for more info on resolves.
</div> <br>
<div style="color: purple"> <h3><code>extra_type_stubs</code></h3> <code>--mypy-extra-type-stubs="['<str>', '<str>', ...]"</code><br> <code>PANTS_MYPY_EXTRA_TYPE_STUBS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
Extra type stub requirements to install when running MyPy.
Normally, type stubs can be installed as typical requirements, such as putting them in `requirements.txt` or using a `python_requirement` target.Alternatively, you can use this option so that the dependencies are solely used when running MyPy and are not runtime dependencies.
Expects a list of pip-style requirement strings, like `['types-requests==2.25.9']`.
</div> <br>
## Deprecated options
None