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

version

--mypy-protobuf-version=<str>

PANTS_MYPY_PROTOBUF_VERSION

default: mypy-protobuf==2.10

Requirement string for the tool.


extra_requirements

--mypy-protobuf-extra-requirements="['<str>', '<str>', ...]"

PANTS_MYPY_PROTOBUF_EXTRA_REQUIREMENTS

default:
[
  "protobuf<3.21"
]

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

default:
[
  "CPython>=3.7,<4"
]

Python interpreter constraints for this tool.


lockfile

--mypy-protobuf-lockfile=<str>

PANTS_MYPY_PROTOBUF_LOCKFILE

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.13.1rc0/src/python/pants/backend/codegen/protobuf/python/mypy_protobuf.lock 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.

As explained at Third-party dependencies, lockfile generation via generate-lockfiles does not always work and you may want to manually generate the lockfile. You will want to set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.


Deprecated options

None


Did this page help you?