Skip to main content
Version: 2.23 (prerelease)

protoc

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

Backend: pants.backend.codegen.protobuf.python

Config section: [protoc]

Basic options​

dependency_inference​

--[no-]protoc-dependency-inference
PANTS_PROTOC_DEPENDENCY_INFERENCE
pants.toml
[protoc]
dependency_inference = <bool>
default: True

Infer Protobuf dependencies on other Protobuf files by analyzing import statements.

Advanced options​

known_versions​

--protoc-known-versions="['<str>', '<str>', ...]"
PANTS_PROTOC_KNOWN_VERSIONS
pants.toml
[protoc]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "25.2|linux_arm64 |07683afc764e4efa3fa969d5f049fbc2bdfc6b4e7786a0b233413ac0d8753f6b|3071655",
  "25.2|linux_x86_64|78ab9c3288919bdaa6cfcec6127a04813cf8a0ce406afa625e48e816abee2878|3105555",
  "25.2|macos_arm64 |8822b090c396800c96ac652040917eb3fbc5e542538861aad7c63b8457934b20|2209071",
  "25.2|macos_x86_64|5fe89993769616beff1ed77408d1335216379ce7010eee80284a01f9c87c8888|2235343",
  "24.4|linux_arm64 |83ac000ff540e242b6a2ff221a3ac88d2d8e55443801b7a28e9697e5f40e8937|2971447",
  "24.4|linux_x86_64|5871398dfd6ac954a6adebf41f1ae3a4de915a36a6ab2fd3e8f2c00d45b50dec|3005774",
  "24.4|macos_arm64 |d80544480397fe8a05d966fba291cf1233ad0db0ebc24ec72d7bd077d6e7ac59|2088802",
  "24.4|macos_x86_64|6c3b6bf4038d733b6d31f1cc4516a656570b5b5aafb966b650f8182afd0b98cf|2121366",
  "3.20.1|linux_arm64 |8a5a51876259f934cd2acc2bc59dba0e9a51bd631a5c37a4b9081d6e4dbc7591|1804837",
  "3.20.1|linux_x86_64|3a0e900f9556fbcac4c3a913a00d07680f0fdf6b990a341462d822247b265562|1714731",
  "3.20.1|macos_arm64 |b362acae78542872bb6aac8dba73aaf0dc6e94991b8b0a065d6c3e703fec2a8b|2708249",
  "3.20.1|macos_x86_64|b4f36b18202d54d343a66eebc9f8ae60809a2a96cc2d1b378137550bbe4cf33c|2708249"
]

Known versions to verify downloads against.

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

  • version is the version string
  • platform is one of [linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]
  • 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, as emitted by wc -c
  • (Optional) url_override is a specific url to use instead of the normally generated url for this version

E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813. and 3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz.

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

tailor​

--[no-]protoc-tailor
PANTS_PROTOC_TAILOR
pants.toml
[protoc]
tailor = <bool>
default: True

If true, add protobuf_sources targets with the tailor goal.

url_platform_mapping​

--protoc-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_PROTOC_URL_PLATFORM_MAPPING
pants.toml
[protoc.url_platform_mapping]
key1 = val1
key2 = val2
...
default: 
{
  "linux_arm64": "linux-aarch_64",
  "linux_x86_64": "linux-x86_64",
  "macos_arm64": "osx-aarch_64",
  "macos_x86_64": "osx-x86_64"
}

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 {"macos_x86_64": "apple-darwin", "linux_x86_64": "unknown-linux"}, and run Pants on Linux with an intel architecture, then {platform} will be substituted in the --url-template option with unknown-linux.

url_template​

--protoc-url-template=<str>
PANTS_PROTOC_URL_TEMPLATE
pants.toml
[protoc]
url_template = <str>
default: https://github.com/protocolbuffers/protobuf/releases/download/v{version}/protoc-{version}-{platform}.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 or for access via the filesystem through a file:$abspath URL (e.g. file:/this/is/absolute, possibly by templating the buildroot in a config file).

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-&#123;version&#125;-&#123;platform&#125;.zip.

use_unsupported_version​

--protoc-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_PROTOC_USE_UNSUPPORTED_VERSION
pants.toml
[protoc]
use_unsupported_version = <UnsupportedVersionUsage>
one of: error, warning
default: error

What action to take in case the requested version of protoc is not supported.

Supported protoc versions: unspecified

version​

--protoc-version=<str>
PANTS_PROTOC_VERSION
pants.toml
[protoc]
version = <str>
default: 3.20.1

Use this version of protoc.

Deprecated options​

None

None