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
install_from_resolve
--mypy-protobuf-install-from-resolve=<str>PANTS_MYPY_PROTOBUF_INSTALL_FROM_RESOLVENoneIf specified, install the tool using the lockfile for this named resolve.
This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/v2.16/docs/python-third-party-dependencies#user-lockfiles.
The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.
If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants.
If unspecified, and the lockfile option is set, the tool will use the custom mypy-protobuf "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.
requirements
--mypy-protobuf-requirements="['<str>', '<str>', ...]"PANTS_MYPY_PROTOBUF_REQUIREMENTS[]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.
Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets).
The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.
If unspecified, install the entire lockfile.
interpreter_constraints
--mypy-protobuf-interpreter-constraints="['<str>', '<str>', ...]"PANTS_MYPY_PROTOBUF_INTERPRETER_CONSTRAINTS["CPython>=3.7,<4"]Python interpreter constraints for this tool.
Deprecated options
version
--mypy-protobuf-version=<str>PANTS_MYPY_PROTOBUF_VERSIONmypy-protobuf==3.4.0Requirement string for the tool.
extra_requirements
--mypy-protobuf-extra-requirements="['<str>', '<str>', ...]"PANTS_MYPY_PROTOBUF_EXTRA_REQUIREMENTS[]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.
lockfile
--mypy-protobuf-lockfile=<str>PANTS_MYPY_PROTOBUF_LOCKFILE<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.16.1rc4/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 and supply-chain security.
To use a custom lockfile, set this option to a file path relative to the build root, then run scie-pants-linux-x86_64 generate-lockfiles --resolve=mypy-protobuf.
Alternatively, you can set this option to the path to a custom lockfile using pip's requirements.txt-style, ideally with --hash. Set [python].invalid_lockfile_behavior = 'ignore' so that Pants does not complain about missing lockfile headers.