nice-florist-55958
11/11/2021, 11:55 PMenough-analyst-54434
11/12/2021, 1:27 AM./pants help tools
. You'll get information about each tool we use and either the Python requirements that we grab the tool via or else the URLs we fetch the tool from.enough-analyst-54434
11/12/2021, 1:30 AMnice-florist-55958
11/12/2021, 1:44 AMnice-florist-55958
11/12/2021, 1:46 AMnice-florist-55958
11/12/2021, 1:51 AMenough-analyst-54434
11/12/2021, 1:53 AMenough-analyst-54434
11/12/2021, 1:54 AMnice-florist-55958
11/12/2021, 1:55 AMenough-analyst-54434
11/12/2021, 1:56 AMenough-analyst-54434
11/12/2021, 1:57 AM$ ./pants help tools
External Tools
--------------
autoflake The Autoflake Python code formatter (<https://github.com/myint/autoflake>).
Version: autoflake==1.4
black The Black Python code formatter (<https://black.readthedocs.io/>).
Version: black==21.9b0
coursier A dependency resolver for the Maven ecosystem.
Version: v2.0.16-169-g194ebc55c
URL template: <https://github.com/coursier/coursier/releases/download/{version}/cs-{platform}.gz>
coverage-py Configuration for Python test coverage measurement.
Version: coverage[toml]>=5.5,<5.6
docformatter The Python docformatter tool (<https://github.com/myint/docformatter>).
Version: docformatter>=1.4,<1.5
dockerfile-parser Used to parse Dockerfile build specs to infer their dependencies.
Version: dockerfile==3.2.0
download-pex-bin The PEX (Python EXecutable) tool (<https://github.com/pantsbuild/pex>).
Version: v2.1.54
URL template: <https://github.com/pantsbuild/pex/releases/download/{version}/pex>
flake8 The Flake8 Python linter (<https://flake8.pycqa.org/>).
Version: flake8>=3.9.2,<4.0
ipython The IPython enhanced REPL (<https://ipython.org/>).
Version: ipython==7.16.1
isort The Python import sorter tool (<https://pycqa.github.io/isort/>).
Version: isort[pyproject,colors]>=5.9.3,<6.0
mypy The MyPy Python type checker (<http://mypy-lang.org/>).
Version: mypy==0.910
poetry Used to generate lockfiles for third-party Python dependencies.
Version: poetry==1.1.8
pytest The pytest Python test framework (<https://docs.pytest.org/>).
Version: pytest>=6.2.4,<6.3
scala Scala programming language
Version: 2.13.6
scc The Succinct Code Counter, aka `scc` (<https://github.com/boyter/scc>).
Version: 3.0.0
URL template: <https://github.com/boyter/scc/releases/download/v{version}/scc-{version}-{platform}.zip>
setuptools Python setuptools, used to package `python_distribution` targets.
Version: setuptools>=50.3.0,<58.0
shellcheck A linter for shell scripts.
Version: v0.7.1
URL template: <https://github.com/koalaman/shellcheck/releases/download/{version}/shellcheck-{version}.{platform}.tar.xz>
shfmt An autoformatter for shell scripts (<https://github.com/mvdan/sh>).
Version: v3.2.4
URL template: <https://github.com/mvdan/sh/releases/download/{version}/shfmt_{version}_{platform}>
twine The utility for publishing Python distributions to PyPi and other Python repositories.
Version: twine==3.4.2
Use `./pants help $tool` to get help for a specific tool.
nice-florist-55958
11/12/2021, 1:59 AMenough-analyst-54434
11/12/2021, 1:59 AMdownload-pex-bin
for example. You'd then ask for ./pants help-advanced
for that tool:
$ ./pants help-advanced download-pex-bin
`download-pex-bin` subsystem options
------------------------------------
The PEX (Python EXecutable) tool (<https://github.com/pantsbuild/pex>).
Config section: [download-pex-bin]
None available.
`download-pex-bin` subsystem advanced options
---------------------------------------------
--download-pex-bin-version=<str>
PANTS_DOWNLOAD_PEX_BIN_VERSION
version
default: v2.1.54
current value: v2.1.54
Use this version of pex.
Supported pex versions: >=2.1.51,<3.0
--download-pex-bin-known-versions="['<str>', '<str>', ...]"
PANTS_DOWNLOAD_PEX_BIN_KNOWN_VERSIONS
known_versions
default: [
"v2.1.54|macos_arm64|c892c82961f73e41aaafad3c692cfd51f6013bed2f7b408041be6c1b90d06451|3679238",
"v2.1.54|macos_x86_64|c892c82961f73e41aaafad3c692cfd51f6013bed2f7b408041be6c1b90d06451|3679238",
"v2.1.54|linux_x86_64|c892c82961f73e41aaafad3c692cfd51f6013bed2f7b408041be6c1b90d06451|3679238"
]
current value: [
"v2.1.54|macos_arm64|c892c82961f73e41aaafad3c692cfd51f6013bed2f7b408041be6c1b90d06451|3679238",
"v2.1.54|macos_x86_64|c892c82961f73e41aaafad3c692cfd51f6013bed2f7b408041be6c1b90d06451|3679238",
"v2.1.54|linux_x86_64|c892c82961f73e41aaafad3c692cfd51f6013bed2f7b408041be6c1b90d06451|3679238"
]
Known versions to verify downloads against.
Each element is a pipe-separated string of `version|platform|sha256|length`, 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`
E.g., `3.1.2|macos_x86_64|6d0f18cd84b918c7b3edd0203e75569e0c7caecb1367bbbe409b44e28514f5be|42813`.
Values are space-stripped, so pipes can be indented for readability if necessary.
--download-pex-bin-use-unsupported-version=<UnsupportedVersionUsage>
PANTS_DOWNLOAD_PEX_BIN_USE_UNSUPPORTED_VERSION
use_unsupported_version
one of: [error, warning]
default: error
current value: error
What action to take in case the requested version of pex is not supported.
Supported pex versions: >=2.1.51,<3.0
--download-pex-bin-url-template=<str>
PANTS_DOWNLOAD_PEX_BIN_URL_TEMPLATE
url_template
default: <https://github.com/pantsbuild/pex/releases/download/{version}/pex>
current value: <https://github.com/pantsbuild/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](<https://www.pantsbuild.org/v2.9/docs/options#config-file-entries))>.
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-{version}-{platform}.zip>.
--download-pex-bin-url-platform-mapping="{'key1': val1, 'key2': val2, ...}"
PANTS_DOWNLOAD_PEX_BIN_URL_PLATFORM_MAPPING
url_platform_mapping
default: {}
current value: {}
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.
`download-pex-bin` subsystem deprecated options
-----------------------------------------------
None available.
That gives you the details of which options to set.enough-analyst-54434
11/12/2021, 2:00 AMenough-analyst-54434
11/12/2021, 2:02 AM./pants offline tools --dir=/download/here/please
and that would both download all tools known and output the configuration you'd need to add to pants.toml to point to those tools.enough-analyst-54434
11/12/2021, 2:02 AMnice-florist-55958
11/12/2021, 2:06 AMnice-florist-55958
11/12/2021, 2:06 AMhappy-kitchen-89482
11/12/2021, 2:07 AMenough-analyst-54434
11/12/2021, 2:07 AMhappy-kitchen-89482
11/12/2021, 2:08 AMnice-florist-55958
11/12/2021, 2:09 AMnice-florist-55958
11/12/2021, 2:09 AMnice-florist-55958
11/12/2021, 2:09 AMhappy-kitchen-89482
11/12/2021, 2:11 AMnice-florist-55958
11/12/2021, 2:11 AMnice-florist-55958
11/12/2021, 2:11 AMhappy-kitchen-89482
11/12/2021, 2:11 AMenough-analyst-54434
11/12/2021, 2:11 AMpantsbuild.pants[telemetry]
by default, but allow you to opt out and just have it use pantsbuild.pants
. We don't have humbug
set up as a telemetry
extra today, but we could structure it that way if this is a (common) problem.nice-florist-55958
11/12/2021, 2:12 AMnice-florist-55958
11/12/2021, 2:12 AMenough-analyst-54434
11/12/2021, 2:13 AMhappy-kitchen-89482
11/12/2021, 2:16 AMnice-florist-55958
11/12/2021, 3:19 AMnice-florist-55958
11/12/2021, 3:21 AMnice-florist-55958
11/12/2021, 3:21 AMnice-florist-55958
11/12/2021, 3:25 AMnice-florist-55958
11/12/2021, 3:26 AMhappy-kitchen-89482
11/12/2021, 3:30 AMwitty-crayon-22786
11/12/2021, 5:20 PMhundreds-father-404
11/12/2021, 5:20 PMwitty-crayon-22786
11/12/2021, 5:22 PMnice-florist-55958
11/12/2021, 6:01 PMwitty-crayon-22786
11/12/2021, 6:15 PM--no-dynamic-ui
, but i’ll open an issue about that. EDIT: https://github.com/pantsbuild/pants/issues/13595