Skip to main content
Version: 2.32 (prerelease)

uv

The uv Python package manager (https://github.com/astral-sh/uv).

Backend: pants.backend.python

Config section: [uv]

Basic options​

args_for_uv_pip_install​

--uv-args-for-uv-pip-install="[<shell_str>, <shell_str>, ...]"
PANTS_UV_ARGS_FOR_UV_PIP_INSTALL
pants.toml
[uv]
args_for_uv_pip_install = [
  <shell_str>,
  <shell_str>,
  ...,
]
default: []

Arguments to pass directly to uv, e.g. --uv-args='--index-strategy unsafe-first-match'.

Additional arguments to pass to uv pip install invocations.

Used when [python].pex_builder = "uv" to pass extra flags to the uv pip install step (e.g. --index-url, --extra-index-url). These are NOT passed to the uv venv step.

Advanced options​

known_versions​

--uv-known-versions="['<str>', '<str>', ...]"
PANTS_UV_KNOWN_VERSIONS
pants.toml
[uv]
known_versions = [
  '<str>',
  '<str>',
  ...,
]
default: 
[
  "0.11.6|macos_arm64 |4b69a4e366ec38cd5f305707de95e12951181c448679a00dce2a78868dfc9f5b|20807020",
  "0.11.6|linux_x86_64|aa342a53abe42364093506d7704214d2cdca30b916843e520bc67759a5d20132|24460747",
  "0.11.6|linux_arm64 |d14ebd6f200047264152daaf97b8bd36c7885a5033e9e8bba8366cb0049c0d00|22576913"
]

Known versions to verify downloads against.

Each element is a pipe-separated string of version|platform|sha256|length or version|platform|sha256|length|url_override, where:

  • version is the version string
  • platform is one of [linux_arm64,linux_x86_64,macos_arm64,macos_x86_64]
  • sha256 is the 64-character hex representation of the expected sha256 digest of the download file, as emitted by shasum -a 256
  • length is the expected length of the download file in bytes, as emitted by wc -c
  • (Optional) url_override is a specific url to use instead of the normally generated url for this version

E.g., 3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813. and 3.1.2|macos_arm64 |aca5c1da0192e2fd46b7b55ab290a92c5f07309e7b0ebf4e45ba95731ae98291|50926|https://example.mac.org/bin/v3.1.2/mac-aarch64-v3.1.2.tgz.

Values are space-stripped, so pipes can be indented for readability if necessary.

url_platform_mapping​

--uv-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_UV_URL_PLATFORM_MAPPING
pants.toml
[uv.url_platform_mapping]
key1 = val1
key2 = val2
...
default: 
{
  "linux_arm64": "aarch64-unknown-linux-musl",
  "linux_x86_64": "x86_64-unknown-linux-musl",
  "macos_arm64": "aarch64-apple-darwin"
}

A dictionary mapping platforms to strings to be used when generating the URL to download the tool.

In --url-template, anytime the {platform} string is used, Pants will determine the current platform, and substitute {platform} with the respective value from your dictionary.

For example, if you define {"macos_x86_64": "apple-darwin", "linux_x86_64": "unknown-linux"}, and run Pants on Linux with an intel architecture, then {platform} will be substituted in the --url-template option with unknown-linux.

url_template​

--uv-url-template=<str>
PANTS_UV_URL_TEMPLATE
pants.toml
[uv]
url_template = <str>
default: https://github.com/astral-sh/uv/releases/download/{version}/uv-{platform}.tar.gz

URL to download the tool, either as a single binary file or a compressed file (e.g. zip file). You can change this to point to your own hosted file, e.g. to work with proxies or for access via the filesystem through a file:$abspath URL (e.g. file:/this/is/absolute, possibly by templating the buildroot in a config file).

Use {version} to have the value from --version substituted, and {platform} to have a value from --url-platform-mapping substituted in, depending on the current platform. For example, https://github.com/.../protoc-&#123;version&#125;-&#123;platform&#125;.zip.

use_unsupported_version​

--uv-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_UV_USE_UNSUPPORTED_VERSION
pants.toml
[uv]
use_unsupported_version = <UnsupportedVersionUsage>
one of: error, warning
default: error

What action to take in case the requested version of uv is not supported.

Supported uv versions: >=0.7.4,<1.0

version​

--uv-version=<str>
PANTS_UV_VERSION
pants.toml
[uv]
version = <str>
default: 0.11.6

Use this version of uv.

Supported uv versions: >=0.7.4,<1.0

Deprecated options​

None

None