Skip to main content
Version: 2.21

thrift_source

A single Thrift file used to generate various languages.

See language-specific docs: Python: https://www.pantsbuild.org/2.21/docs/python/integrations/thrift

Backend: pants.backend.codegen.thrift.apache.python

source​

str
required

A single file that belongs to this target.

Path is relative to the BUILD file's directory, e.g. source='example.ext'.

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.21/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.

finagle​

bool
default: False
backend: pants.backend.experimental.codegen.thrift.scrooge.java

If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.

jvm_jdk​

str | None
default: None
backend: pants.backend.experimental.codegen.thrift.apache.java

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.thrift.apache.java

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

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

python_resolve​

str | None
default: None
backend: pants.backend.codegen.thrift.apache.python

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.

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.