Skip to main content
Version: 2.23

pex-cli

The PEX (Python EXecutable) tool (https://github.com/pex-tool/pex).

Backend: pants.backend.python

Config section: [pex-cli]

Basic options​

global_args​

--pex-cli-global-args="[<shell_str>, <shell_str>, ...]"
PANTS_PEX_CLI_GLOBAL_ARGS
pants.toml
[pex-cli]
global_args = [
    <shell_str>,
    <shell_str>,
    ...,
]
default: []

Arguments to pass directly to pex, e.g. --pex-cli-args='--check=error --no-compile'.

Note that these apply to all invocations of the pex tool, including building pex_binary targets, preparing python_test targets to run, and generating lockfiles.

Advanced options​

known_versions​

--pex-cli-known-versions="['<str>', '<str>', ...]"
PANTS_PEX_CLI_KNOWN_VERSIONS
pants.toml
[pex-cli]
known_versions = [
    '<str>',
    '<str>',
    ...,
]
default: 
[
  "v2.16.2|macos_arm64|f2ec29dda754c71a8b662e3b4a9071aef269a9991ae920666567669472dcd556|4284448",
  "v2.16.2|macos_x86_64|f2ec29dda754c71a8b662e3b4a9071aef269a9991ae920666567669472dcd556|4284448",
  "v2.16.2|linux_x86_64|f2ec29dda754c71a8b662e3b4a9071aef269a9991ae920666567669472dcd556|4284448",
  "v2.16.2|linux_arm64|f2ec29dda754c71a8b662e3b4a9071aef269a9991ae920666567669472dcd556|4284448"
]

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​

--pex-cli-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_PEX_CLI_URL_PLATFORM_MAPPING
pants.toml
[pex-cli.url_platform_mapping]
key1 = val1
key2 = val2
...
default: {}

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​

--pex-cli-url-template=<str>
PANTS_PEX_CLI_URL_TEMPLATE
pants.toml
[pex-cli]
url_template = <str>
default: https://github.com/pex-tool/pex/releases/download/{version}/pex

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​

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

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

Supported pex versions: >=2.3.0,<3.0

version​

--pex-cli-version=<str>
PANTS_PEX_CLI_VERSION
pants.toml
[pex-cli]
version = <str>
default: v2.16.2

Use this version of pex.

Supported pex versions: >=2.3.0,<3.0

Deprecated options​

None

None