The Target API defines how you interact with targets in your plugin. For example, you would use the Target API to read the
sources field of a target to know which files to run on.
The Target API can also be used to add new target types—such as adding support for a new language. Additionally, the Target API can be used to extend existing target types.
As described in Targets and BUILD files, a target is an addressable set of metadata describing some of your code.
For example, this BUILD file defines a
PythonTestTarget target with
python_test( name="app_test", source="app_test.py", timeout=120, )
A field is a single value of metadata belonging to a target, such as
timeout above. (
name is a special thing used to create the
Each field has a Python class that defines its BUILD file alias, data type, and optional settings like default values. For example:
from pants.engine.target import IntField class PythonTestTimeoutField(IntField): alias = "timeout" default = 60
Alternatively, you can think of a target as simply an alias and a combination of fields:
from pants.engine.target import Dependencies, SingleSourceField, Target, Tags class CustomTarget(Target): alias = "custom_target" core_fields = (SingleSourceField, Dependencies, Tags)
A target's fields should make sense together. For example, it does not make sense for a
python_source target to have a
Any unrecognized fields will cause an exception when used in a BUILD file.
Because fields are stand-alone Python classes, the same field definition may be reused across multiple different target types.
For example, many target types have the
resource( name="logo", source="logo.png", ) dockerfile( name="docker", source="Dockerfile", )
This gives you reuse of code (DRY) and is important for your plugin to work with multiple different target types, as explained below.
Idiomatic Pants plugins do not care about specific target types; they only care that the target type has the right combination of field types that the plugin needs to operate.
For example, the Python formatter Black does not actually care whether you have a
custom_target target; all that it cares about is that your target type has the field
Targets are only used by the Rules API to get access to the underlying fields through the methods
if target.has_field(PythonSourceField): print("My plugin can work on this target.") timeout_field = target.get(PythonTestTimeoutField) print(timeout_field.value)
This means that when creating new target types, the fields you choose for your target will determine the functionality it has.
Often, you may like how a field behaves, but want to make some tweaks. For example, you may want to give a default value to the
To modify an existing field, simply subclass it.
from pants.engine.target import SingleSourceField class DockerSourceField(SingleSourceField): default = "Dockerfile"
.get() understand this subclass relationship, as follows:
>>> docker_tgt.has_field(DockerSourceField) True >>> docker_tgt.has_field(SingleSourceField) True >>> python_test_tgt.has_field(DockerSourceField) False >>> python_test_tgt.has_field(SingleSourceField) True
This subclass mechanism is key to how the Target API behaves:
- You can use subclasses of fields—along with
Target.has_field()— to filter out irrelevant targets. For example, the Black formatter doesn't work with any plain
SourcesFieldfield; it needs
PythonSourceField. The Python test runner is even more specific: it needs
- You can create custom fields and custom target types that still work with pre-existing functionality. For example, you can subclass
DjangoSourceField, and the Black formatter will still be able to operate on your target.
Updated over 1 year ago