The MyPy Python type checker (http://mypy-lang.org/).

Config section: [mypy]

Basic options

skip

--[no-]mypy-skip
PANTS_MYPY_SKIP
default: False

Don't use MyPy when running `./pants typecheck`.


args

--mypy-args="[<shell_str>, <shell_str>, ...]"
PANTS_MYPY_ARGS
default: []

Arguments to pass directly to mypy, e.g. `--mypy-args="--python-version 3.7 --disallow-any-expr"`


Advanced options

version

--mypy-version=<str>
PANTS_MYPY_VERSION
default: mypy==0.812

Requirement string for the tool.


extra_requirements

--mypy-extra-requirements="['<str>', '<str>', ...]"
PANTS_MYPY_EXTRA_REQUIREMENTS
default: []

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.


interpreter_constraints

--mypy-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_MYPY_INTERPRETER_CONSTRAINTS
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.


console_script

--mypy-console-script=<str>
PANTS_MYPY_CONSOLE_SCRIPT
default: mypy

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.


entry_point

--mypy-entry-point=<str>
PANTS_MYPY_ENTRY_POINT
default: None

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.


config

--mypy-config=<file_option>
PANTS_MYPY_CONFIG
default: None

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.


config_discovery

--[no-]mypy-config-discovery
PANTS_MYPY_CONFIG_DISCOVERY
default: True

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.


source_plugins

--mypy-source-plugins="[<target_option>, <target_option>, ...]"
PANTS_MYPY_SOURCE_PLUGINS
default: []

An optional list of `python_library` 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.


Deprecated options

None


Did this page help you?