Hey! These docs are for version 2.0, which is no longer officially supported. Click here for the latest version, 2.7!

The protocol buffer compiler (https://developers.google.com/protocol-buffers).

Config section: [protoc]

Basic options


Advanced options

default: 3.11.4
Use this version of protoc.

--protoc-known-versions="['<str>', '<str>', ...]"
  "3.11.4|linux |6d0f18cd84b918c7b3edd0203e75569e0c8caecb1367bbbe409b45e28514f5be|1591191"

Known versions to verify downloads against.

Each element is a pipe-separated string of version|platform|sha256|length, where:

  • version is the version string
  • platform is one of [darwin,linux],
  • sha256 is the 64-character hex representation of the expected sha256
    digest of the download file, as emitted by shasum -a 256
  • length is the expected length of the download file in bytes

E.g., 3.1.2|darwin|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813.

Values are space-stripped, so pipes can be indented for readability if necessary.

default: https://github.com/protocolbuffers/protobuf/releases/download/v{version}/protoc-{version}-{platform}-x86_64.zip
URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies. Use `{version}` to have the value from --version substituted, and `{platform}` to have a value from --url-platform-mapping substituted in, depending on the current platform. For example, https://github.com/.../protoc-{version}-{platform}.zip.

--protoc-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
  "darwin": "osx",
  "linux": "linux"

A dictionary mapping platforms to strings to be used when generating the URL to download the tool. In --url-template, anytime the `{platform}` string is used, Pants will determine the current platform, and substitute `{platform}` with the respective value from your dictionary. For example, if you define `{"darwin": "apple-darwin", "linux": "unknown-linux"}, and run Pants on Linux, then `{platform}` will be substituted in the --url-template option with unknown-linux.

Deprecated options

--protoc-runtime-targets="[<target_option>, <target_option>, ...]"
default: []
Deprecated, will be removed in version: 2.1.0.dev0
Use the option `runtime_dependencies` in the new `[python-protobuf]` scope, which behaves identically.
A list of addresses to targets for Protobuf runtime libraries. For example, a `python_requirement_library` for the `protobuf` Python library. These targets will be automatically injected into the `dependencies` field of every `protobuf_library`.

Did this page help you?