Pants v2: The ergonomic build system

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable, user-friendly build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started

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 lint`.


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.800

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 `mypy.ini` or alternative MyPy config file


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

Updated about a month ago


mypy


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.