python_requirement_library

---

Python requirements installable by pip.

This target is useful when you want to declare Python requirements inline in a BUILD file. If you have a requirements.txt file already, you can instead use the macro python_requirements() to convert each requirement into a python_requirement_library() target automatically.

See https://www.pantsbuild.org/v2.6/docs/python-third-party-dependencies.

Backend: ``

---

requirements

Iterable[str]

required

A sequence of pip-style requirement strings, e.g. ['foo==1.8', "bar<=3 ; python_version<'3'"].

dependencies

Iterable[str] | None

default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib'].

Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json'].

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.

module_mapping

Dict[str, Iterable[str]] | None

default: None

A mapping of requirement names to a list of the modules they provide.

For example, {"ansicolors": ["colors"]}.

Any unspecified requirements will use the requirement name as the default module, e.g. "Django" will default to ["django"].

This is used to infer dependencies.

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.

type_stubs_module_mapping

Dict[str, Iterable[str]] | None

default: None

A mapping of type-stub requirement names to a list of the modules they provide.

For example, {"types-requests": ["requests"]}.

If the requirement is not specified and it starts with types- or ends with -types, the requirement will be treated as a type stub for the corresponding module, e.g. "types-request" has the module "requests". Otherwise, the requirement is treated like a normal dependency (see the field module_mapping).

This is used to infer dependencies for type stubs.