Pantsbuild
2.18.0Schema URL
Pants configuration file schema: https://www.pantsbuild.org/
Properties
Options to control the overall behavior of Pants.
91 nested properties
Register functionality from these backends https://www.pantsbuild.org/v2.14/docs/reference-global#backend_packages
[]Python files to evaluate and whose symbols should be exposed to all BUILD files https://www.pantsbuild.org/v2.14/docs/reference-global#build_file_prelude_globs
[]Path globs or literals to ignore when identifying BUILD files https://www.pantsbuild.org/v2.14/docs/reference-global#build_ignore
[]The naming scheme for BUILD files, i.e. where you define targets https://www.pantsbuild.org/v2.14/docs/reference-global#build_patterns
[
"BUILD",
"BUILD.*"
]Path to a file containing PEM-format CA certificates used for verifying secure connections when downloading files required by a build https://www.pantsbuild.org/v2.14/docs/reference-global#ca_certs_path
Controls how the content of cache entries is handled during process execution https://www.pantsbuild.org/v2.14/docs/reference-global#cache_content_behavior
Whether Pants should use colors in output or not https://www.pantsbuild.org/v2.14/docs/reference-global#colors
Enable concurrent runs of Pants https://www.pantsbuild.org/v2.14/docs/reference-global#concurrent
Display a dynamically-updating console UI as Pants runs https://www.pantsbuild.org/v2.14/docs/reference-global#dynamic_ui
If --dynamic-ui is enabled, selects the renderer
https://www.pantsbuild.org/v2.14/docs/reference-global#dynamic_ui_renderer
A directory to write execution and rule graphs to as dot files
https://www.pantsbuild.org/v2.14/docs/reference-global#engine_visualize_to
Ignore logs and warnings matching these strings https://www.pantsbuild.org/v2.14/docs/reference-global#ignore_warnings
[]Controls whether Pants will clean up local directories used as chroots for running processes https://www.pantsbuild.org/v2.14/docs/reference-global#keep_sandboxes
Set the logging level https://www.pantsbuild.org/v2.14/docs/reference-global#level
Whether to cache process executions in a local cache persisted to disk at --local-store-dir
https://www.pantsbuild.org/v2.14/docs/reference-global#local_cache
Directory to use for local process execution sandboxing https://www.pantsbuild.org/v2.14/docs/reference-global#local_execution_root_dir
Directory to use for the local file store, which stores the results of subprocesses run by Pants https://www.pantsbuild.org/v2.14/docs/reference-global#local_store_dir
The maximum size in bytes of the local store containing directories https://www.pantsbuild.org/v2.14/docs/reference-global#local_store_directories_max_size_bytes
The maximum size in bytes of the local store containing files https://www.pantsbuild.org/v2.14/docs/reference-global#local_store_files_max_size_bytes
The maximum size in bytes of the local store containing process cache entries https://www.pantsbuild.org/v2.14/docs/reference-global#local_store_processes_max_size_bytes
The number of LMDB shards created for the local store https://www.pantsbuild.org/v2.14/docs/reference-global#local_store_shard_count
Set a more specific logging level for one or more logging targets https://www.pantsbuild.org/v2.14/docs/reference-global#log_levels_by_target
{}Whether to show/hide logging done by 3rdparty Rust crates used by the Pants engine https://www.pantsbuild.org/v2.14/docs/reference-global#log_show_rust_3rdparty
Write logs to files under this directory https://www.pantsbuild.org/v2.14/docs/reference-global#logdir
Run goals continuously as file changes are detected https://www.pantsbuild.org/v2.14/docs/reference-global#loop
The maximum number of times to loop when --loop is specified
https://www.pantsbuild.org/v2.14/docs/reference-global#loop_max
Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches https://www.pantsbuild.org/v2.14/docs/reference-global#named_caches_dir
The name of the script or binary used to invoke Pants https://www.pantsbuild.org/v2.14/docs/reference-global#pants_bin_name
Paths to Pants config files https://www.pantsbuild.org/v2.14/docs/reference-global#pants_config_files
[
"<buildroot>/pants.toml"
]Write end products, such as the results of ./pants package, to this dir
https://www.pantsbuild.org/v2.14/docs/reference-global#pants_distdir
Paths to ignore for all filesystem operations performed by pants (e.g https://www.pantsbuild.org/v2.14/docs/reference-global#pants_ignore
[
".*/",
"/dist/",
"__pycache__"
]Make use of a root .gitignore file when determining whether to ignore filesystem operations performed by Pants https://www.pantsbuild.org/v2.14/docs/reference-global#pants_ignore_use_gitignore
When set, a base directory in which to store --pants-workdir contents
https://www.pantsbuild.org/v2.14/docs/reference-global#pants_physical_workdir_base
The directory to use for tracking subprocess metadata https://www.pantsbuild.org/v2.14/docs/reference-global#pants_subprocessdir
Use this Pants version https://www.pantsbuild.org/v2.14/docs/reference-global#pants_version
Write intermediate logs and output files to this dir https://www.pantsbuild.org/v2.14/docs/reference-global#pants_workdir
Enables use of the Pants daemon (pantsd). pantsd can significantly improve runtime performance by lowering per-run startup cost, and by memoizing filesystem operations and rule execution https://www.pantsbuild.org/v2.14/docs/reference-global#pantsd
Filesystem events matching any of these globs will trigger a daemon restart https://www.pantsbuild.org/v2.14/docs/reference-global#pantsd_invalidation_globs
[]The maximum memory usage of the pantsd process https://www.pantsbuild.org/v2.14/docs/reference-global#pantsd_max_memory_usage
The port to bind the Pants nailgun server to https://www.pantsbuild.org/v2.14/docs/reference-global#pantsd_pailgun_port
The maximum amount of time to wait for the invocation to start until raising a timeout exception https://www.pantsbuild.org/v2.14/docs/reference-global#pantsd_timeout_when_multiple_invocations
Use pantsrc files located at the paths specified in the global option pantsrc_files
https://www.pantsbuild.org/v2.14/docs/reference-global#pantsrc
Override config with values from these files, using syntax matching that of --pants-config-files
https://www.pantsbuild.org/v2.14/docs/reference-global#pantsrc_files
[
"/etc/pantsrc",
"~/.pants.rc",
".pants.rc"
]Allow backends to be loaded from these plugins (usually released through PyPI). The default backends for each plugin will be loaded automatically https://www.pantsbuild.org/v2.14/docs/reference-global#plugins
[]Re-resolve plugins, even if previously resolved https://www.pantsbuild.org/v2.14/docs/reference-global#plugins_force_resolve
Print the full exception stack trace for any errors https://www.pantsbuild.org/v2.14/docs/reference-global#print_stacktrace
If false, Pants will not clean up local directories used as chroots for running processes https://www.pantsbuild.org/v2.14/docs/reference-global#process_cleanup
The cache namespace for process execution https://www.pantsbuild.org/v2.14/docs/reference-global#process_execution_cache_namespace
The time in seconds to wait when gracefully shutting down an interactive process (such as one opened using ./pants run) before killing it
https://www.pantsbuild.org/v2.14/docs/reference-global#process_execution_graceful_shutdown_timeout
Whether or not to use nailgun to run JVM requests that are marked as supporting nailgun https://www.pantsbuild.org/v2.14/docs/reference-global#process_execution_local_enable_nailgun
Number of concurrent processes that may be executed locally https://www.pantsbuild.org/v2.14/docs/reference-global#process_execution_local_parallelism
Number of concurrent processes that may be executed remotely https://www.pantsbuild.org/v2.14/docs/reference-global#process_execution_remote_parallelism
The default memory usage for a single "pooled" child process https://www.pantsbuild.org/v2.14/docs/reference-global#process_per_child_memory_usage
The maximum memory usage for all "pooled" child processes https://www.pantsbuild.org/v2.14/docs/reference-global#process_total_child_memory_usage
Add these directories to PYTHONPATH to search for plugins https://www.pantsbuild.org/v2.14/docs/reference-global#pythonpath
[]Path to a plugin to dynamically configure remote caching and execution options https://www.pantsbuild.org/v2.14/docs/reference-global#remote_auth_plugin
Path to a PEM file containing CA certificates used for verifying secure connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address
https://www.pantsbuild.org/v2.14/docs/reference-global#remote_ca_certs_path
Whether to enable reading from a remote cache https://www.pantsbuild.org/v2.14/docs/reference-global#remote_cache_read
Timeout value for remote cache lookups in milliseconds https://www.pantsbuild.org/v2.14/docs/reference-global#remote_cache_read_timeout_millis
The number of concurrent requests allowed to the remote cache service https://www.pantsbuild.org/v2.14/docs/reference-global#remote_cache_rpc_concurrency
How frequently to log remote cache failures at the warn log level
https://www.pantsbuild.org/v2.14/docs/reference-global#remote_cache_warnings
Whether to enable writing results to a remote cache https://www.pantsbuild.org/v2.14/docs/reference-global#remote_cache_write
Enables remote workers for increased parallelism. (Alpha) https://www.pantsbuild.org/v2.14/docs/reference-global#remote_execution
The URI of a server used as a remote execution scheduler https://www.pantsbuild.org/v2.14/docs/reference-global#remote_execution_address
Platform properties to set on remote execution requests https://www.pantsbuild.org/v2.14/docs/reference-global#remote_execution_extra_platform_properties
[]Headers to set on remote execution requests https://www.pantsbuild.org/v2.14/docs/reference-global#remote_execution_headers
Overall timeout in seconds for each remote execution request from time of submission https://www.pantsbuild.org/v2.14/docs/reference-global#remote_execution_overall_deadline_secs
The number of concurrent requests allowed to the remote execution service https://www.pantsbuild.org/v2.14/docs/reference-global#remote_execution_rpc_concurrency
Name of the remote instance to use by remote caching and remote execution https://www.pantsbuild.org/v2.14/docs/reference-global#remote_instance_name
Path to a file containing an oauth token to use for gGRPC connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address
https://www.pantsbuild.org/v2.14/docs/reference-global#remote_oauth_bearer_token_path
The URI of a server used for the remote file store https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_address
The maximum total size of blobs allowed to be sent in a single batch API call to the remote store https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_batch_api_size_limit
Size in bytes of chunks transferred to/from the remote file store https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_chunk_bytes
Timeout (in seconds) for uploads of individual chunks to the remote file store https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_chunk_upload_timeout_seconds
Headers to set on remote store requests https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_headers
The number of concurrent requests allowed to the remote store service https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_rpc_concurrency
Number of times to retry any RPC to the remote store before giving up https://www.pantsbuild.org/v2.14/docs/reference-global#remote_store_rpc_retries
The number of threads to keep active and ready to execute @rule logic (see also: --rule-threads-max)
https://www.pantsbuild.org/v2.14/docs/reference-global#rule_threads_core
The maximum number of threads to use to execute @rule logic
https://www.pantsbuild.org/v2.14/docs/reference-global#rule_threads_max
Display the target where a log message originates in that log message's output https://www.pantsbuild.org/v2.14/docs/reference-global#show_log_target
Read additional specs (target addresses, files, and/or globs), one per line, from these files https://www.pantsbuild.org/v2.14/docs/reference-global#spec_files
[]Option scopes to record in stats on run completion https://www.pantsbuild.org/v2.14/docs/reference-global#stats_record_option_scopes
[
"*"
]True if stats recording should be allowed to complete asynchronously when pantsd is enabled
https://www.pantsbuild.org/v2.14/docs/reference-global#streaming_workunits_complete_async
The level of workunits that will be reported to streaming workunit event receivers https://www.pantsbuild.org/v2.14/docs/reference-global#streaming_workunits_level
Interval in seconds between when streaming workunit event receivers will be polled https://www.pantsbuild.org/v2.14/docs/reference-global#streaming_workunits_report_interval
Paths that correspond with build roots for any subproject that this project depends on https://www.pantsbuild.org/v2.14/docs/reference-global#subproject_roots
[]Include only targets with these tags (optional '+' prefix) or without these tags ('-' prefix) https://www.pantsbuild.org/v2.14/docs/reference-global#tag
[]What to do when files and globs specified in BUILD files, such as in the sources field, cannot be found
https://www.pantsbuild.org/v2.14/docs/reference-global#unmatched_build_file_globs
What to do when command line arguments, e.g. files and globs like dir::, cannot be found
https://www.pantsbuild.org/v2.14/docs/reference-global#unmatched_cli_globs
Verify that all config file values correspond to known options https://www.pantsbuild.org/v2.14/docs/reference-global#verify_config
Set to False if Pants should not watch the filesystem for changes. pantsd or loop may not be enabled
https://www.pantsbuild.org/v2.14/docs/reference-global#watch_filesystem
Options related to sending anonymous stats to the Pants project, to aid development.
2 nested properties
Whether to send anonymous telemetry to the Pants project https://www.pantsbuild.org/v2.14/docs/reference-anonymous-telemetry#enabled
An anonymized ID representing this repo https://www.pantsbuild.org/v2.14/docs/reference-anonymous-telemetry#repo_id
Set up for authenticating with Toolchain.
6 nested properties
Path (relative to the repo root) at which to store and read the auth token https://www.pantsbuild.org/v2.14/docs/reference-auth#auth_file
Environment variables in CI used to identify the build (used for restricted tokens) https://www.pantsbuild.org/v2.14/docs/reference-auth#ci_env_variables
[]Load the access token from this environment variable https://www.pantsbuild.org/v2.14/docs/reference-auth#from_env_var
Organization slug for public repo PRs https://www.pantsbuild.org/v2.14/docs/reference-auth#org
A mapping of environment variable name to a regex that must match that variable's value in order for the plugin to request a restricted access token https://www.pantsbuild.org/v2.14/docs/reference-auth#restricted_token_matches
{}Threshold (in minutes) for token TTL before plugin asks for a new token https://www.pantsbuild.org/v2.14/docs/reference-auth#token_expiration_threshold
Acquire access tokens for the Toolchain service.
7 nested properties
Token description https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#description
Generate a token with impersonation permissions that can be used in CI. Limited to org owners/admins https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#for_ci
Don't open a browser when acquiring the access token https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#headless
Local web server port https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#local_port
Output method for the access token https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#output
[Limited Beta] Asks for a token with remote execution permissions https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#remote_execution
Helper to test success and error pages without triggering the auth flow https://www.pantsbuild.org/v2.14/docs/reference-auth-acquire#test_page
Check if the Toolchain auth token has expired or if it is about to expire
1 nested properties
Threshold in days to fail the check before the token expiration https://www.pantsbuild.org/v2.14/docs/reference-auth-token-check#threshold
Show information about the current auth token used to access the Toolchain service
2 nested properties
Show JWT claims in JSON format (implies verbose)
https://www.pantsbuild.org/v2.14/docs/reference-auth-token-info#json
Show all JWT claims for the current auth token https://www.pantsbuild.org/v2.14/docs/reference-auth-token-info#verbose
The Autoflake Python code formatter (https://github.com/myint/autoflake).
9 nested properties
Arguments to pass directly to Autoflake, e.g. --autoflake-args='--remove-all-unused-imports --target-version=py37 --quiet'
https://www.pantsbuild.org/v2.14/docs/reference-autoflake#args
[
"--remove-all-unused-imports"
]The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-autoflake#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-autoflake#entry_point
If true, export a virtual environment with Autoflake when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-autoflake#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-autoflake#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-autoflake#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-autoflake#lockfile
If true, don't use Autoflake when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-autoflake#skip
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-autoflake#version
The Black Python code formatter (https://black.readthedocs.io/).
11 nested properties
Arguments to pass directly to Black, e.g. --black-args='--target-version=py37 --quiet'
https://www.pantsbuild.org/v2.14/docs/reference-black#args
[]Path to a TOML config file understood by Black (https://github.com/psf/black#configuration-format) https://www.pantsbuild.org/v2.14/docs/reference-black#config
If true, Pants will include any relevant pyproject.toml config files during runs https://www.pantsbuild.org/v2.14/docs/reference-black#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-black#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-black#entry_point
If true, export a virtual environment with Black when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-black#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-black#extra_requirements
[
"typing-extensions>=3.10.0.0; python_version < \"3.10\""
]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-black#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-black#lockfile
If true, don't use Black when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-black#skip
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-black#version
Configuration for Toolchain's BuildSense reporting.
12 nested properties
patterns for environment variables to exclude from uploaded CI env variables https://www.pantsbuild.org/v2.14/docs/reference-buildsense#ci_env_scrub_terms
[
"ACCESS",
"TOKEN",
"SECRET",
"JWT"
]CI Environment variables regex pattern https://www.pantsbuild.org/v2.14/docs/reference-buildsense#ci_env_var_pattern
Should BuildSense collect and upload platform platform information (os version, platform architecture, python version, etc...) https://www.pantsbuild.org/v2.14/docs/reference-buildsense#collect_platform_data
Go thru the motions w/o making network calls https://www.pantsbuild.org/v2.14/docs/reference-buildsense#dry_run
Enables the BuildSense reporter plugin https://www.pantsbuild.org/v2.14/docs/reference-buildsense#enable
Store failed uploads and try to upload later https://www.pantsbuild.org/v2.14/docs/reference-buildsense#local_build_store
Base directory for storing buildsense data locally https://www.pantsbuild.org/v2.14/docs/reference-buildsense#local_store_base
Should BuildSense log the time it took to upload data at the end of the run https://www.pantsbuild.org/v2.14/docs/reference-buildsense#log_final_upload_latency
Upload pants logs to buildsense https://www.pantsbuild.org/v2.14/docs/reference-buildsense#log_upload
Maximum batch size to try and upload (uncompressed) https://www.pantsbuild.org/v2.14/docs/reference-buildsense#max_batch_size_mb
Show link to the pants run in BuildSense Web UI https://www.pantsbuild.org/v2.14/docs/reference-buildsense#show_link
Wait at most this many seconds for network calls to complete https://www.pantsbuild.org/v2.14/docs/reference-buildsense#timeout
Tell Pants to detect what files and targets have changed from Git.
See https://www.pantsbuild.org/v2.14/docs/advanced-target-selection.
3 nested properties
Include direct or transitive dependees of changed targets https://www.pantsbuild.org/v2.14/docs/reference-changed#dependees
Calculate changes contained within a given Git spec (commit range/SHA/ref) https://www.pantsbuild.org/v2.14/docs/reference-changed#diffspec
Calculate changes since this Git spec (commit range/SHA/ref) https://www.pantsbuild.org/v2.14/docs/reference-changed#since
Run type checking or the lightest variant of compilation available for a language.
1 nested properties
Only run these checkerss and skip all others https://www.pantsbuild.org/v2.14/docs/reference-check#only
[]Options for checking that external tool default locations are correctly typed.
Options for configuring CLI behavior, such as command line aliases.
1 nested properties
Register command line aliases https://www.pantsbuild.org/v2.14/docs/reference-cli#alias
{}Count lines of code.
A dependency resolver for the Maven ecosystem. (https://get-coursier.io/)
6 nested properties
Known versions to verify downloads against https://www.pantsbuild.org/v2.14/docs/reference-coursier#known_versions
[
"v2.1.0-M5-18-gfebf9838c|linux_arm64 |d4ad15ba711228041ad8a46d848c83c8fbc421d7b01c415d8022074dd609760f|19264005",
"v2.1.0-M5-18-gfebf9838c|linux_x86_64|3e1a1ad1010d5582e9e43c5a26b273b0147baee5ebd27d3ac1ab61964041c90b|19551533",
"v2.1.0-M5-18-gfebf9838c|macos_arm64 |d13812c5a5ef4c9b3e25cc046d18addd09bacd149f95b20a14e4d2a73e358ecf|18826510",
"v2.1.0-M5-18-gfebf9838c|macos_x86_64|d13812c5a5ef4c9b3e25cc046d18addd09bacd149f95b20a14e4d2a73e358ecf|18826510",
"v2.0.16-169-g194ebc55c|linux_arm64 |da38c97d55967505b8454c20a90370c518044829398b9bce8b637d194d79abb3|18114472",
"v2.0.16-169-g194ebc55c|linux_x86_64|4c61a634c4bd2773b4543fe0fc32210afd343692891121cddb447204b48672e8|18486946",
"v2.0.16-169-g194ebc55c|macos_arm64 |15bce235d223ef1d022da30b67b4c64e9228d236b876c834b64e029bbe824c6f|17957182",
"v2.0.16-169-g194ebc55c|macos_x86_64|15bce235d223ef1d022da30b67b4c64e9228d236b876c834b64e029bbe824c6f|17957182"
]Maven style repositories to resolve artifacts from https://www.pantsbuild.org/v2.14/docs/reference-coursier#repos
[
"https://maven-central.storage-download.googleapis.com/maven2",
"https://repo1.maven.org/maven2"
]A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.14/docs/reference-coursier#url_platform_mapping
{
"linux_arm64": "aarch64-pc-linux",
"linux_x86_64": "x86_64-pc-linux",
"macos_arm64": "x86_64-apple-darwin",
"macos_x86_64": "x86_64-apple-darwin"
}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.14/docs/reference-coursier#url_template
What action to take in case the requested version of coursier is not supported https://www.pantsbuild.org/v2.14/docs/reference-coursier#use_unsupported_version
Use this version of coursier https://www.pantsbuild.org/v2.14/docs/reference-coursier#version
Configuration for Python test coverage measurement.
13 nested properties
Path to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/stable/config.html) https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#config
If true, Pants will include any relevant config files during runs (.coveragerc, setup.cfg, tox.ini, and pyproject.toml)
https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#entry_point
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#extra_requirements
[]Fail if the total combined coverage percentage for all tests is less than this number https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#fail_under
A list of Python modules or filesystem paths to use in the coverage report, e.g. `['helloworld_test', 'helloworld/util/dirutil'] https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#filter
[]If true, Pants will generate a global coverage report https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#global_report
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#lockfile
Path to write the Pytest Coverage report to https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#output_dir
Which coverage report type(s) to emit https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#report
[
"console"
]Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-coverage-py#version
Options used to configure and launch a Debug Adapter server.
See https://microsoft.github.io/debug-adapter-protocol/ for more information.
2 nested properties
The hostname to use when launching the server https://www.pantsbuild.org/v2.14/docs/reference-debug-adapter#host
The port to use when launching the server https://www.pantsbuild.org/v2.14/docs/reference-debug-adapter#port
An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).
7 nested properties
Arguments to pass directly to debugpy, e.g. --debugpy-args='--log-to-stderr'
https://www.pantsbuild.org/v2.14/docs/reference-debugpy#args
[]The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-debugpy#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-debugpy#entry_point
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-debugpy#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-debugpy#interpreter_constraints
[
"CPython>=3.7,<3.11"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-debugpy#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-debugpy#version
List all targets that depend on any of the input files/targets.
4 nested properties
Include the input targets in the output, along with the dependees https://www.pantsbuild.org/v2.14/docs/reference-dependees#closed
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-dependees#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.14/docs/reference-dependees#sep
List all transitive dependees https://www.pantsbuild.org/v2.14/docs/reference-dependees#transitive
List the dependencies of the input files/targets.
4 nested properties
Include the input targets in the output, along with the dependencies https://www.pantsbuild.org/v2.14/docs/reference-dependencies#closed
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-dependencies#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.14/docs/reference-dependencies#sep
List all transitive dependencies https://www.pantsbuild.org/v2.14/docs/reference-dependencies#transitive
The Python docformatter tool (https://github.com/myint/docformatter).
9 nested properties
Arguments to pass directly to docformatter, e.g. --docformatter-args='--wrap-summaries=100 --pre-summary-newline'
https://www.pantsbuild.org/v2.14/docs/reference-docformatter#args
[]The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-docformatter#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-docformatter#entry_point
If true, export a virtual environment with docformatter when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-docformatter#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-docformatter#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-docformatter#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-docformatter#lockfile
If true, don't use docformatter when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-docformatter#skip
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-docformatter#version
Options for interacting with Docker.
11 nested properties
Global build arguments (for Docker --build-arg options) to use for all docker build invocations
https://www.pantsbuild.org/v2.14/docs/reference-docker#build_args
[]Global default value for target_stage on docker_image targets, overriding the field value on the targets, if there is a matching stage in the Dockerfile
https://www.pantsbuild.org/v2.14/docs/reference-docker#build_target_stage
Whether to log the Docker output to the console https://www.pantsbuild.org/v2.14/docs/reference-docker#build_verbose
Provide a default Docker build context root path for docker_image targets that does not specify their own context_root field
https://www.pantsbuild.org/v2.14/docs/reference-docker#default_context_root
Configure the default repository name used in the Docker image tag https://www.pantsbuild.org/v2.14/docs/reference-docker#default_repository
Environment variables to set for docker invocations
https://www.pantsbuild.org/v2.14/docs/reference-docker#env_vars
[]The PATH value that will be used to find the Docker client and any tools required https://www.pantsbuild.org/v2.14/docs/reference-docker#executable_search_paths
[
"<PATH>"
]Configure Docker registries https://www.pantsbuild.org/v2.14/docs/reference-docker#registries
{}Additional arguments to use for docker run invocations
https://www.pantsbuild.org/v2.14/docs/reference-docker#run_args
[]If true, add docker_image targets with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-docker#tailor
List any additional executable tools required for Docker to work https://www.pantsbuild.org/v2.14/docs/reference-docker#tools
[]Used to parse Dockerfile build specs to infer their dependencies.
4 nested properties
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-dockerfile-parser#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-dockerfile-parser#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-dockerfile-parser#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-dockerfile-parser#version
Setup repository for Build Server Protocol (https://build-server-protocol.github.io/).
3 nested properties
A list of config files that define groups of Pants targets to expose to IDEs via Build Server Protocol https://www.pantsbuild.org/v2.14/docs/reference-experimental-bsp#groups_config_files
[]Environment variables to set in the BSP runner script when setting up BSP in a repository https://www.pantsbuild.org/v2.14/docs/reference-experimental-bsp#runner_env_vars
[
"PATH"
]Run the Build Server Protocol server https://www.pantsbuild.org/v2.14/docs/reference-experimental-bsp#server
Perform a deployment process.
Run the Pants Explorer Web UI server.
2 nested properties
Server address to bind to https://www.pantsbuild.org/v2.14/docs/reference-experimental-explorer#address
Server port to bind to https://www.pantsbuild.org/v2.14/docs/reference-experimental-explorer#port
Export Pants data for use in other tools, such as IDEs.
Write generated files to dist/codegen for use outside of Pants.
List all source and BUILD files a target depends on.
5 nested properties
If True, output with absolute path https://www.pantsbuild.org/v2.14/docs/reference-filedeps#absolute
Instead of outputting filenames, output the original globs used in the BUILD file https://www.pantsbuild.org/v2.14/docs/reference-filedeps#globs
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-filedeps#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.14/docs/reference-filedeps#sep
If True, list files from all dependencies, including transitive dependencies https://www.pantsbuild.org/v2.14/docs/reference-filedeps#transitive
Filter the input targets based on various criteria.
Most of the filtering options below are comma-separated lists of filtering criteria, with an implied logical OR between them, so that a target passes the filter if it matches any of the criteria in the list. A '-' prefix inverts the sense of the entire comma-separated list, so that a target passes the filter only if it matches none of the criteria in the list.
Each of the filtering options may be specified multiple times, with an implied logical AND between them.
6 nested properties
Filter on target addresses matching these regexes https://www.pantsbuild.org/v2.14/docs/reference-filter#address_regex
[]Filter to rendering only targets declared in BUILD files, only file-level targets, or all targets https://www.pantsbuild.org/v2.14/docs/reference-filter#granularity
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-filter#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.14/docs/reference-filter#sep
Filter on targets with tags matching these regexes https://www.pantsbuild.org/v2.14/docs/reference-filter#tag_regex
[]Filter on these target types, e.g. resources or python_sources
https://www.pantsbuild.org/v2.14/docs/reference-filter#target_type
[]The Flake8 Python linter (https://flake8.pycqa.org/).
12 nested properties
Arguments to pass directly to Flake8, e.g. --flake8-args='--ignore E123,W456 --enable-extensions H111'
https://www.pantsbuild.org/v2.14/docs/reference-flake8#args
[]Path to an INI config file understood by Flake8 (https://flake8.pycqa.org/en/latest/user/configuration.html) https://www.pantsbuild.org/v2.14/docs/reference-flake8#config
If true, Pants will include any relevant config files during runs (.flake8, flake8, setup.cfg, and tox.ini)
https://www.pantsbuild.org/v2.14/docs/reference-flake8#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-flake8#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-flake8#entry_point
If true, export a virtual environment with Flake8 when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-flake8#export
Paths to extra files to include in the sandbox https://www.pantsbuild.org/v2.14/docs/reference-flake8#extra_files
[]Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-flake8#extra_requirements
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-flake8#lockfile
If true, don't use Flake8 when running ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-flake8#skip
An optional list of python_sources target addresses to load first-party plugins
https://www.pantsbuild.org/v2.14/docs/reference-flake8#source_plugins
[]Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-flake8#version
Autoformat source code.
2 nested properties
The target number of files to be included in each formatter batch https://www.pantsbuild.org/v2.14/docs/reference-fmt#batch_size
Only run these formatters and skip all others https://www.pantsbuild.org/v2.14/docs/reference-fmt#only
[]Generate lockfiles for Python third-party dependencies.
2 nested properties
If set, lockfile headers will say to run this command to regenerate the lockfile, rather than running ./pants generate-lockfiles --resolve=<name> like normal
https://www.pantsbuild.org/v2.14/docs/reference-generate-lockfiles#custom_command
Only generate lockfiles for the specified resolve(s) https://www.pantsbuild.org/v2.14/docs/reference-generate-lockfiles#resolve
[]Options for Go tests.
3 nested properties
Arguments to pass directly to Go test binary, e.g. --go-test-args='-run TestFoo -v'
https://www.pantsbuild.org/v2.14/docs/reference-go-test#args
[]Coverage mode to use when running Go tests with coverage analysis enabled via --test-use-coverage https://www.pantsbuild.org/v2.14/docs/reference-go-test#cover_mode
Path to write the Go coverage reports to https://www.pantsbuild.org/v2.14/docs/reference-go-test#coverage_output_dir
Gofmt-specific options.
1 nested properties
If true, don't use gofmt when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-gofmt#skip
Options for Golang support.
8 nested properties
The path relative to an ASDF install directory to use to find the bin directory within an installed Go distribution
https://www.pantsbuild.org/v2.14/docs/reference-golang#asdf_bin_relpath
The ASDF tool name to use when searching for installed Go distributions using the ASDF tool manager (https://asdf-vm.com/) https://www.pantsbuild.org/v2.14/docs/reference-golang#asdf_tool_name
A list of paths to search for Go https://www.pantsbuild.org/v2.14/docs/reference-golang#go_search_paths
[
"<PATH>"
]The minimum Go version the distribution discovered by Pants must support https://www.pantsbuild.org/v2.14/docs/reference-golang#minimum_expected_version
Environment variables to set when invoking the go tool
https://www.pantsbuild.org/v2.14/docs/reference-golang#subprocess_env_vars
[
"LANG",
"LC_CTYPE",
"LC_ALL",
"PATH"
]If true, add a go_binary target with the tailor goal in every directory with a .go file with package main
https://www.pantsbuild.org/v2.14/docs/reference-golang#tailor_binary_targets
If true, add a go_mod target with the tailor goal wherever there is a go.mod file
https://www.pantsbuild.org/v2.14/docs/reference-golang#tailor_go_mod_targets
If true, add a go_package target with the tailor goal in every directory with a .go file
https://www.pantsbuild.org/v2.14/docs/reference-golang#tailor_package_targets
Google Java Format (https://github.com/google/google-java-format)
6 nested properties
Use AOSP style instead of Google Style (4-space indentation). ("AOSP" is the Android Open Source Project.) https://www.pantsbuild.org/v2.14/docs/reference-google-java-format#aosp
Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.14/docs/reference-google-java-format#artifacts
[
"com.google.googlejavaformat:google-java-format:{version}"
]List of JVM options to pass to google-java-format JVM processes
https://www.pantsbuild.org/v2.14/docs/reference-google-java-format#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-google-java-format#lockfile
If true, don't use Google Java Format when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-google-java-format#skip
Version string for the tool https://www.pantsbuild.org/v2.14/docs/reference-google-java-format#version
Options for the explorer GraphQL API.
1 nested properties
Open a new web browser tab with GraphiQL https://www.pantsbuild.org/v2.14/docs/reference-graphql#open_graphiql
A linter for Dockerfiles.
9 nested properties
Arguments to pass directly to Hadolint, e.g. --hadolint-args='--format json'
https://www.pantsbuild.org/v2.14/docs/reference-hadolint#args
[]Path to an YAML config file understood by Hadolint (https://github.com/hadolint/hadolint#configure) https://www.pantsbuild.org/v2.14/docs/reference-hadolint#config
If true, Pants will include all relevant config files during runs (.hadolint.yaml and .hadolint.yml)
https://www.pantsbuild.org/v2.14/docs/reference-hadolint#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.14/docs/reference-hadolint#known_versions
[
"v2.10.0|macos_x86_64|59f0523069a857ae918b8ac0774230013f7bcc00c1ea28119c2311353120867a|2514960",
"v2.10.0|macos_arm64 |59f0523069a857ae918b8ac0774230013f7bcc00c1ea28119c2311353120867a|2514960",
"v2.10.0|linux_x86_64|8ee6ff537341681f9e91bae2d5da451b15c575691e33980893732d866d3cefc4|2301804",
"v2.10.0|linux_arm64 |b53d5ab10707a585c9e72375d51b7357522300b5329cfa3f91e482687176e128|27954520"
]If true, don't use Hadolint when running ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-hadolint#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.14/docs/reference-hadolint#url_platform_mapping
{
"linux_arm64": "Linux-arm64",
"linux_x86_64": "Linux-x86_64",
"macos_arm64": "Darwin-x86_64",
"macos_x86_64": "Darwin-x86_64"
}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.14/docs/reference-hadolint#url_template
What action to take in case the requested version of Hadolint is not supported https://www.pantsbuild.org/v2.14/docs/reference-hadolint#use_unsupported_version
Use this version of Hadolint https://www.pantsbuild.org/v2.14/docs/reference-hadolint#version
Display usage message.
Help for advanced options.
Print a JSON object containing all help info.
[Internal] Generate test lockfile fixtures for Pants tests.
The IPython enhanced REPL (https://ipython.org/).
6 nested properties
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-ipython#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-ipython#entry_point
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-ipython#extra_requirements
[]Whether to tell IPython not to put the CWD on the import path https://www.pantsbuild.org/v2.14/docs/reference-ipython#ignore_cwd
Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-ipython#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-ipython#version
The Python import sorter tool (https://pycqa.github.io/isort/).
11 nested properties
Arguments to pass directly to isort, e.g. --isort-args='--case-sensitive --trailing-comma'
https://www.pantsbuild.org/v2.14/docs/reference-isort#args
[]Path to config file understood by isort (https://pycqa.github.io/isort/docs/configuration/config_files/) https://www.pantsbuild.org/v2.14/docs/reference-isort#config
[]If true, Pants will include any relevant config files during runs (.isort.cfg, pyproject.toml, setup.cfg, tox.ini and .editorconfig)
https://www.pantsbuild.org/v2.14/docs/reference-isort#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-isort#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-isort#entry_point
If true, export a virtual environment with isort when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-isort#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-isort#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-isort#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-isort#lockfile
If true, don't use isort when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-isort#skip
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-isort#version
Dump source analysis for java_source[s] targets.
Options controlling which dependencies will be inferred for Java targets.
3 nested properties
Infer a target's dependencies by parsing consumed types from sources https://www.pantsbuild.org/v2.14/docs/reference-java-infer#consumed_types
Infer a target's dependencies by parsing import statements from sources https://www.pantsbuild.org/v2.14/docs/reference-java-infer#imports
A dictionary mapping a Java package path to a JVM artifact coordinate (GROUP:ARTIFACT) without the version https://www.pantsbuild.org/v2.14/docs/reference-java-infer#third_party_import_mapping
{}The javac Java source compiler.
2 nested properties
Arguments to pass directly to javac, e.g. --javac-args='-g -deprecation'
https://www.pantsbuild.org/v2.14/docs/reference-javac#args
[]If true, add java_sources and java_tests targets with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-javac#tailor_source_targets
The JUnit test framework (https://junit.org)
5 nested properties
Arguments to pass directly to JUnit, e.g. --junit-args='--disable-ansi-colors'
https://www.pantsbuild.org/v2.14/docs/reference-junit#args
[]Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.14/docs/reference-junit#artifacts
[
"org.junit.platform:junit-platform-console:1.7.2",
"org.junit.jupiter:junit-jupiter-engine:{version}",
"org.junit.vintage:junit-vintage-engine:{version}"
]List of JVM options to pass to junit JVM processes
https://www.pantsbuild.org/v2.14/docs/reference-junit#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-junit#lockfile
Version string for the tool https://www.pantsbuild.org/v2.14/docs/reference-junit#version
Options for general JVM functionality.
JDK strings will be passed directly to Coursier's --jvm parameter. Run cs java --available to see a list of available JVM versions on your platform.
If the string 'system' is passed, Coursier's --system-jvm option will be used instead, but note that this can lead to inconsistent behavior since the JVM version will be whatever happens to be found first on the system's PATH.
8 nested properties
Extra JVM arguments to use when running tests in debug mode https://www.pantsbuild.org/v2.14/docs/reference-jvm#debug_args
[]The default value used for the resolve and compatible_resolves fields
https://www.pantsbuild.org/v2.14/docs/reference-jvm#default_resolve
List of JVM options to pass to all JVM processes https://www.pantsbuild.org/v2.14/docs/reference-jvm#global_options
[]The JDK to use https://www.pantsbuild.org/v2.14/docs/reference-jvm#jdk
The time in milliseconds to delay speculation of nailgun processes while reading from the remote cache https://www.pantsbuild.org/v2.14/docs/reference-jvm#nailgun_remote_cache_speculation_delay
When enabled, JAR files produced by JVM tools will have timestamps stripped https://www.pantsbuild.org/v2.14/docs/reference-jvm#reproducible_jars
A dictionary mapping resolve names to the path of their lockfile https://www.pantsbuild.org/v2.14/docs/reference-jvm#resolves
{
"jvm-default": "3rdparty/jvm/default.lock"
}The JDK to use when building and running Pants' internal JVM support code and other non-compiler tools https://www.pantsbuild.org/v2.14/docs/reference-jvm#tool_jdk
Dump the JVM dependency inference symbol mapping.
Run all linters and/or formatters in check mode.
3 nested properties
The target number of files to be included in each linter batch https://www.pantsbuild.org/v2.14/docs/reference-lint#batch_size
Only run these linters and skip all others https://www.pantsbuild.org/v2.14/docs/reference-lint#only
[]If true, skip running all formatters in check-only mode https://www.pantsbuild.org/v2.14/docs/reference-lint#skip_formatters
Lists all targets matching the file or target arguments.
3 nested properties
Print only targets that are documented with a description https://www.pantsbuild.org/v2.14/docs/reference-list#documented
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-list#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.14/docs/reference-list#sep
The MyPy Python type checker (http://mypy-lang.org/).
14 nested properties
Arguments to pass directly to MyPy, e.g. --mypy-args='--python-version 3.7 --disallow-any-expr'
https://www.pantsbuild.org/v2.14/docs/reference-mypy#args
[]Path to a config file understood by MyPy (https://mypy.readthedocs.io/en/stable/config_file.html) https://www.pantsbuild.org/v2.14/docs/reference-mypy#config
If true, Pants will include any relevant config files during runs (mypy.ini, .mypy.ini, and setup.cfg)
https://www.pantsbuild.org/v2.14/docs/reference-mypy#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-mypy#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-mypy#entry_point
If true, export a virtual environment with MyPy when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-mypy#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-mypy#extra_requirements
[]Extra type stub requirements to install when running MyPy https://www.pantsbuild.org/v2.14/docs/reference-mypy#extra_type_stubs
[]Path to a lockfile for the option [mypy].extra_type_stubs
https://www.pantsbuild.org/v2.14/docs/reference-mypy#extra_type_stubs_lockfile
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-mypy#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-mypy#lockfile
If true, don't use MyPy when running ./pants check
https://www.pantsbuild.org/v2.14/docs/reference-mypy#skip
An optional list of python_sources target addresses to load first-party plugins
https://www.pantsbuild.org/v2.14/docs/reference-mypy#source_plugins
[]Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-mypy#version
Create a distributable package.
Options for Pants's release process.
1 nested properties
A dict from branch name to release notes rst-file location https://www.pantsbuild.org/v2.14/docs/reference-pants-releases#release_notes
{}List the paths between two addresses.
3 nested properties
The path starting address https://www.pantsbuild.org/v2.14/docs/reference-paths#from
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-paths#output_file
The path end address https://www.pantsbuild.org/v2.14/docs/reference-paths#to
Display BUILD target info
2 nested properties
Whether to leave off values that match the target-defined default values https://www.pantsbuild.org/v2.14/docs/reference-peek#exclude_defaults
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-peek#output_file
How Pants uses Pex to run Python subprocesses.
3 nested properties
The PATH value that will be used by the PEX subprocess and any subprocesses it spawns https://www.pantsbuild.org/v2.14/docs/reference-pex#executable_search_paths
[
"<PATH>"
]When possible, use venvs whose site-packages directories are populated with symlinks https://www.pantsbuild.org/v2.14/docs/reference-pex#venv_use_symlinks
Set the verbosity level of PEX logging, from 0 (no logging) up to 9 (max logging) https://www.pantsbuild.org/v2.14/docs/reference-pex#verbosity
Default settings for creating PEX executables.
2 nested properties
Whether built PEX binaries should emit PEX warnings at runtime by default https://www.pantsbuild.org/v2.14/docs/reference-pex-binary-defaults#emit_warnings
For each of the platforms specified for a pex_binary target, attempt to find a local interpreter that matches
https://www.pantsbuild.org/v2.14/docs/reference-pex-binary-defaults#resolve_local_platforms
The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex).
5 nested properties
Known versions to verify downloads against https://www.pantsbuild.org/v2.14/docs/reference-pex-cli#known_versions
[
"v2.1.108|macos_arm64|21d7803ef39203a6b2ae9f9e2678636e3c38ba17226ea33d6305f0683ab72e84|3848678",
"v2.1.108|macos_x86_64|21d7803ef39203a6b2ae9f9e2678636e3c38ba17226ea33d6305f0683ab72e84|3848678",
"v2.1.108|linux_x86_64|21d7803ef39203a6b2ae9f9e2678636e3c38ba17226ea33d6305f0683ab72e84|3848678",
"v2.1.108|linux_arm64|21d7803ef39203a6b2ae9f9e2678636e3c38ba17226ea33d6305f0683ab72e84|3848678"
]A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.14/docs/reference-pex-cli#url_platform_mapping
{}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.14/docs/reference-pex-cli#url_template
What action to take in case the requested version of pex is not supported https://www.pantsbuild.org/v2.14/docs/reference-pex-cli#use_unsupported_version
Use this version of pex https://www.pantsbuild.org/v2.14/docs/reference-pex-cli#version
Used to generate lockfiles for third-party Python dependencies (deprecated).
4 nested properties
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-poetry#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-poetry#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-poetry#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-poetry#version
Publish deliverables (assets, distributions, images, etc).
1 nested properties
Filename for JSON structured publish information https://www.pantsbuild.org/v2.14/docs/reference-publish#output
Determine what Python interpreter constraints are used by files/targets.
2 nested properties
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-py-constraints#output_file
Output a CSV summary of interpreter constraints for your whole repository https://www.pantsbuild.org/v2.14/docs/reference-py-constraints#summary
The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html).
Used with the pyoxidizer_binary target.
7 nested properties
Arguments to pass directly to PyOxidizer, e.g. --pyoxidizer-args='--release'
https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#args
[]The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#entry_point
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#interpreter_constraints
[
"CPython>=3.8,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-pyoxidizer#version
The pytest Python test framework (https://docs.pytest.org/).
12 nested properties
Arguments to pass directly to Pytest, e.g. --pytest-args='-k test_foo --quiet'
https://www.pantsbuild.org/v2.14/docs/reference-pytest#args
[]Path to a config file understood by Pytest (https://docs.pytest.org/en/latest/reference/customize.html#configuration-file-formats) https://www.pantsbuild.org/v2.14/docs/reference-pytest#config
If true, Pants will include all relevant Pytest config files (e.g. pytest.ini) during runs
https://www.pantsbuild.org/v2.14/docs/reference-pytest#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-pytest#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-pytest#entry_point
If a non-empty string, the process execution slot id (an integer) will be exposed to tests under this environment variable name https://www.pantsbuild.org/v2.14/docs/reference-pytest#execution_slot_var
If true, export a virtual environment with Pytest when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-pytest#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-pytest#extra_requirements
[
"pytest-cov>=2.12,!=2.12.1,<3.1",
"pytest-xdist>=2.5,<3"
]The format of generated junit XML files https://www.pantsbuild.org/v2.14/docs/reference-pytest#junit_family
Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-pytest#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-pytest#version
If true, Pants will use pytest-xdist (https://pytest-xdist.readthedocs.io/en/latest/) to parallelize tests within each python_test target
https://www.pantsbuild.org/v2.14/docs/reference-pytest#xdist_enabled
Options for Pants's Python backend.
19 nested properties
The default value used for the resolve field
https://www.pantsbuild.org/v2.14/docs/reference-python#default_resolve
The default value used for the run_goal_use_sandbox field of Python targets
https://www.pantsbuild.org/v2.14/docs/reference-python#default_run_goal_use_sandbox
Set to true to enable lockfiles for user code https://www.pantsbuild.org/v2.14/docs/reference-python#enable_resolves
The Python interpreters your codebase is compatible with https://www.pantsbuild.org/v2.14/docs/reference-python#interpreter_constraints
[
"CPython>=3.7,<4"
]All known Python major/minor interpreter versions that may be used by either your code or tools used by your code https://www.pantsbuild.org/v2.14/docs/reference-python#interpreter_versions_universe
[
"2.7",
"3.5",
"3.6",
"3.7",
"3.8",
"3.9",
"3.10",
"3.11"
]The behavior when a lockfile has requirements or interpreter constraints that are not compatible with what the current build is using https://www.pantsbuild.org/v2.14/docs/reference-python#invalid_lockfile_behavior
If set, and if running on MacOS Big Sur, use macosx_10_16 as the platform when building wheels https://www.pantsbuild.org/v2.14/docs/reference-python#macos_big_sur_compatibility
Whether to allow resolution of manylinux wheels when resolving requirements for foreign linux platforms https://www.pantsbuild.org/v2.14/docs/reference-python#resolver_manylinux
A mapping of logical names to lockfile paths used in your project https://www.pantsbuild.org/v2.14/docs/reference-python#resolves
{
"python-default": "3rdparty/python/default.lock"
}If False, Pants will not attempt to generate lockfiles for [python].resolves when running the generate-lockfiles goal
https://www.pantsbuild.org/v2.14/docs/reference-python#resolves_generate_lockfiles
When generating a resolve's lockfile, use a constraints file to pin the version of certain requirements https://www.pantsbuild.org/v2.14/docs/reference-python#resolves_to_constraints_file
{}Override the interpreter constraints to use when generating a resolve's lockfile with the generate-lockfiles goal
https://www.pantsbuild.org/v2.14/docs/reference-python#resolves_to_interpreter_constraints
{}When generating a resolve's lockfile, do not use binary packages (i.e. wheels) for these 3rdparty project names https://www.pantsbuild.org/v2.14/docs/reference-python#resolves_to_no_binary
{}When generating a resolve's lockfile, do not use source packages (i.e. sdists) for these 3rdparty project names, e.g ['django', 'requests']
https://www.pantsbuild.org/v2.14/docs/reference-python#resolves_to_only_binary
{}If enabled, when running binaries, tests, and repls, Pants will use the entire lockfile file instead of just the relevant subset https://www.pantsbuild.org/v2.14/docs/reference-python#run_against_entire_lockfile
If true, don't add python_sources targets for __init__.py files that are both empty and where there are no other Python files in the directory
https://www.pantsbuild.org/v2.14/docs/reference-python#tailor_ignore_empty_init_files
If true, add pex_binary targets for Python files named __main__.py or with a __main__ clause with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-python#tailor_pex_binary_targets
If true, add python_requirements, poetry_requirements, and pipenv_requirements target generators with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-python#tailor_requirements_targets
If true, add python_sources, python_tests, and python_test_utils targets with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-python#tailor_source_targets
Options used to locate Python interpreters used by all Pants backends.
This subsystem controls where and how Pants will locate Python, but beyond that it does not control which Python interpreter versions are actually used for your code: see the python subsystem for that.
2 nested properties
The names of Python binaries to search for https://www.pantsbuild.org/v2.14/docs/reference-python-bootstrap#names
[
"python",
"python3"
]A list of paths to search for Python interpreters https://www.pantsbuild.org/v2.14/docs/reference-python-bootstrap#search_path
[
"<PYENV>",
"<PATH>"
]Options controlling which dependencies will be inferred for Python targets.
9 nested properties
Infer a target's asset dependencies based on strings that look like Posix filepaths, such as those given to open or pkgutil.get_data
https://www.pantsbuild.org/v2.14/docs/reference-python-infer#assets
If --assets is True, treat valid-looking strings with at least this many forward slash characters as potential assets https://www.pantsbuild.org/v2.14/docs/reference-python-infer#assets_min_slashes
Infer a test target's dependencies on any conftest.py files in the current directory and ancestor directories https://www.pantsbuild.org/v2.14/docs/reference-python-infer#conftests
Infer dependencies on targets' entry points, e.g. pex_binary's entry_point field, python_awslambda's handler field and python_distribution's entry_points field
https://www.pantsbuild.org/v2.14/docs/reference-python-infer#entry_points
Infer a target's imported dependencies by parsing import statements from sources https://www.pantsbuild.org/v2.14/docs/reference-python-infer#imports
Infer a target's dependencies on any __init__.py files in the packages it is located in (recursively upward in the directory structure)
https://www.pantsbuild.org/v2.14/docs/reference-python-infer#init_files
Infer a target's dependencies based on strings that look like dynamic dependencies, such as Django settings files expressing dependencies as strings https://www.pantsbuild.org/v2.14/docs/reference-python-infer#string_imports
If --string-imports is True, treat valid-looking strings with at least this many dots in them as potential dynamic dependencies https://www.pantsbuild.org/v2.14/docs/reference-python-infer#string_imports_min_dots
How to handle imports that don't have an inferable owner https://www.pantsbuild.org/v2.14/docs/reference-python-infer#unowned_dependency_behavior
Options for building native code using Python, e.g. when resolving distributions.
2 nested properties
Override the CPPFLAGS environment variable for any forked subprocesses
https://www.pantsbuild.org/v2.14/docs/reference-python-native-code#cpp_flags
[]Override the LDFLAGS environment variable for any forked subprocesses
https://www.pantsbuild.org/v2.14/docs/reference-python-native-code#ld_flags
[]External Python code repositories, such as PyPI.
These options may be used to point to custom package indexes when resolving requirements.
3 nested properties
URLs and/or file paths corresponding to pip's --find-links option
https://www.pantsbuild.org/v2.14/docs/reference-python-repos#find_links
[]URLs of PEP-503 compatible code repository indexes to look for requirements https://www.pantsbuild.org/v2.14/docs/reference-python-repos#indexes
[
"https://pypi.org/simple/"
]Mappings to facilitate using local Python requirements when the absolute file paths are different on different users' machines https://www.pantsbuild.org/v2.14/docs/reference-python-repos#path_mappings
[]Lint your code using regex patterns, e.g. to check for copyright headers.
To activate this with the lint goal, you must set [regex-lint].config.
Unlike other linters, this can run on files not owned by targets, such as BUILD files.
2 nested properties
Config schema is as follows: https://www.pantsbuild.org/v2.14/docs/reference-regex-lint#config
{}How much detail to include in the result https://www.pantsbuild.org/v2.14/docs/reference-regex-lint#detail_level
Open a REPL with the specified code loadable.
2 nested properties
True if the REPL should be restarted if its inputs have changed https://www.pantsbuild.org/v2.14/docs/reference-repl#restartable
Override the automatically-detected REPL program for the target(s) specified https://www.pantsbuild.org/v2.14/docs/reference-repl#shell
List the repo's registered source roots.
2 nested properties
Output the goal's stdout to this file https://www.pantsbuild.org/v2.14/docs/reference-roots#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.14/docs/reference-roots#sep
Runs a binary target.
This goal propagates the return code of the underlying executable.
If your application can safely be restarted while it is running, you can pass restartable=True on your binary target (for supported types), and the run goal will automatically restart them as all relevant files change. This can be particularly useful for server applications.
3 nested properties
Arguments to pass directly to the executed target, e.g. --run-args='val1 val2 --debug'
https://www.pantsbuild.org/v2.14/docs/reference-run#args
[]Whether to clean up the temporary directory in which the binary is chrooted https://www.pantsbuild.org/v2.14/docs/reference-run#cleanup
Run the interactive process using a Debug Adapter (https://microsoft.github.io/debug-adapter-protocol/) for the language if supported https://www.pantsbuild.org/v2.14/docs/reference-run#debug_adapter
Scala programming language
2 nested properties
If true, add scala_sources, scala_junit_tests, and scalatest_tests targets with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-scala#tailor_source_targets
A dictionary mapping the name of a resolve to the Scala version to use for all Scala targets consuming that resolve https://www.pantsbuild.org/v2.14/docs/reference-scala#version_for_resolve
{}Dump source analysis for scala_source targets.
Options controlling which dependencies will be inferred for Scala targets.
4 nested properties
Infer a target's dependencies by parsing consumed types from sources https://www.pantsbuild.org/v2.14/docs/reference-scala-infer#consumed_types
If true, add a dependency on all scala_source targets generated by the same scala_sources target generator https://www.pantsbuild.org/v2.14/docs/reference-scala-infer#force_add_siblings_as_dependencies
Infer a target's dependencies by parsing import statements from sources https://www.pantsbuild.org/v2.14/docs/reference-scala-infer#imports
Add dependency on the package object to every target https://www.pantsbuild.org/v2.14/docs/reference-scala-infer#package_objects
The Scala compiler.
2 nested properties
Arguments to pass directly to scalac, e.g. --scalac-args='-encoding UTF-8'
https://www.pantsbuild.org/v2.14/docs/reference-scalac#args
[]A dictionary, whose keys are the names of each JVM resolve that requires default scalac plugins, and the value is a comma-separated string consisting of scalac plugin names
https://www.pantsbuild.org/v2.14/docs/reference-scalac#plugins_for_resolve
{}scalafmt (https://scalameta.org/scalafmt/)
5 nested properties
Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.14/docs/reference-scalafmt#artifacts
[
"org.scalameta:scalafmt-cli_2.13:{version}"
]List of JVM options to pass to scalafmt JVM processes
https://www.pantsbuild.org/v2.14/docs/reference-scalafmt#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-scalafmt#lockfile
If true, don't use scalafmt when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-scalafmt#skip
Version string for the tool https://www.pantsbuild.org/v2.14/docs/reference-scalafmt#version
The Scalatest test framework (https://www.scalatest.org/)
5 nested properties
Arguments to pass directly to Scalatest, e.g. --scalatest-args='-t $testname'
https://www.pantsbuild.org/v2.14/docs/reference-scalatest#args
[]Artifact requirements for this tool using specified as either the address of a jvm_artifact target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.14/docs/reference-scalatest#artifacts
[
"org.scalatest:scalatest_2.13:{version}"
]List of JVM options to pass to scalatest JVM processes
https://www.pantsbuild.org/v2.14/docs/reference-scalatest#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-scalatest#lockfile
Version string for the tool https://www.pantsbuild.org/v2.14/docs/reference-scalatest#version
The Succinct Code Counter, aka scc (https://github.com/boyter/scc).
6 nested properties
Arguments to pass directly to SCC, e.g. --scc-args='--no-cocomo'
https://www.pantsbuild.org/v2.14/docs/reference-scc#args
[]Known versions to verify downloads against https://www.pantsbuild.org/v2.14/docs/reference-scc#known_versions
[
"3.0.0|macos_arm64 |846cb1b25025a0794d455719bc17cfb3f588576a58af1d95036f6c654e294f98|2006145",
"3.0.0|macos_x86_64|9c3064e477ab36e16204ad34f649372034bca4df669615eff5de4aa05b2ddf1a|2048134",
"3.0.0|linux_arm64 |04f9e797b70a678833e49df5e744f95080dfb7f963c0cd34f5b5d4712d290f33|1768037",
"3.0.0|linux_x86_64|13ca47ce00b5bd032f97f3af7aa8eb3c717b8972b404b155a378b09110e4aa0c|1948341"
]A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.14/docs/reference-scc#url_platform_mapping
{
"linux_arm64": "arm64-unknown-linux",
"linux_x86_64": "x86_64-unknown-linux",
"macos_arm64": "arm64-apple-darwin",
"macos_x86_64": "x86_64-apple-darwin"
}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.14/docs/reference-scc#url_template
What action to take in case the requested version of SCC is not supported https://www.pantsbuild.org/v2.14/docs/reference-scc#use_unsupported_version
Use this version of SCC https://www.pantsbuild.org/v2.14/docs/reference-scc#version
Options to control how setup.py is generated from a python_distribution target.
2 nested properties
What version to set in install_requires when a python_distribution depends on other python_distributions
https://www.pantsbuild.org/v2.14/docs/reference-setup-py-generation#first_party_dependency_version_scheme
The default value for the generate_setup field on python_distribution targets
https://www.pantsbuild.org/v2.14/docs/reference-setup-py-generation#generate_setup_default
Python setuptools, used to package python_distribution targets.
3 nested properties
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools#extra_requirements
[
"wheel>=0.35.1,<0.38"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools#version
A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm).
6 nested properties
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools-scm#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools-scm#entry_point
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools-scm#extra_requirements
[]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools-scm#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools-scm#lockfile
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-setuptools-scm#version
Options for Pants's Shell support.
3 nested properties
Infer Shell dependencies on other Shell files by analyzing source statements
https://www.pantsbuild.org/v2.14/docs/reference-shell-setup#dependency_inference
The PATH value that will be used to find shells and to run certain processes like the shunit2 test runner https://www.pantsbuild.org/v2.14/docs/reference-shell-setup#executable_search_path
[
"<PATH>"
]If true, add shell_sources and shunit2_tests targets with the tailor goal
https://www.pantsbuild.org/v2.14/docs/reference-shell-setup#tailor
A linter for shell scripts.
8 nested properties
Arguments to pass directly to Shellcheck, e.g. --shellcheck-args='-e SC20529'
https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#args
[]If true, Pants will include all relevant .shellcheckrc and shellcheckrc files during runs
https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#known_versions
[
"v0.8.0|macos_arm64 |e065d4afb2620cc8c1d420a9b3e6243c84ff1a693c1ff0e38f279c8f31e86634|4049756",
"v0.8.0|macos_x86_64|e065d4afb2620cc8c1d420a9b3e6243c84ff1a693c1ff0e38f279c8f31e86634|4049756",
"v0.8.0|linux_arm64 |9f47bbff5624babfa712eb9d64ece14c6c46327122d0c54983f627ae3a30a4ac|2996468",
"v0.8.0|linux_x86_64|ab6ee1b178f014d1b86d1e24da20d1139656c8b0ed34d2867fbb834dad02bf0a|1403852"
]If true, don't use Shellcheck when running ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#url_platform_mapping
{
"linux_arm64": "linux.aarch64",
"linux_x86_64": "linux.x86_64",
"macos_arm64": "darwin.x86_64",
"macos_x86_64": "darwin.x86_64"
}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#url_template
What action to take in case the requested version of Shellcheck is not supported https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#use_unsupported_version
Use this version of Shellcheck https://www.pantsbuild.org/v2.14/docs/reference-shellcheck#version
An autoformatter for shell scripts (https://github.com/mvdan/sh).
8 nested properties
Arguments to pass directly to shfmt, e.g. --shfmt-args='-i 2'
https://www.pantsbuild.org/v2.14/docs/reference-shfmt#args
[]If true, Pants will include all relevant .editorconfig files during runs
https://www.pantsbuild.org/v2.14/docs/reference-shfmt#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.14/docs/reference-shfmt#known_versions
[
"v3.2.4|macos_arm64 |e70fc42e69debe3e400347d4f918630cdf4bf2537277d672bbc43490387508ec|2998546",
"v3.2.4|macos_x86_64|43a0461a1b54070ddc04fbbf1b78f7861ee39a65a61f5466d15a39c4aba4f917|2980208",
"v3.2.4|linux_arm64 |6474d9cc08a1c9fe2ef4be7a004951998e3067d46cf55a011ddd5ff7bfab3de6|2752512",
"v3.2.4|linux_x86_64|3f5a47f8fec27fae3e06d611559a2063f5d27e4b9501171dde9959b8c60a3538|2797568"
]If true, don't use shfmt when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-shfmt#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.14/docs/reference-shfmt#url_platform_mapping
{
"linux_arm64": "linux_arm64",
"linux_x86_64": "linux_amd64",
"macos_arm64": "darwin_arm64",
"macos_x86_64": "darwin_amd64"
}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.14/docs/reference-shfmt#url_template
What action to take in case the requested version of shfmt is not supported https://www.pantsbuild.org/v2.14/docs/reference-shfmt#use_unsupported_version
Use this version of shfmt https://www.pantsbuild.org/v2.14/docs/reference-shfmt#version
Configuration for roots of source trees.
2 nested properties
The presence of a file of this name in a directory indicates that the directory is a source root https://www.pantsbuild.org/v2.14/docs/reference-source#marker_filenames
[]A list of source root suffixes https://www.pantsbuild.org/v2.14/docs/reference-source#root_patterns
[
"/",
"src",
"src/python",
"src/py",
"src/thrift",
"src/protobuf",
"src/protos",
"src/scala",
"src/java"
]An aggregator for Pants stats, such as cache metrics.
2 nested properties
At the end of the Pants run, log all counter metrics and summaries of observation histograms, e.g. the number of cache hits and the time saved by caching https://www.pantsbuild.org/v2.14/docs/reference-stats#log
At the end of the Pants run, report a summary of memory usage https://www.pantsbuild.org/v2.14/docs/reference-stats#memory_summary
Environment settings for forked subprocesses.
1 nested properties
Environment variables to set for process invocations https://www.pantsbuild.org/v2.14/docs/reference-subprocess-environment#env_vars
[
"LANG",
"LC_CTYPE",
"LC_ALL",
"SSL_CERT_FILE",
"SSL_CERT_DIR"
]Auto-generate BUILD file targets for new source files.
Each specific tailor implementation may be disabled through language-specific options, e.g. [python].tailor_pex_binary_targets and [shell-setup].tailor.
7 nested properties
A mapping from standard target type to custom type to use instead https://www.pantsbuild.org/v2.14/docs/reference-tailor#alias_mapping
{}A header, e.g., a copyright notice, to add to the content of created BUILD files https://www.pantsbuild.org/v2.14/docs/reference-tailor#build_file_header
The indent to use when auto-editing BUILD files https://www.pantsbuild.org/v2.14/docs/reference-tailor#build_file_indent
The name to use for generated BUILD files https://www.pantsbuild.org/v2.14/docs/reference-tailor#build_file_name
Do not write changes to disk, only write back what would change https://www.pantsbuild.org/v2.14/docs/reference-tailor#check
Do not add these target definitions https://www.pantsbuild.org/v2.14/docs/reference-tailor#ignore_adding_targets
[]Do not edit or create BUILD files at these paths https://www.pantsbuild.org/v2.14/docs/reference-tailor#ignore_paths
[]Run tests.
13 nested properties
Run tests sequentially in an interactive process https://www.pantsbuild.org/v2.14/docs/reference-test#debug
Run tests sequentially in an interactive process, using a Debug Adapter (https://microsoft.github.io/debug-adapter-protocol/) for the language if supported https://www.pantsbuild.org/v2.14/docs/reference-test#debug_adapter
Additional environment variables to include in test processes https://www.pantsbuild.org/v2.14/docs/reference-test#extra_env_vars
[]Force the tests to run, even if they could be satisfied from cache https://www.pantsbuild.org/v2.14/docs/reference-test#force
If a coverage report file is generated, open it on the local system if the system supports this https://www.pantsbuild.org/v2.14/docs/reference-test#open_coverage
Show stdout/stderr for these tests https://www.pantsbuild.org/v2.14/docs/reference-test#output
Write test reports to --report-dir https://www.pantsbuild.org/v2.14/docs/reference-test#report
Path to write test reports to https://www.pantsbuild.org/v2.14/docs/reference-test#report_dir
A shard specification of the form "k/N", where N is a positive integer and k is a non-negative integer less than N https://www.pantsbuild.org/v2.14/docs/reference-test#shard
The default timeout (in seconds) for a test target if the timeout field is not set on the target
https://www.pantsbuild.org/v2.14/docs/reference-test#timeout_default
The maximum timeout (in seconds) that may be used on a test target https://www.pantsbuild.org/v2.14/docs/reference-test#timeout_maximum
Enable test target timeouts https://www.pantsbuild.org/v2.14/docs/reference-test#timeouts
Generate a coverage report if the test runner supports it https://www.pantsbuild.org/v2.14/docs/reference-test#use_coverage
Setup specific to the Toolchain codebase.
3 nested properties
Toolchain base url https://www.pantsbuild.org/v2.14/docs/reference-toolchain-setup#base_url
The organization name on your Toolchain account (typically the same as the org name in GitHub) https://www.pantsbuild.org/v2.14/docs/reference-toolchain-setup#org
The name of this repo (typically its name in GitHub) https://www.pantsbuild.org/v2.14/docs/reference-toolchain-setup#repo
The utility for publishing Python distributions to PyPI and other Python repositories.
11 nested properties
Arguments to pass directly to Twine, e.g. --twine-args='--skip-existing'
https://www.pantsbuild.org/v2.14/docs/reference-twine#args
[]Path to a file containing PEM-format CA certificates used for verifying secure connections when publishing python distributions https://www.pantsbuild.org/v2.14/docs/reference-twine#ca_certs_path
Path to a .pypirc config file to use. (https://packaging.python.org/specifications/pypirc/) https://www.pantsbuild.org/v2.14/docs/reference-twine#config
If true, Pants will include all relevant config files during runs (.pypirc)
https://www.pantsbuild.org/v2.14/docs/reference-twine#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-twine#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-twine#entry_point
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-twine#extra_requirements
[
"colorama>=0.4.3"
]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-twine#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-twine#lockfile
If true, don't use Twine when running ./pants publish
https://www.pantsbuild.org/v2.14/docs/reference-twine#skip
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-twine#version
Format and fix safe deprecations in BUILD files.
This does not handle the full Pants upgrade. You must still manually change pants_version in pants.toml and you may need to manually address some deprecations. See https://www.pantsbuild.org/v2.14/docs/upgrade-tips for upgrade tips.
This goal is run without arguments. It will run over all BUILD files in your project.
4 nested properties
Do not write changes to disk, only write back what would change https://www.pantsbuild.org/v2.14/docs/reference-update-build-files#check
Automatically fix deprecations, such as target type renames, that are safe because they do not change semantics https://www.pantsbuild.org/v2.14/docs/reference-update-build-files#fix_safe_deprecations
Format BUILD files using Black or Yapf https://www.pantsbuild.org/v2.14/docs/reference-update-build-files#fmt
Which formatter Pants should use to format BUILD files https://www.pantsbuild.org/v2.14/docs/reference-update-build-files#formatter
Display Pants version.
A formatter for Python files (https://github.com/google/yapf).
11 nested properties
Arguments to pass directly to yapf, e.g. --yapf-args='--no-local-style'
https://www.pantsbuild.org/v2.14/docs/reference-yapf#args
[]Path to style file understood by yapf (https://github.com/google/yapf#formatting-style/) https://www.pantsbuild.org/v2.14/docs/reference-yapf#config
If true, Pants will include any relevant config files during runs (.style.yapf, pyproject.toml, and setup.cfg)
https://www.pantsbuild.org/v2.14/docs/reference-yapf#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.14/docs/reference-yapf#console_script
The entry point for the tool https://www.pantsbuild.org/v2.14/docs/reference-yapf#entry_point
If true, export a virtual environment with yapf when running ./pants export
https://www.pantsbuild.org/v2.14/docs/reference-yapf#export
Any additional requirement strings to use with the tool https://www.pantsbuild.org/v2.14/docs/reference-yapf#extra_requirements
[
"toml"
]Python interpreter constraints for this tool https://www.pantsbuild.org/v2.14/docs/reference-yapf#interpreter_constraints
[
"CPython>=3.7,<4"
]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.14/docs/reference-yapf#lockfile
If true, don't use yapf when running ./pants fmt and ./pants lint
https://www.pantsbuild.org/v2.14/docs/reference-yapf#skip
Requirement string for the tool https://www.pantsbuild.org/v2.14/docs/reference-yapf#version