pants_requirements

Generate python_requirement targets for Pants itself to use with Pants plugins.

This is useful when writing plugins so that you can build and test your plugin using Pants. The generated targets will have the correct version based on the version in your pants.toml, and they will work with dependency inference.

Because the Plugin API is not yet stable, the version is set automatically for you to improve stability. If you're currently using a dev release, the version will be set to that exact dev release. If you're using a release candidate (rc) or stable release, the version will allow any non-dev-release release within the release series, e.g. >=2.10.0rc0,<2.11.

(If this versioning scheme does not work for you, you can directly create python_requirement targets for pantsbuild.pants and pantsbuild.pants.testutil. We also invite you to share your ideas at https://github.com/pantsbuild/pants/issues/new/choose)

Backend: pants.backend.plugin_development

description

type: str | None
default: None

A human-readable description of the target.

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

resolve

type: str | None
default: None

The resolve from [python].resolves that this requirement is included in.

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

When generating a lockfile for a particular resolve via the generate-lockfiles goal, it will include all requirements that are declared with that resolve. First-party targets like python_source and pex_binary then declare which resolve they use via their resolve field; so, for your first-party code to use a particular python_requirement target, that requirement must be included in the resolve used by that code.

tags

type: 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.

testutil

type: bool
default: True

If true, include pantsbuild.pants.testutil to write tests for your plugin.


Did this page help you?