Skip to main content
Version: 2.25 (dev)

protobuf_sources

Generate a protobuf_source target for each file in the sources field.

Backend: pants.backend.codegen.protobuf.python

dependencies​

Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use pants dependencies or pants peek on this target to get the final result.

See https://www.pantsbuild.org/2.24/docs/using-pants/key-concepts/targets-and-build-files for more about how addresses are formed, including for generated targets. You can also run pants list :: to find all addresses in your project, or pants list dir to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description​

str | None
default: None

A human-readable description of the target.

Use pants list --documented :: to see all targets with descriptions.

go_mod_address​

str | None
default: None
backend: pants.backend.experimental.codegen.protobuf.go

Address of the go_mod target representing the Go module that this target is part of.

This field is similar to the resolve field used in the Python and JVM backends. If a codegen target such as protobuf_sources will be used in multiple Go modules, then you should use the parametrize built-in to parametrize that protobuf_sources target for each Go module.

If there is a single go_mod target in the repository, then this field defaults to the address for that single go_mod target.

grpc​

bool
default: False

Whether to generate gRPC code or not.

jvm_jdk​

str | None
default: None
backend: pants.backend.experimental.codegen.protobuf.scala

The major version of the JDK that this target should be built with. If not defined, will default to [jvm].default_source_jdk.

jvm_resolve​

str | None
default: None
backend: pants.backend.experimental.codegen.protobuf.scala

The resolve from [jvm].resolves to use when compiling this target.

If not defined, will default to [jvm].default_resolve.

overrides​

Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None
default: None

Override the field values for generated protobuf_source targets.

Expects a dictionary of relative file paths and globs to a dictionary for the overrides. You may either use a string for a single path / glob, or a string tuple for multiple paths / globs. Each override is a dictionary of field names to the overridden value.

For example:

overrides={
    "foo.proto": {"grpc": True},
    "bar.proto": {"description": "our user model"},
    ("foo.proto", "bar.proto"): {"tags": ["overridden"]},
}

File paths and globs are relative to the BUILD file's directory. Every overridden file is validated to belong to this target's sources field.

If you'd like to override a field's value for every protobuf_source target generated by this target, change the field directly on this target rather than using the overrides field.

You can specify the same file name in multiple keys, so long as you don't override the same field more than one time for the file.

python_interpreter_constraints​

Iterable[str] | None
default: None

The Python interpreters this code is compatible with.

Each element should be written in pip-style format, e.g. CPython==2.7.* or CPython>=3.6,<4. You can leave off CPython as a shorthand, e.g. >=2.7 will be expanded to CPython>=2.7.

Specify more than one element to OR the constraints, e.g. ['PyPy==3.7.*', 'CPython==3.7.*'] means either PyPy 3.7 or CPython 3.7.

If the field is not set, it will default to the option [python].interpreter_constraints.

See https://www.pantsbuild.org/2.24/docs/python/overview/interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.

python_resolve​

str | None
default: None

The resolve from [python].resolves to use.

If not defined, will default to [python].default_resolve.

All dependencies must share the same value for their resolve field.

python_source_root​

str | None
default: None

The source root to generate Python sources under.

If unspecified, the source root the protobuf_sources is under will be used.

skip_buf_format​

bool
default: False
backend: pants.backend.codegen.protobuf.lint.buf

If true, don't run buf format on this target's code.

skip_buf_lint​

bool
default: False
backend: pants.backend.codegen.protobuf.lint.buf

If true, don't run buf lint on this target's code.

sources​

Iterable[str] | None
default: ('*.proto',)

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['example.proto', 'new_*.proto', '!old_ignore*.proto']

tags​

Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run pants --tag='integration_test' test :: to only run on targets with that tag.