Skip to main content
Version: 2.23

setuptools

Python setuptools, used to package python_distribution targets.

This version of Pants uses setuptools version 63.4.3 by default. Use a dedicated lockfile and the install_from_resolve option to control this.

Backend: pants.backend.python

Config section: [setuptools]

Basic options​

None

Advanced options​

install_from_resolve​

--setuptools-install-from-resolve=<str>
PANTS_SETUPTOOLS_INSTALL_FROM_RESOLVE
pants.toml
[setuptools]
install_from_resolve = <str>
default: None

If specified, install the tool using the lockfile for this named resolve.

This resolve must be defined in [python].resolves, as described in https://www.pantsbuild.org/2.23/docs/python/overview/lockfiles#lockfiles-for-tools.

The resolve's entire lockfile will be installed, unless specific requirements are listed via the requirements option, in which case only those requirements will be installed. This is useful if you don't want to invalidate the tool's outputs when the resolve incurs changes to unrelated requirements.

If unspecified, and the lockfile option is unset, the tool will be installed using the default lockfile shipped with Pants, which uses setuptools version 63.4.3.

If unspecified, and the lockfile option is set, the tool will use the custom setuptools "tool lockfile" generated from the version and extra_requirements options. But note that this mechanism is deprecated.

requirements​

--setuptools-requirements="['<str>', '<str>', ...]"
PANTS_SETUPTOOLS_REQUIREMENTS
pants.toml
[setuptools]
requirements = [
    '<str>',
    '<str>',
    ...,
]
default: []

If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile.

Values can be pip-style requirements (e.g., tool or tool==1.2.3 or tool>=1.2.3), or addresses of python_requirement targets (or targets that generate or depend on python_requirement targets). Make sure to use the // prefix to refer to targets using their full address from the root (e.g. //3rdparty/python:tool). This is necessary to distinguish address specs from local or VCS requirements.

The lockfile will be validated against the requirements - if a lockfile doesn't provide the requirement (at a suitable version, if the requirement specifies version constraints) Pants will error.

If unspecified, install the entire lockfile.

Deprecated options​

None

None