Skip to main content
Version: 2.10 (deprecated)

mypy-protobuf

Configuration of the mypy-protobuf type stub generation plugin.

Backend: pants.backend.codegen.protobuf.python

Config section: [mypy-protobuf]

Basic options​

None

Advanced options​

extra_requirements​

--mypy-protobuf-extra-requirements="['<str>', '<str>', ...]"
PANTS_MYPY_PROTOBUF_EXTRA_REQUIREMENTS
pants.toml
[mypy-protobuf]
extra_requirements = [
    '<str>',
    '<str>',
    ...,
]
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-protobuf-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_MYPY_PROTOBUF_INTERPRETER_CONSTRAINTS
pants.toml
[mypy-protobuf]
interpreter_constraints = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "CPython>=3.6"
]

Python interpreter constraints for this tool.

lockfile​

--mypy-protobuf-lockfile=<str>
PANTS_MYPY_PROTOBUF_LOCKFILE
pants.toml
[mypy-protobuf]
lockfile = <str>
default: <default>

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.1/src/python/pants/backend/codegen/protobuf/python/mypy_protobuf_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-protobuf.

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

version​

--mypy-protobuf-version=<str>
PANTS_MYPY_PROTOBUF_VERSION
pants.toml
[mypy-protobuf]
version = <str>
default: mypy-protobuf==2.10

Requirement string for the tool.

Deprecated options​

None

None