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

python-protobuf.mypy-plugin

Configuration of the mypy-protobuf type stub generation plugin for the Protobuf Python backend.

Config section: [python-protobuf.mypy-plugin]

Basic options

runtime_dependencies

--python-protobuf-mypy-plugin-runtime-dependencies="[<target_option>, <target_option>, ...]"
PANTS_PYTHON_PROTOBUF_MYPY_PLUGIN_RUNTIME_DEPENDENCIES
default: []

A list of addresses to `python_requirement_library` targets for the runtime dependencies needed for generated Python code to work. For example, `['3rdparty/python:protobuf', '3rdparty/python:grpcio']`. These dependencies will be automatically added to every `protobuf_library` target


mypy_plugin

--[no-]python-protobuf-mypy-plugin-mypy-plugin
PANTS_PYTHON_PROTOBUF_MYPY_PLUGIN_MYPY_PLUGIN
default: False

Use the `mypy-protobuf` plugin (https://github.com/dropbox/mypy-protobuf) to also generate .pyi type stubs.


Advanced options

mypy_plugin_version

--python-protobuf-mypy-plugin-mypy-plugin-version=<str>
PANTS_PYTHON_PROTOBUF_MYPY_PLUGIN_MYPY_PLUGIN_VERSION
default: None

The pip-style requirement string for `mypy-protobuf`. You must still set `--mypy-plugin` for this option to be used.


version

--python-protobuf-mypy-plugin-version=<str>
PANTS_PYTHON_PROTOBUF_MYPY_PLUGIN_VERSION
default: mypy-protobuf==2.4

Requirement string for the tool.


extra_requirements

--python-protobuf-mypy-plugin-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYTHON_PROTOBUF_MYPY_PLUGIN_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

--python-protobuf-mypy-plugin-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_PYTHON_PROTOBUF_MYPY_PLUGIN_INTERPRETER_CONSTRAINTS
default:
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.


Deprecated options

None

Updated about a month ago


python-protobuf.mypy-plugin


Suggested Edits are limited on API Reference Pages

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