Configuration of the mypy-protobuf type stub generation plugin.
Backend: <span style="color: purple"><code>pants.backend.codegen.protobuf.python</code></span> Config section: <span style="color: purple"><code>[mypy-protobuf]</code></span>
## Basic options
None
## Advanced options
<div style="color: purple"> <h3><code>version</code></h3> <code>--mypy-protobuf-version=<str></code><br> <code>PANTS_MYPY_PROTOBUF_VERSION</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>mypy-protobuf==2.10</code></span>
<br>
Requirement string for the tool.
</div> <br>
<div style="color: purple"> <h3><code>extra_requirements</code></h3> <code>--mypy-protobuf-extra-requirements="['<str>', '<str>', ...]"</code><br> <code>PANTS_MYPY_PROTOBUF_EXTRA_REQUIREMENTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code>[]</code></span>
<br>
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.
</div> <br>
<div style="color: purple"> <h3><code>interpreter_constraints</code></h3> <code>--mypy-protobuf-interpreter-constraints="['<str>', '<str>', ...]"</code><br> <code>PANTS_MYPY_PROTOBUF_INTERPRETER_CONSTRAINTS</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <pre>[ "CPython>=3.6" ]</pre></span>
<br>
Python interpreter constraints for this tool.
</div> <br>
<div style="color: purple"> <h3><code>lockfile</code></h3> <code>--mypy-protobuf-lockfile=<str></code><br> <code>PANTS_MYPY_PROTOBUF_LOCKFILE</code><br> </div> <div style="padding-left: 2em;"> <span style="color: green">default: <code><default></code></span>
<br>
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.1rc1/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'`.
</div> <br>
## Deprecated options
None