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

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


Did this page help you?