Pantsbuild
2.24.0Schema URL
Pants configuration file schema: https://www.pantsbuild.org/
Properties
Options to control the overall behavior of Pants.
100 nested properties
Silence warnings/errors about running Pants on these versions of macOS. Pants only supports recent versions of macOS. You can try running on older versions, but it may or may not work https://www.pantsbuild.org/v2.24/docs/reference-global#allow_deprecated_macos_versions
[]Register functionality from these backends https://www.pantsbuild.org/v2.24/docs/reference-global#backend_packages
[]Python files to evaluate and whose symbols should be exposed to all BUILD files https://www.pantsbuild.org/v2.24/docs/reference-global#build_file_prelude_globs
[]Path globs or literals to ignore when identifying BUILD files https://www.pantsbuild.org/v2.24/docs/reference-global#build_ignore
[]The naming scheme for BUILD files, i.e. where you define targets https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#ca_certs_path
Controls how the content of cache entries is handled during process execution https://www.pantsbuild.org/v2.24/docs/reference-global#cache_content_behavior
Whether Pants should use colors in output or not https://www.pantsbuild.org/v2.24/docs/reference-global#colors
Enable concurrent runs of Pants https://www.pantsbuild.org/v2.24/docs/reference-global#concurrent
If true, docker_environment targets can be used to run builds inside a Docker container
https://www.pantsbuild.org/v2.24/docs/reference-global#docker_execution
Display a dynamically-updating console UI as Pants runs https://www.pantsbuild.org/v2.24/docs/reference-global#dynamic_ui
If --dynamic-ui is enabled, selects the renderer
https://www.pantsbuild.org/v2.24/docs/reference-global#dynamic_ui_renderer
Enable fine grained target analysis based on line numbers https://www.pantsbuild.org/v2.24/docs/reference-global#enable_target_origin_sources_blocks
A directory to write execution and rule graphs to as dot files
https://www.pantsbuild.org/v2.24/docs/reference-global#engine_visualize_to
When Pants downloads files (for example, for the http_source source), Pants will retry the download if a "retryable" error occurs
https://www.pantsbuild.org/v2.24/docs/reference-global#file_downloads_max_attempts
When Pants downloads files (for example, for the http_source source), Pants will retry the download if a "retryable" error occurs
https://www.pantsbuild.org/v2.24/docs/reference-global#file_downloads_retry_delay
Ignore logs and warnings matching these strings https://www.pantsbuild.org/v2.24/docs/reference-global#ignore_warnings
[]Controls whether Pants will clean up local directories used as chroots for running processes https://www.pantsbuild.org/v2.24/docs/reference-global#keep_sandboxes
Set the logging level https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#local_cache
Directory to use for local process execution sandboxing https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#local_store_dir
The maximum size in bytes of the local store containing directories https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-global#local_store_processes_max_size_bytes
The number of LMDB shards created for the local store https://www.pantsbuild.org/v2.24/docs/reference-global#local_store_shard_count
Set a more specific logging level for one or more logging targets https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#log_show_rust_3rdparty
Write logs to files under this directory https://www.pantsbuild.org/v2.24/docs/reference-global#logdir
Run goals continuously as file changes are detected https://www.pantsbuild.org/v2.24/docs/reference-global#loop
The maximum number of times to loop when --loop is specified
https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#named_caches_dir
Pants is switching its option parsing system from a legacy parser written in Python to a new one written in Rust https://www.pantsbuild.org/v2.24/docs/reference-global#native_options_validation
The name of the script or binary used to invoke Pants https://www.pantsbuild.org/v2.24/docs/reference-global#pants_bin_name
Paths to Pants config files https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#pants_distdir
Paths to ignore for all filesystem operations performed by pants (e.g https://www.pantsbuild.org/v2.24/docs/reference-global#pants_ignore
[
".*/",
"/dist/",
"__pycache__",
"!.semgrep/",
"!.github/"
]Include patterns from .gitignore, .git/info/exclude, and the global gitignore files in the option [GLOBAL].pants_ignore, which is used for Pants to ignore filesystem operations on those patterns
https://www.pantsbuild.org/v2.24/docs/reference-global#pants_ignore_use_gitignore
When set, a base directory in which to store --pants-workdir contents
https://www.pantsbuild.org/v2.24/docs/reference-global#pants_physical_workdir_base
The directory to use for tracking subprocess metadata https://www.pantsbuild.org/v2.24/docs/reference-global#pants_subprocessdir
Use this Pants version https://www.pantsbuild.org/v2.24/docs/reference-global#pants_version
Write intermediate logs and output files to this dir https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#pantsd
Filesystem events matching any of these globs will trigger a daemon restart https://www.pantsbuild.org/v2.24/docs/reference-global#pantsd_invalidation_globs
[]The maximum memory usage of the pantsd process https://www.pantsbuild.org/v2.24/docs/reference-global#pantsd_max_memory_usage
The port to bind the Pants nailgun server to https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-global#pantsrc
Override config with values from these files, using syntax matching that of --pants-config-files
https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#plugins
[]Re-resolve plugins, even if previously resolved https://www.pantsbuild.org/v2.24/docs/reference-global#plugins_force_resolve
Print the full exception stack trace for any errors https://www.pantsbuild.org/v2.24/docs/reference-global#print_stacktrace
The cache namespace for process execution https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-global#process_execution_local_enable_nailgun
Number of concurrent processes that may be executed locally https://www.pantsbuild.org/v2.24/docs/reference-global#process_execution_local_parallelism
Number of concurrent processes that may be executed remotely https://www.pantsbuild.org/v2.24/docs/reference-global#process_execution_remote_parallelism
The default memory usage for a single "pooled" child process https://www.pantsbuild.org/v2.24/docs/reference-global#process_per_child_memory_usage
The maximum memory usage for all "pooled" child processes https://www.pantsbuild.org/v2.24/docs/reference-global#process_total_child_memory_usage
Add these directories to PYTHONPATH to search for plugins https://www.pantsbuild.org/v2.24/docs/reference-global#pythonpath
[]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.24/docs/reference-global#remote_ca_certs_path
Whether to enable reading from a remote cache https://www.pantsbuild.org/v2.24/docs/reference-global#remote_cache_read
The number of concurrent requests allowed to the remote cache service https://www.pantsbuild.org/v2.24/docs/reference-global#remote_cache_rpc_concurrency
Timeout value for remote cache RPCs in milliseconds https://www.pantsbuild.org/v2.24/docs/reference-global#remote_cache_rpc_timeout_millis
How frequently to log remote cache failures at the warn log level
https://www.pantsbuild.org/v2.24/docs/reference-global#remote_cache_warnings
Whether to enable writing results to a remote cache https://www.pantsbuild.org/v2.24/docs/reference-global#remote_cache_write
Path to a PEM file containing client certificates used for verifying secure connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address when using client authentication (mTLS)
https://www.pantsbuild.org/v2.24/docs/reference-global#remote_client_certs_path
Path to a PEM file containing a private key used for verifying secure connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address when using client authentication (mTLS)
https://www.pantsbuild.org/v2.24/docs/reference-global#remote_client_key_path
Enables remote workers for increased parallelism. (Alpha) https://www.pantsbuild.org/v2.24/docs/reference-global#remote_execution
The URI of a server/entity used as a remote execution scheduler https://www.pantsbuild.org/v2.24/docs/reference-global#remote_execution_address
Sets the base path to use when setting up an append-only cache for a process running remotely https://www.pantsbuild.org/v2.24/docs/reference-global#remote_execution_append_only_caches_base_path
Platform properties to set on remote execution requests https://www.pantsbuild.org/v2.24/docs/reference-global#remote_execution_extra_platform_properties
[]Headers to set on remote execution requests https://www.pantsbuild.org/v2.24/docs/reference-global#remote_execution_headers
Overall timeout in seconds for each remote execution request from time of submission https://www.pantsbuild.org/v2.24/docs/reference-global#remote_execution_overall_deadline_secs
The number of concurrent requests allowed to the remote execution service https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#remote_instance_name
An oauth token to use for gGRPC connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address
https://www.pantsbuild.org/v2.24/docs/reference-global#remote_oauth_bearer_token
The type of provider to use, if using a remote cache and/or remote execution, See https://www.pantsbuild.org/2.24/docs/using-pants/remote-caching-and-execution for details https://www.pantsbuild.org/v2.24/docs/reference-global#remote_provider
The URI of a server/entity used as a remote file store https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-global#remote_store_chunk_bytes
Headers to set on remote store requests https://www.pantsbuild.org/v2.24/docs/reference-global#remote_store_headers
The number of concurrent requests allowed to the remote store service https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#remote_store_rpc_retries
Timeout value for remote store RPCs (not including streaming requests) in milliseconds https://www.pantsbuild.org/v2.24/docs/reference-global#remote_store_rpc_timeout_millis
The number of threads to keep active and ready to execute @rule logic (see also: --rule-threads-max)
https://www.pantsbuild.org/v2.24/docs/reference-global#rule_threads_core
The maximum number of threads to use to execute @rule logic
https://www.pantsbuild.org/v2.24/docs/reference-global#rule_threads_max
The time in seconds to wait for still-running "session end" tasks to complete before finishing completion of a Pants invocation. "Session end" tasks include, for example, writing data that was generated during the applicable Pants invocation to a configured remote cache https://www.pantsbuild.org/v2.24/docs/reference-global#session_end_tasks_timeout
Display the target where a log message originates in that log message's output https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#spec_files
[]Option scopes to record in stats on run completion https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-global#streaming_workunits_level
Interval in seconds between when streaming workunit event receivers will be polled https://www.pantsbuild.org/v2.24/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.24/docs/reference-global#subproject_roots
[]Include only targets with these tags (optional '+' prefix) or without these tags ('-' prefix) https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-global#unmatched_cli_globs
Verify that all config file values correspond to known options https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-anonymous-telemetry#enabled
An anonymized ID representing this repo https://www.pantsbuild.org/v2.24/docs/reference-anonymous-telemetry#repo_id
The Autoflake Python code formatter (https://github.com/myint/autoflake).
This version of Pants uses autoflake version 2.3.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
7 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.24/docs/reference-autoflake#args
[
"--remove-all-unused-imports"
]The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-autoflake#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-autoflake#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-autoflake#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-autoflake#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-autoflake#requirements
[]If true, don't use Autoflake when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-autoflake#skip
The Black Python code formatter (https://black.readthedocs.io/).
This version of Pants uses black version 23.12.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
9 nested properties
Arguments to pass directly to Black, e.g. --black-args='--target-version=py37 --quiet'
https://www.pantsbuild.org/v2.24/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.24/docs/reference-black#config
If true, Pants will include any relevant pyproject.toml config files during runs https://www.pantsbuild.org/v2.24/docs/reference-black#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-black#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-black#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-black#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-black#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-black#requirements
[]If true, don't use Black when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-black#skip
A tool/plugin for fixing BUILD file deprecations (where possible).
This includes deprecations for:
- Renamed targets
- Renamed fields
1 nested properties
If true, don't use BUILD Deprecations Fixer when running pants fix
https://www.pantsbuild.org/v2.24/docs/reference-build-deprecations-fixer#skip
Buildifier is a tool for formatting BUILD files with a standard convention.
Pants supports running Buildifier on your Pants BUILD files for several reasons:
- You might like the style that buildifier uses.
- You might be incrementally adopting Pants from Bazel, and are already using buildifier.
Please note that there are differences from Bazel's BUILD files (which are Starlark) and Pants' BUILD files (which are Python), so buildifier may issue a syntax error. In practice, these errors should be rare. See https://bazel.build/rules/language#differences_with_python.
7 nested properties
Arguments to pass directly to Buildifier, e.g. --buildifier-args='-lint=fix'
https://www.pantsbuild.org/v2.24/docs/reference-buildifier#args
[]Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-buildifier#known_versions
[
"7.1.2|macos_x86_64|687c49c318fb655970cf716eed3c7bfc9caeea4f2931a2fd36593c458de0c537|7591232",
"7.1.2|macos_arm64 |d0909b645496608fd6dfc67f95d9d3b01d90736d7b8c8ec41e802cb0b7ceae7c|7528994",
"7.1.2|linux_x86_64|28285fe7e39ed23dc1a3a525dfcdccbc96c0034ff1d4277905d2672a71b38f13|7702060",
"7.1.2|linux_arm64 |c22a44eee37b8927167ee6ee67573303f4e31171e7ec3a8ea021a6a660040437|7568336"
]If true, don't use Buildifier when running pants fmt
https://www.pantsbuild.org/v2.24/docs/reference-buildifier#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.24/docs/reference-buildifier#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.24/docs/reference-buildifier#url_template
What action to take in case the requested version of Buildifier is not supported https://www.pantsbuild.org/v2.24/docs/reference-buildifier#use_unsupported_version
Use this version of Buildifier https://www.pantsbuild.org/v2.24/docs/reference-buildifier#version
Tell Pants to detect what files and targets have changed from Git.
See https://www.pantsbuild.org/2.24/docs/using-pants/advanced-target-selection.
3 nested properties
Include direct or transitive dependents of changed targets https://www.pantsbuild.org/v2.24/docs/reference-changed#dependents
Calculate changes contained within a given Git spec (commit range/SHA/ref) https://www.pantsbuild.org/v2.24/docs/reference-changed#diffspec
Calculate changes since this Git spec (commit range/SHA/ref) https://www.pantsbuild.org/v2.24/docs/reference-changed#since
Run type checking or the lightest variant of compilation available for a language.
1 nested properties
Only run these checkers and skip all others https://www.pantsbuild.org/v2.24/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.24/docs/reference-cli#alias
{}Generates a completion script for the specified shell. The script is printed to stdout.
For example, pants complete --shell=zsh > pants-completions.zsh will generate a zsh completion script and write it to the file my-pants-completions.zsh. You can then source this file in your .zshrc file to enable completion for Pants.
This command is also used by the completion scripts to generate the completion options using passthrough options. This usage is not intended for use by end users, but could be useful for building custom completion scripts.
An example of this usage is in the bash completion script, where we use the following command: pants complete -- ${COMP_WORDS[@]}. This will generate the completion options for the current args, and then pass them to the bash completion script.
1 nested properties
Which shell completion type should be printed to stdout https://www.pantsbuild.org/v2.24/docs/reference-complete#shell
Count lines of code.
A dependency resolver for the Maven ecosystem. (https://get-coursier.io/)
7 nested properties
The JVM index to be used by Coursier https://www.pantsbuild.org/v2.24/docs/reference-coursier#jvm_index
Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-coursier#known_versions
[
"v2.1.6|macos_arm64 |746b3e346fa2c0107fdbc8a627890d495cb09dee4f8dcc87146bdb45941088cf|20829782|https://github.com/VirtusLab/coursier-m1/releases/download/v2.1.6/cs-aarch64-apple-darwin.gz",
"v2.1.6|linux_arm64 |33330ca433781c9db9458e15d2d32e5d795de3437771647e26835e8b1391af82|20899290|https://github.com/VirtusLab/coursier-m1/releases/download/v2.1.6/cs-aarch64-pc-linux.gz",
"v2.1.6|linux_x86_64|af7234f8802107f5e1130307ef8a5cc90262d392f16ddff7dce27a4ed0ddd292|20681688",
"v2.1.6|macos_x86_64|36a5d42a0724be2ac39d0ebd8869b985e3d58ceb121bc60389ee2d6d7408dd56|20037412",
"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.24/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.24/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.24/docs/reference-coursier#url_template
What action to take in case the requested version of coursier is not supported https://www.pantsbuild.org/v2.24/docs/reference-coursier#use_unsupported_version
Use this version of coursier https://www.pantsbuild.org/v2.24/docs/reference-coursier#version
Configuration for Python test coverage measurement.
This version of Pants uses coverage version 7.6.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
12 nested properties
Path to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/latest/config.html) https://www.pantsbuild.org/v2.24/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.24/docs/reference-coverage-py#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#entry_point
Fail if the total combined coverage percentage for all tests is less than this number https://www.pantsbuild.org/v2.24/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.24/docs/reference-coverage-py#filter
[]If true, Pants will generate a global coverage report https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#global_report
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#interpreter_constraints
[
"CPython>=3.8,<4"
]Path to write the Pytest Coverage report to https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#output_dir
Which coverage report type(s) to emit https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#report
[
"console"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-coverage-py#requirements
[]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.24/docs/reference-debug-adapter#host
The port to use when launching the server https://www.pantsbuild.org/v2.24/docs/reference-debug-adapter#port
An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).
This version of Pants uses debugpy version 1.6.7.post1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
6 nested properties
Arguments to pass directly to debugpy, e.g. --debugpy-args='--log-to-stderr'
https://www.pantsbuild.org/v2.24/docs/reference-debugpy#args
[]The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-debugpy#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-debugpy#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-debugpy#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-debugpy#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-debugpy#requirements
[]List the dependencies of the input files/targets.
5 nested properties
Include the input targets in the output, along with the dependencies https://www.pantsbuild.org/v2.24/docs/reference-dependencies#closed
Output format for listing dependencies https://www.pantsbuild.org/v2.24/docs/reference-dependencies#format
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-dependencies#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.24/docs/reference-dependencies#sep
List all transitive dependencies https://www.pantsbuild.org/v2.24/docs/reference-dependencies#transitive
List all targets that depend on any of the input files/targets.
5 nested properties
Include the input targets in the output, along with the dependents https://www.pantsbuild.org/v2.24/docs/reference-dependents#closed
Output format for listing dependents https://www.pantsbuild.org/v2.24/docs/reference-dependents#format
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-dependents#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.24/docs/reference-dependents#sep
List all transitive dependents https://www.pantsbuild.org/v2.24/docs/reference-dependents#transitive
The Python docformatter tool (https://github.com/myint/docformatter).
This version of Pants uses docformatter version 1.4 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
7 nested properties
Arguments to pass directly to docformatter, e.g. --docformatter-args='--wrap-summaries=100 --pre-summary-newline'
https://www.pantsbuild.org/v2.24/docs/reference-docformatter#args
[]The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-docformatter#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-docformatter#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-docformatter#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-docformatter#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-docformatter#requirements
[]If true, don't use docformatter when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-docformatter#skip
Options for interacting with Docker.
15 nested properties
Global build arguments (for Docker --build-arg options) to use for all docker build invocations
https://www.pantsbuild.org/v2.24/docs/reference-docker#build_args
[]Hosts entries to be added to the /etc/hosts file in all built images
https://www.pantsbuild.org/v2.24/docs/reference-docker#build_hosts
{}Do not use the Docker cache when building images https://www.pantsbuild.org/v2.24/docs/reference-docker#build_no_cache
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.24/docs/reference-docker#build_target_stage
Whether to log the Docker output to the console https://www.pantsbuild.org/v2.24/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.24/docs/reference-docker#default_context_root
Configure the default repository name used in the Docker image tag https://www.pantsbuild.org/v2.24/docs/reference-docker#default_repository
Environment variables to set for docker invocations
https://www.pantsbuild.org/v2.24/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.24/docs/reference-docker#executable_search_paths
[
"<PATH>"
]List any additional executables which are not mandatory for Docker to work, but which should be included if available https://www.pantsbuild.org/v2.24/docs/reference-docker#optional_tools
[]Configure Docker registries https://www.pantsbuild.org/v2.24/docs/reference-docker#registries
{}Additional arguments to use for docker run invocations
https://www.pantsbuild.org/v2.24/docs/reference-docker#run_args
[]If true, add docker_image targets with the tailor goal
https://www.pantsbuild.org/v2.24/docs/reference-docker#tailor
List any additional executable tools required for Docker to work https://www.pantsbuild.org/v2.24/docs/reference-docker#tools
[]Use buildx (and BuildKit) for builds https://www.pantsbuild.org/v2.24/docs/reference-docker#use_buildx
Used to parse Dockerfile build specs to infer their dependencies.
This version of Pants uses dockerfile version 3.3.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
4 nested properties
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-dockerfile-parser#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-dockerfile-parser#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-dockerfile-parser#requirements
[]Use the new experimental Rust-based, multithreaded, in-process dependency parser https://www.pantsbuild.org/v2.24/docs/reference-dockerfile-parser#use_rust_parser
A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux.
1 nested properties
A mapping of logical names to addresses to environment targets https://www.pantsbuild.org/v2.24/docs/reference-environments-preview#names
{}Perform a deployment process.
2 nested properties
If true, perform a dry run without deploying anything https://www.pantsbuild.org/v2.24/docs/reference-experimental-deploy#dry_run
If false, don't publish target dependencies before deploying the target https://www.pantsbuild.org/v2.24/docs/reference-experimental-deploy#publish_dependencies
Run the Pants Explorer Web UI server.
2 nested properties
Server address to bind to https://www.pantsbuild.org/v2.24/docs/reference-experimental-explorer#address
Server port to bind to https://www.pantsbuild.org/v2.24/docs/reference-experimental-explorer#port
Export Pants data for use in other tools, such as IDEs.
:::caution Exporting tools requires creating a custom lockfile for them
Follow the instructions for creating tool lockfiles
:::
6 nested properties
Export the specified binaries https://www.pantsbuild.org/v2.24/docs/reference-export#bin
[]When exporting a mutable virtualenv for a resolve, do PEP-660 editable installs of all python_distribution targets that own code in the exported resolve
https://www.pantsbuild.org/v2.24/docs/reference-export#py_editable_in_resolve
[]When exporting a mutable virtualenv for a resolve listed in this option, generate sources which result from code generation (for example, the protobuf_sources and thrift_sources target types) into the mutable virtualenv exported for that resolve
https://www.pantsbuild.org/v2.24/docs/reference-export#py_generated_sources_in_resolve
[]When exporting a mutable virtualenv for a resolve listed in this option, by default console script shebang lines will be made "hermetic" https://www.pantsbuild.org/v2.24/docs/reference-export#py_non_hermetic_scripts_in_resolve
[]Export Python resolves using this format https://www.pantsbuild.org/v2.24/docs/reference-export#py_resolve_format
Export the specified resolve(s) https://www.pantsbuild.org/v2.24/docs/reference-export#resolve
[]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.24/docs/reference-filedeps#absolute
Instead of outputting filenames, output the original globs used in the BUILD file https://www.pantsbuild.org/v2.24/docs/reference-filedeps#globs
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-filedeps#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.24/docs/reference-filedeps#sep
If True, list files from all dependencies, including transitive dependencies https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-filter#granularity
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-filter#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.24/docs/reference-filter#sep
Filter on targets with tags matching these regexes https://www.pantsbuild.org/v2.24/docs/reference-filter#tag_regex
[]Filter on these target types, e.g. resources or python_sources
https://www.pantsbuild.org/v2.24/docs/reference-filter#target_type
[]Autofix source code.
3 nested properties
The target number of files to be included in each fixer batch https://www.pantsbuild.org/v2.24/docs/reference-fix#batch_size
Only run these fixers and skip all others https://www.pantsbuild.org/v2.24/docs/reference-fix#only
[]If true, skip running all formatters https://www.pantsbuild.org/v2.24/docs/reference-fix#skip_formatters
The Flake8 Python linter (https://flake8.pycqa.org/).
This version of Pants uses flake8 version 5.0.4 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
10 nested properties
Arguments to pass directly to Flake8, e.g. --flake8-args='--ignore E123,W456 --enable-extensions H111'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-flake8#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-flake8#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-flake8#entry_point
Paths to extra files to include in the sandbox https://www.pantsbuild.org/v2.24/docs/reference-flake8#extra_files
[]If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-flake8#install_from_resolve
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-flake8#requirements
[]If true, don't use Flake8 when running pants lint
https://www.pantsbuild.org/v2.24/docs/reference-flake8#skip
An optional list of python_sources target addresses to load first-party plugins
https://www.pantsbuild.org/v2.24/docs/reference-flake8#source_plugins
[]Autoformat source code.
2 nested properties
The target number of files to be included in each formatter batch https://www.pantsbuild.org/v2.24/docs/reference-fmt#batch_size
Only run these formatters and skip all others https://www.pantsbuild.org/v2.24/docs/reference-fmt#only
[]Generate lockfiles for third-party dependencies.
4 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.24/docs/reference-generate-lockfiles#custom_command
Print a summary of changed distributions after generating the lockfile https://www.pantsbuild.org/v2.24/docs/reference-generate-lockfiles#diff
Include unchanged distributions in the diff summary output https://www.pantsbuild.org/v2.24/docs/reference-generate-lockfiles#diff_include_unchanged
Only generate lockfiles for the specified resolve(s) https://www.pantsbuild.org/v2.24/docs/reference-generate-lockfiles#resolve
[]Generate test snapshots.
Run each command in a package described by a //go:generate directive. This is equivalent to running go generate on a Go package.
Note: Just like with go generate, the go-generate goal is never run as part of the build and must be run manually to invoke the commands described by the //go:generate directives.
See https://go.dev/blog/generate for details.
1 nested properties
Environment variables to set when invoking generator programs https://www.pantsbuild.org/v2.24/docs/reference-go-generate#env_vars
[
"LANG",
"LC_CTYPE",
"LC_ALL",
"PATH"
]Options for Go tests.
15 nested properties
Arguments to pass directly to Go test binary, e.g. --go-test-args='-run TestFoo -v'
https://www.pantsbuild.org/v2.24/docs/reference-go-test#args
[]Capture a goroutine blocking profile from the execution of the test runner https://www.pantsbuild.org/v2.24/docs/reference-go-test#block_profile
Coverage mode to use when running Go tests with coverage analysis enabled via --test-use-coverage
https://www.pantsbuild.org/v2.24/docs/reference-go-test#cover_mode
If true, then convert coverage reports to HTML format and write a coverage.html file next to the raw coverage data
https://www.pantsbuild.org/v2.24/docs/reference-go-test#coverage_html
Path to write the Go coverage reports to https://www.pantsbuild.org/v2.24/docs/reference-go-test#coverage_output_dir
A list of "import path patterns" for determining which import paths will be instrumented for code coverage https://www.pantsbuild.org/v2.24/docs/reference-go-test#coverage_packages
[]Capture a CPU profile from the execution of the test runner https://www.pantsbuild.org/v2.24/docs/reference-go-test#cpu_profile
If true, then always enable interoperation between Go and the C/C++ "address sanitizer" when running tests regardless of the test-by-test asan field on the relevant go_package target
https://www.pantsbuild.org/v2.24/docs/reference-go-test#force_asan
If true, then always enable interoperation between Go and the C/C++ "memory sanitizer" when running tests regardless of the test-by-test msan field on the relevant go_package target
https://www.pantsbuild.org/v2.24/docs/reference-go-test#force_msan
If true, then always enable the Go data race detector when running tests regardless of the test-by-test test_race field on the relevant go_package target
https://www.pantsbuild.org/v2.24/docs/reference-go-test#force_race
Capture an allocation profile from the execution of the test runner after tests have passed https://www.pantsbuild.org/v2.24/docs/reference-go-test#mem_profile
Capture a mutex contention profile from the execution of the test runner when all tests are complete https://www.pantsbuild.org/v2.24/docs/reference-go-test#mutex_profile
Write the test binary to the test extra output directory https://www.pantsbuild.org/v2.24/docs/reference-go-test#output_test_binary
If true, don't use Go test binary when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-go-test#skip
Capture an execution trace from the execution of the test runner https://www.pantsbuild.org/v2.24/docs/reference-go-test#trace
Gofmt-specific options.
2 nested properties
Arguments to pass directly to gofmt, e.g. --gofmt-args='-s -e'
https://www.pantsbuild.org/v2.24/docs/reference-gofmt#args
[]If true, don't use gofmt when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-gofmt#skip
Options for Golang support.
19 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.24/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.24/docs/reference-golang#asdf_tool_name
Compiler options used when compiling C code when Cgo is enabled https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_c_flags
[
"-g",
"-O2"
]Compiler options used when compiling C++ code when Cgo is enabled https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_cxx_flags
[
"-g",
"-O2"
]Enable Cgo support, which allows Go and C code to interact https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_enabled
Name of the tool to use to compile fortran code included via CGo in a Go package https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_fortran_binary_name
Compiler options used when compiling Fortran code when Cgo is enabled https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_fortran_flags
[
"-g",
"-O2"
]Name of the tool to use to compile C code included via CGo in a Go package https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_gcc_binary_name
Name of the tool to use to compile C++ code included via CGo in a Go package https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_gxx_binary_name
Compiler options used when linking native code when Cgo is enabled https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_linker_flags
[
"-g",
"-O2"
]A list of paths to search for tools needed by CGo (e.g., gcc, g++) https://www.pantsbuild.org/v2.24/docs/reference-golang#cgo_tool_search_paths
[
"<PATH>"
]Name of the tool to use as the "external linker" when invoking go tool link
https://www.pantsbuild.org/v2.24/docs/reference-golang#external_linker_binary_name
List any additional executable tools required for the go tool to work
https://www.pantsbuild.org/v2.24/docs/reference-golang#extra_tools
[]A list of paths to search for Go and extra tools needed by go https://www.pantsbuild.org/v2.24/docs/reference-golang#go_search_paths
[
"<PATH>"
]The minimum Go version the distribution discovered by Pants must support https://www.pantsbuild.org/v2.24/docs/reference-golang#minimum_expected_version
Environment variables to set when invoking the go tool
https://www.pantsbuild.org/v2.24/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.24/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.24/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.24/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.24/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.24/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.24/docs/reference-google-java-format#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/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.24/docs/reference-google-java-format#skip
Version string for the tool https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-hadolint#args
[]Path to an YAML config file understood by Hadolint (https://github.com/hadolint/hadolint#configure) https://www.pantsbuild.org/v2.24/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.24/docs/reference-hadolint#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-hadolint#known_versions
[
"v2.12.1-beta|macos_x86_64 |911008b09e88b9ce62dbd12345af8f4c933370ebcfb01211d934f1e0a4d9aecc|19743768",
"v2.12.1-beta|macos_arm64 |911008b09e88b9ce62dbd12345af8f4c933370ebcfb01211d934f1e0a4d9aecc|19743768",
"v2.12.1-beta|linux_x86_64|d0779284293475905cfa4b3a7b5c433eca6d731e45b5df0e157f46b4e6311888|2426420",
"v2.12.1-beta|linux_arm64 |5997119de9b8332a003be938baff3ebd2ff17dfb62e2bceccd59bd9c112599ce|24002600"
]If true, don't use Hadolint when running pants lint
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-hadolint#url_template
What action to take in case the requested version of Hadolint is not supported https://www.pantsbuild.org/v2.24/docs/reference-hadolint#use_unsupported_version
Use this version of Hadolint https://www.pantsbuild.org/v2.24/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/).
This version of Pants uses ipython version 8.12.3 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
5 nested properties
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-ipython#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-ipython#entry_point
Whether to tell IPython not to put the CWD on the import path https://www.pantsbuild.org/v2.24/docs/reference-ipython#ignore_cwd
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-ipython#install_from_resolve
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-ipython#requirements
[]The Python import sorter tool (https://pycqa.github.io/isort/).
This version of Pants uses isort version 5.13.2 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
9 nested properties
Arguments to pass directly to isort, e.g. --isort-args='--case-sensitive --trailing-comma'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-isort#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-isort#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-isort#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-isort#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-isort#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-isort#requirements
[]If true, don't use isort when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-isort#skip
The Java Archive Tool
4 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.24/docs/reference-jar_tool#artifacts
[
"args4j:args4j:2.33",
"com.google.code.findbugs:jsr305:3.0.2",
"com.google.guava:guava:18.0"
]List of JVM options to pass to jar_tool JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-jar_tool#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-jar_tool#lockfile
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-jar_tool#version
The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams)
6 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.24/docs/reference-jarjar#artifacts
[
"com.eed3si9n.jarjar:jarjar-assembly:{version}"
]List of JVM options to pass to jarjar JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-jarjar#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-jarjar#lockfile
The strategy to use when processing class files that are in the wrong package https://www.pantsbuild.org/v2.24/docs/reference-jarjar#misplaced_class_strategy
Skip the processing of the JAR manifest https://www.pantsbuild.org/v2.24/docs/reference-jarjar#skip_manifest
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-jarjar#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.24/docs/reference-java-infer#consumed_types
Infer a target's dependencies by parsing import statements from sources https://www.pantsbuild.org/v2.24/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.24/docs/reference-java-infer#third_party_import_mapping
{}Internal tool for parsing JVM sources to identify dependencies
4 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.24/docs/reference-java-parser#artifacts
[
"com.fasterxml.jackson.core:jackson-databind:2.12.4",
"com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.12.4",
"com.github.javaparser:javaparser-symbol-solver-core:3.25.5"
]List of JVM options to pass to java-parser JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-java-parser#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-java-parser#lockfile
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-java-parser#version
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.24/docs/reference-javac#args
[]If true, add java_sources and java_tests targets with the tailor goal
https://www.pantsbuild.org/v2.24/docs/reference-javac#tailor_source_targets
The JUnit test framework (https://junit.org)
6 nested properties
Arguments to pass directly to JUnit, e.g. --junit-args='--disable-ansi-colors'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-junit#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-junit#lockfile
If true, don't use JUnit when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-junit#skip
Version string for the tool https://www.pantsbuild.org/v2.24/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.
9 nested properties
Extra JVM arguments to use when running tests in debug mode https://www.pantsbuild.org/v2.24/docs/reference-jvm#debug_args
[]The default value used for the resolve and compatible_resolves fields
https://www.pantsbuild.org/v2.24/docs/reference-jvm#default_resolve
A list of patterns to exclude from all deploy jars https://www.pantsbuild.org/v2.24/docs/reference-jvm#deploy_jar_exclude_files
[
"^META-INF/[^/]+\\.SF$",
"^META-INF/[^/]+\\.DSA$",
"^META-INF/[^/]+\\.RSA$",
"META-INF/INDEX.LIST$"
]List of JVM options to pass to all JVM processes https://www.pantsbuild.org/v2.24/docs/reference-jvm#global_options
[]The JDK to use https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-jvm#reproducible_jars
A dictionary mapping resolve names to the path of their lockfile https://www.pantsbuild.org/v2.24/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.24/docs/reference-jvm#tool_jdk
Dump the JVM dependency inference symbol mapping.
Run linters/formatters/fixers in check mode.
4 nested properties
The target number of files to be included in each linter batch https://www.pantsbuild.org/v2.24/docs/reference-lint#batch_size
Only run these linters and skip all others https://www.pantsbuild.org/v2.24/docs/reference-lint#only
[]If true, skip running all fixers in check-only mode https://www.pantsbuild.org/v2.24/docs/reference-lint#skip_fixers
If true, skip running all formatters in check-only mode https://www.pantsbuild.org/v2.24/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.24/docs/reference-list#documented
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-list#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.24/docs/reference-list#sep
Migrate from Get syntax to call-by-name syntax (#19730). This is a destructive operation, so only run this on source controlled files that you are prepared to revert if necessary.
This goal will attempt to migrate the set of paths/targets specified at the command line if they are part of the "migration plan". This migration does not add any new files, but instead modifies existing files in-place without any formatting. The resulting changes should be reviewed, tested, and formatted/linted before committing.
The migration plan is a JSON representation of the rule graph, which is generated by the engine based on the active backends/rules in the project.
Each item in the migration plan is a rule that contains the old Get syntax, the associated input/output types, and the new function to directly call. The migration plan can be dumped as JSON using the --json flag, which can be useful for debugging. For example:
{ "filepath": "src/python/pants/source/source_root.py", "function": "get_source_roots", "gets": [{ "input_types": [{ "module": "pants.source.source_root", "name": "SourceRootsRequest" }], "output_type": { "module": "pants.source.source_root", "name": "OptionalSourceRootsResult" }, "rule_dep": { "function": "get_optional_source_roots", "module": "pants.source.source_root" } }], "module": "pants.source.source_root" }
1 nested properties
Dump the migration plan as JSON https://www.pantsbuild.org/v2.24/docs/reference-migrate-call-by-name#json
The MyPy Python type checker (http://mypy-lang.org/).
This version of Pants uses mypy version 1.11.2 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
10 nested properties
Arguments to pass directly to MyPy, e.g. --mypy-args='--python-version 3.7 --disallow-any-expr'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-mypy#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-mypy#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-mypy#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-mypy#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-mypy#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-mypy#requirements
[]If true, don't use MyPy when running pants check
https://www.pantsbuild.org/v2.24/docs/reference-mypy#skip
An optional list of python_sources target addresses to load first-party plugins
https://www.pantsbuild.org/v2.24/docs/reference-mypy#source_plugins
[]The Node.js Javascript runtime (including Corepack).
10 nested properties
Environment variables to set for corepack invocations
https://www.pantsbuild.org/v2.24/docs/reference-nodejs#corepack_env_vars
[]The PATH value that will be used to find any tools required to run nodejs processes https://www.pantsbuild.org/v2.24/docs/reference-nodejs#executable_search_paths
[
"<PATH>"
]Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-nodejs#known_versions
[
"v22.6.0|macos_arm64|9ea60766807cd3c3a3ad6ad419f98918d634a60fe8dea5b9c07507ed0f176d4c|47583427",
"v22.6.0|macos_x86_64|8766c5968ca22d20fc6237c54c7c5d12ef12e15940d6119a79144ccb163ea737|49688634",
"v22.6.0|linux_arm64|0053ee0426c4daaa65c44f2cef87be45135001c3145cfb840aa1d0e6f2619610|28097296",
"v22.6.0|linux_x86_64|acbbe539edc33209bb3e1b25f7545b5ca5d70e6256ed8318e1ec1e41e7b35703|29240984"
]Default Node.js package manager to use https://www.pantsbuild.org/v2.24/docs/reference-nodejs#package_manager
A mapping of package manager versions to semver releases https://www.pantsbuild.org/v2.24/docs/reference-nodejs#package_managers
{
"npm": "10.8.2",
"pnpm": "9.5.0",
"yarn": "1.22.22"
}A mapping of names to lockfile paths used in your project https://www.pantsbuild.org/v2.24/docs/reference-nodejs#resolves
{}A list of paths to search for Node.js distributions https://www.pantsbuild.org/v2.24/docs/reference-nodejs#search_path
[
"<PATH>"
]A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.24/docs/reference-nodejs#url_platform_mapping
{
"linux_arm64": "linux-arm64",
"linux_x86_64": "linux-x64",
"macos_arm64": "darwin-arm64",
"macos_x86_64": "darwin-x64"
}URL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.24/docs/reference-nodejs#url_template
Use this version of nodejs https://www.pantsbuild.org/v2.24/docs/reference-nodejs#version
Options controlling which dependencies will be inferred for javascript targets.
3 nested properties
Infer a target's imported dependencies by parsing import statements from sources https://www.pantsbuild.org/v2.24/docs/reference-nodejs-infer#imports
Infer a package_json's dependencies by parsing entry point statements from the package.json file
https://www.pantsbuild.org/v2.24/docs/reference-nodejs-infer#package_json_entry_points
How to handle imports that don't have an inferable owner https://www.pantsbuild.org/v2.24/docs/reference-nodejs-infer#unowned_dependency_behavior
Options for package.json script configured tests.
Your preferred test runner is configured via the package.json#scripts.test field.
The only expectation from pants is that the test script can accept a variadic number of path arguments, relative to the package.json, and that any configuration files are file dependencies to the package_json.
Simple example:
Consider a directory-layout:
├── BUILD
├── src/
│ ├── BUILD
│ ├── test/
│ │ ├── BUILD
│ │ └── index.test.js
│ └── index.js
└── package.json
where package.json contains
{
...
"scripts": {
"test": "mocha"
},
"devDependencies: {
...
}
}
Executing pants test src/test/index.test.js will cause the equivalent of mocha src/test/index.test.js to run.
2 nested properties
Path to write the NodeJS coverage reports to https://www.pantsbuild.org/v2.24/docs/reference-nodejs-test#coverage_output_dir
If true, don't use Node.js tests when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-nodejs-test#skip
Create a distributable package.
List the paths between two addresses. Either address may represent a group of targets, e.g. --from=src/app/main.py --to=src/library::.
3 nested properties
The path starting address https://www.pantsbuild.org/v2.24/docs/reference-paths#from
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-paths#output_file
The path end address https://www.pantsbuild.org/v2.24/docs/reference-paths#to
Display BUILD target info
4 nested properties
Whether to leave off values that match the target-defined default values https://www.pantsbuild.org/v2.24/docs/reference-peek#exclude_defaults
Whether to include additional information generated by plugins https://www.pantsbuild.org/v2.24/docs/reference-peek#include_additional_info
Whether to include _dependencies_rules, _dependents_rules and _applicable_dep_rules that apply to the target and its dependencies
https://www.pantsbuild.org/v2.24/docs/reference-peek#include_dep_rules
Output the goal's stdout to this file https://www.pantsbuild.org/v2.24/docs/reference-peek#output_file
How Pants uses Pex to run Python subprocesses.
4 nested properties
If warnings from Pex should be logged by Pants to the console https://www.pantsbuild.org/v2.24/docs/reference-pex#emit_warnings
The PATH value that will be used by the PEX subprocess and any subprocesses it spawns https://www.pantsbuild.org/v2.24/docs/reference-pex#executable_search_paths
[
"<PATH>"
]When possible, use venvs whose site-packages directories are populated with symlinks https://www.pantsbuild.org/v2.24/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.24/docs/reference-pex#verbosity
Default settings for creating PEX executables.
1 nested properties
Whether built PEX binaries should emit PEX warnings at runtime by default https://www.pantsbuild.org/v2.24/docs/reference-pex-binary-defaults#emit_warnings
The PEX (Python EXecutable) tool (https://github.com/pex-tool/pex).
6 nested properties
Arguments to pass directly to pex, e.g. --pex-cli-args='--check=error --no-compile'
https://www.pantsbuild.org/v2.24/docs/reference-pex-cli#global_args
[]Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-pex-cli#known_versions
[
"v2.20.3|macos_arm64|0100c2e0b9e5dd56b063c98176cdd11b6064c2439d0faefdd3d25453393ed9fb|4315782",
"v2.20.3|macos_x86_64|0100c2e0b9e5dd56b063c98176cdd11b6064c2439d0faefdd3d25453393ed9fb|4315782",
"v2.20.3|linux_x86_64|0100c2e0b9e5dd56b063c98176cdd11b6064c2439d0faefdd3d25453393ed9fb|4315782",
"v2.20.3|linux_arm64|0100c2e0b9e5dd56b063c98176cdd11b6064c2439d0faefdd3d25453393ed9fb|4315782"
]A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-pex-cli#use_unsupported_version
Use this version of pex https://www.pantsbuild.org/v2.24/docs/reference-pex-cli#version
Formats files with a preamble, with the preamble looked up based on path.
This is useful for things such as copyright headers or shebang lines.
Pants substitutes the following identifiers (following Python's string.Template substitutions): - $year: The current year (only used when actually writing the year to the file).
2 nested properties
If true, don't use preamble when running pants fmt
https://www.pantsbuild.org/v2.24/docs/reference-preamble#skip
Which preamble template to use based on the path globs (relative to the build root) https://www.pantsbuild.org/v2.24/docs/reference-preamble#template_by_globs
{}The Prettier utility for formatting JS/TS (and others) code (https://prettier.io/).
4 nested properties
Arguments to pass directly to Prettier, e.g. --prettier-args='--version'
https://www.pantsbuild.org/v2.24/docs/reference-prettier#args
[]If specified, install the tool using the lockfile for this named resolve, instead of the version configured in this subsystem https://www.pantsbuild.org/v2.24/docs/reference-prettier#install_from_resolve
If true, don't use Prettier when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-prettier#skip
Version string for the tool in the form package@version (e.g. [email protected]) https://www.pantsbuild.org/v2.24/docs/reference-prettier#version
Publish deliverables (assets, distributions, images, etc).
1 nested properties
Filename for JSON structured publish information https://www.pantsbuild.org/v2.24/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.24/docs/reference-py-constraints#output_file
Output a CSV summary of interpreter constraints for your whole repository https://www.pantsbuild.org/v2.24/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.
This version of Pants uses pyoxidizer version 0.24.0 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
6 nested properties
Arguments to pass directly to PyOxidizer, e.g. --pyoxidizer-args='--release'
https://www.pantsbuild.org/v2.24/docs/reference-pyoxidizer#args
[]The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-pyoxidizer#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-pyoxidizer#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-pyoxidizer#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-pyoxidizer#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-pyoxidizer#requirements
[]The pytest Python test framework (https://docs.pytest.org/).
This version of Pants uses pytest version 7.0.1 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
11 nested properties
Arguments to pass directly to Pytest, e.g. --pytest-args='-k test_foo --quiet'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-pytest#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-pytest#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/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.24/docs/reference-pytest#execution_slot_var
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-pytest#install_from_resolve
The format of generated junit XML files https://www.pantsbuild.org/v2.24/docs/reference-pytest#junit_family
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-pytest#requirements
[]If true, don't use Pytest when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-pytest#skip
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.24/docs/reference-pytest#xdist_enabled
Options for Pants's Python backend.
24 nested properties
The default value used for the resolve field
https://www.pantsbuild.org/v2.24/docs/reference-python#default_resolve
The default value used for the run_goal_use_sandbox field of Python targets
https://www.pantsbuild.org/v2.24/docs/reference-python#default_run_goal_use_sandbox
Create targets for all Python lockfiles defined in [python].resolves
https://www.pantsbuild.org/v2.24/docs/reference-python#enable_lockfile_targets
Set to true to enable lockfiles for user code https://www.pantsbuild.org/v2.24/docs/reference-python#enable_resolves
The Python interpreters your codebase is compatible with https://www.pantsbuild.org/v2.24/docs/reference-python#interpreter_constraints
[]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.24/docs/reference-python#interpreter_versions_universe
[
"2.7",
"3.5",
"3.6",
"3.7",
"3.8",
"3.9",
"3.10",
"3.11",
"3.12",
"3.13"
]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.24/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.24/docs/reference-python#macos_big_sur_compatibility
Use this version of Pip for resolving requirements and generating lockfiles https://www.pantsbuild.org/v2.24/docs/reference-python#pip_version
Whether to use the standard Python command history file when running a repl https://www.pantsbuild.org/v2.24/docs/reference-python#repl_history
Whether to allow resolution of manylinux wheels when resolving requirements for foreign linux platforms https://www.pantsbuild.org/v2.24/docs/reference-python#resolver_manylinux
A mapping of logical names to lockfile paths used in your project https://www.pantsbuild.org/v2.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/docs/reference-python#tailor_pex_binary_targets
If true, add resource targets for marker files named py.typed with the tailor goal
https://www.pantsbuild.org/v2.24/docs/reference-python#tailor_py_typed_targets
If true, add python_requirements, poetry_requirements, and pipenv_requirements target generators with the tailor goal
https://www.pantsbuild.org/v2.24/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.24/docs/reference-python#tailor_source_targets
True if Pants should generate a deprecation warning when Python 2.x is used in interpreter constraints https://www.pantsbuild.org/v2.24/docs/reference-python#warn_on_python2_usage
Options used to locate Python interpreters.
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.
3 nested properties
A map from platform to the information needed to download Python Build Standalone https://www.pantsbuild.org/v2.24/docs/reference-python-bootstrap#internal_python_build_standalone_info
{
"linux_arm64": [
"https://github.com/indygreg/python-build-standalone/releases/download/20230116/cpython-3.9.16+20230116-aarch64-unknown-linux-gnu-install_only.tar.gz",
"1ba520c0db431c84305677f56eb9a4254f5097430ed443e92fc8617f8fba973d",
23873387
],
"linux_x86_64": [
"https://github.com/indygreg/python-build-standalone/releases/download/20230116/cpython-3.9.16+20230116-x86_64-unknown-linux-gnu-install_only.tar.gz",
"7ba397787932393e65fc2fb9fcfabf54f2bb6751d5da2b45913cb25b2d493758",
26129729
],
"macos_arm64": [
"https://github.com/indygreg/python-build-standalone/releases/download/20230116/cpython-3.9.16+20230116-aarch64-apple-darwin-install_only.tar.gz",
"d732d212d42315ac27c6da3e0b69636737a8d72086c980daf844344c010cab80",
17084463
],
"macos_x86_64": [
"https://github.com/indygreg/python-build-standalone/releases/download/20230116/cpython-3.9.16+20230116-x86_64-apple-darwin-install_only.tar.gz",
"3948384af5e8d4ee7e5ccc648322b99c1c5cf4979954ed5e6b3382c69d6db71e",
17059474
]
}The names of Python binaries to search for https://www.pantsbuild.org/v2.24/docs/reference-python-bootstrap#names
[
"python",
"python3"
]A list of paths to search for Python interpreters https://www.pantsbuild.org/v2.24/docs/reference-python-bootstrap#search_path
[
"<PYENV>",
"<ASDF>",
"<PATH>"
]Dump source analysis for python_source targets.
1 nested properties
The type of information that should be returned https://www.pantsbuild.org/v2.24/docs/reference-python-dump-source-analysis#analysis_flavor
Options controlling which dependencies will be inferred for Python targets.
12 nested properties
When multiple sources provide the same symbol, how to choose the provider to use https://www.pantsbuild.org/v2.24/docs/reference-python-infer#ambiguity_resolution
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.24/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.24/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.24/docs/reference-python-infer#conftests
Infer dependencies on targets' entry points, e.g. pex_binary's entry_point field, python_aws_lambda_function's handler field and python_distribution's entry_points field
https://www.pantsbuild.org/v2.24/docs/reference-python-infer#entry_points
Unowned imports that should be ignored https://www.pantsbuild.org/v2.24/docs/reference-python-infer#ignored_unowned_imports
[]Infer a target's imported dependencies by parsing import statements from sources https://www.pantsbuild.org/v2.24/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.24/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 or pytest plugins listed in the pytest_plugins variable in a test module or a conftest file
https://www.pantsbuild.org/v2.24/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.24/docs/reference-python-infer#string_imports_min_dots
How to handle imports that don't have an inferable owner https://www.pantsbuild.org/v2.24/docs/reference-python-infer#unowned_dependency_behavior
Use the new Rust-based, multithreaded, in-process dependency parser https://www.pantsbuild.org/v2.24/docs/reference-python-infer#use_rust_parser
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.24/docs/reference-python-native-code#cpp_flags
[
"<CPPFLAGS>"
]Override the LDFLAGS environment variable for any forked subprocesses
https://www.pantsbuild.org/v2.24/docs/reference-python-native-code#ld_flags
[
"<LDFLAGS>"
]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.24/docs/reference-python-repos#find_links
[]URLs of PEP-503 compatible code repository indexes to look for requirements https://www.pantsbuild.org/v2.24/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.24/docs/reference-python-repos#path_mappings
[]Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade).
This version of Pants uses pyupgrade version 3.8.0 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
7 nested properties
Arguments to pass directly to pyupgrade, e.g. --pyupgrade-args='--py39-plus --keep-runtime-typing'
https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#args
[]The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#requirements
[]If true, don't use pyupgrade when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-pyupgrade#skip
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.
3 nested properties
Config schema is as follows: https://www.pantsbuild.org/v2.24/docs/reference-regex-lint#config
{}How much detail to include in the result https://www.pantsbuild.org/v2.24/docs/reference-regex-lint#detail_level
If true, don't use regex-lint when running pants lint
https://www.pantsbuild.org/v2.24/docs/reference-regex-lint#skip
Open a REPL with the specified code loadable.
3 nested properties
Arguments to pass directly to the repl program, e.g. --repl-args='-i helloworld/main.py'
https://www.pantsbuild.org/v2.24/docs/reference-repl#args
[]True if the REPL should be restarted if its inputs have changed https://www.pantsbuild.org/v2.24/docs/reference-repl#restartable
Override the automatically-detected REPL program for the target(s) specified https://www.pantsbuild.org/v2.24/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.24/docs/reference-roots#output_file
String to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.24/docs/reference-roots#sep
The Ruff Python formatter (https://github.com/astral-sh/ruff).
9 nested properties
Arguments to pass directly to Ruff, e.g. --ruff-args='--exclude=foo --ignore=E501'
https://www.pantsbuild.org/v2.24/docs/reference-ruff#args
[]Path to the pyproject.toml or ruff.toml file to use for configuration (https://github.com/astral-sh/ruff#configuration)
https://www.pantsbuild.org/v2.24/docs/reference-ruff#config
If true, Pants will include any relevant config files during runs (pyproject.toml, and ruff.toml)
https://www.pantsbuild.org/v2.24/docs/reference-ruff#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-ruff#known_versions
[
"0.7.2|macos_arm64|1c9f5a4fc815330d01fd8a56a7a70114ff3ed149bd997ff831524313705ba991|9802953",
"0.7.2|macos_x86_64|5815756947d0a7b1d90805b07ffb2c376c8a9800e9462d545839dc0d79a091d2|10162492",
"0.7.2|linux_arm64|f9342fcca6b58143f316ef3e617f39334edb4c3d15fced5220bd939685f6261d|10651691",
"0.7.2|linux_x86_64|b769e11a3e23a72692cb97ed762ff28e48534972a8ef447fd5b0d3178a56ffd8|11097578",
"0.6.9|macos_arm64|b94562393a4bf23f1a48521f5495a8e48de885b7c173bd7ea8206d6d09921633|9697031",
"0.6.9|macos_x86_64|34aa37643e30dcb81a3c0e011c3a8df552465ea7580ba92ca727a3b7c6de25d1|10018168",
"0.6.9|linux_arm64|73df3729a3381d0918e4640aac4b2653c542f74c7b7843dee8310e2c877e6f2e|10724239",
"0.6.9|linux_x86_64|39a1cd878962ebc88322b4f6d33cae2292454563028f93a3f1f8ce58e3025b07|11000553",
"0.6.4|macos_arm64|2648dd09984c82db9f3163ce8762c89536e4bf0e198f17e06a01c0e32214273e|9167424",
"0.6.4|macos_x86_64|4438cbc80c6aa0e839abc3abb2a869a27113631cb40aa26540572fb53752c432|9463378",
"0.6.4|linux_arm64|a9157a0f062d62c1b1582284a8d10629503f38bc9b7126b614cb7569073180ff|10120541",
"0.6.4|linux_x86_64|3ca04aabf7259c59193e4153a865618cad26f73be930ce5f6109e0e6097d037b|10373921",
"0.5.7|macos_arm64|b78a09f44dc60d8c894aba6cad55abd3b0eccc0992d60a86f74155fc459e227b|8256430",
"0.5.7|macos_x86_64|1f9a7d307f191781fc895947af21d32f8c810c5a5a4cdff16ac53d88a14acd69|8662539",
"0.5.7|linux_arm64|2509d20ef605fb1c8af37af1f46fefc85e1d72add6e87187cb6543420c05dfb1|9991080",
"0.5.7|linux_x86_64|9a5580536ef9cea7d8e56be8af712ac5cd152c081969ece2fbc3631b30bbb5e8|10263458",
"0.4.10|macos_arm64|5a4ff81270eee1efa7901566719aca705a3e8d0f1abead96c01caa4678a7762e|8094319|https://github.com/astral-sh/ruff/releases/download/v0.4.10/ruff-0.4.10-aarch64-apple-darwin.tar.gz",
"0.4.10|macos_x86_64|6e96f288d13b68863e79c9f107a0c51660215829726c9d3dc4879c1801fa3140|8490153|https://github.com/astral-sh/ruff/releases/download/v0.4.10/ruff-0.4.10-x86_64-apple-darwin.tar.gz",
"0.4.10|linux_arm64|75332c97520233b5f95cb3d40bdef13b40e1aa5e6c82a078623993545771f55f|9851689|https://github.com/astral-sh/ruff/releases/download/v0.4.10/ruff-0.4.10-aarch64-unknown-linux-musl.tar.gz",
"0.4.10|linux_x86_64|332ba368c6e08afc3c5d1c7f6e4fb7bf238b7cbf007b400e6bdf01a0a36ae656|10130989|https://github.com/astral-sh/ruff/releases/download/v0.4.10/ruff-0.4.10-x86_64-unknown-linux-musl.tar.gz",
"0.4.9|macos_arm64|5f4506d7ec2ae6ac5a48ba309218a4b825a00d4cad9967b7bbcec1724ef04930|8148128|https://github.com/astral-sh/ruff/releases/download/v0.4.9/ruff-0.4.9-aarch64-apple-darwin.tar.gz",
"0.4.9|macos_x86_64|e4d745adb0f5a0b08f2c9ca71e57f451a9b8485ae35b5555d9f5d20fc93a6cb6|8510706|https://github.com/astral-sh/ruff/releases/download/v0.4.9/ruff-0.4.9-x86_64-apple-darwin.tar.gz",
"0.4.9|linux_arm64|00c50563f9921a141ddd4ec0371149f3bbfa0369d9d238a143bcc3a932363785|8106747|https://github.com/astral-sh/ruff/releases/download/v0.4.9/ruff-0.4.9-aarch64-unknown-linux-musl.tar.gz",
"0.4.9|linux_x86_64|5ceba21dad91e3fa05056ca62f278b0178516cfad8dbf08cf2433c6f1eeb92d3|8863118|https://github.com/astral-sh/ruff/releases/download/v0.4.9/ruff-0.4.9-x86_64-unknown-linux-musl.tar.gz",
"0.3.7|macos_x86_64|b1c961c1bed427e74ab72950c6debcb078c82aba0ee347183cc27a9fc8aaa43b|8615221|https://github.com/astral-sh/ruff/releases/download/v0.3.7/ruff-0.3.7-x86_64-apple-darwin.tar.gz",
"0.3.7|linux_arm64|0e79fbefcd813a10fa60250441bbe36978c95d010b64646848fada64b9af61f0|8180808|https://github.com/astral-sh/ruff/releases/download/v0.3.7/ruff-0.3.7-aarch64-unknown-linux-musl.tar.gz",
"0.3.7|linux_x86_64|3f8348096f7d9c0a9266c4a821dbc7599ef299983e456b61eb0d5290d8615df8|8905370|https://github.com/astral-sh/ruff/releases/download/v0.3.7/ruff-0.3.7-x86_64-unknown-linux-musl.tar.gz",
"0.2.2|macos_arm64|21454a77f0a5ff8ed23a43327f6de9c2f9f6bab1352ebe87fc03866889fa7fae|7262889|https://github.com/astral-sh/ruff/releases/download/v0.2.2/ruff-0.2.2-aarch64-apple-darwin.tar.gz",
"0.2.2|macos_x86_64|798a2028a783f10f21f11eb59763eabcff9961d4302cdcc37d186ab9f864ca82|7611899|https://github.com/astral-sh/ruff/releases/download/v0.2.2/ruff-0.2.2-x86_64-apple-darwin.tar.gz",
"0.2.2|linux_arm64|e73a37f41acf4a4f44cdb9b587316f0f9eb83b51c3c134d1401501e3f8d65dee|7247275|https://github.com/astral-sh/ruff/releases/download/v0.2.2/ruff-0.2.2-aarch64-unknown-linux-musl.tar.gz",
"0.2.2|linux_x86_64|044e4dbd46acc12de78a144c24fd9af86003eaba28e83244546d85076a9c7b04|7881552|https://github.com/astral-sh/ruff/releases/download/v0.2.2/ruff-0.2.2-x86_64-unknown-linux-musl.tar.gz",
"0.1.15|macos_arm64|373c648d693ddaf4f1936a05d3093aabd08553f585c3c3afbbdba41d16b70032|7025376|https://github.com/astral-sh/ruff/releases/download/v0.1.15/ruff-0.1.15-aarch64-apple-darwin.tar.gz",
"0.1.15|macos_x86_64|6d006dc427a74cba930717297b0c472856a2be4cfc37cd04309895c11329dc68|7308240|https://github.com/astral-sh/ruff/releases/download/v0.1.15/ruff-0.1.15-x86_64-apple-darwin.tar.gz",
"0.1.15|linux_arm64|e9ed3c353c4f2b801ed4d21fee2b6159883ad777e959fbbad0b2d2b22e1974c7|7049764|https://github.com/astral-sh/ruff/releases/download/v0.1.15/ruff-0.1.15-aarch64-unknown-linux-musl.tar.gz",
"0.1.15|linux_x86_64|d7389b9743b0b909c364d11bba94d13302171d751430b58c13dcdf248e924276|7605249|https://github.com/astral-sh/ruff/releases/download/v0.1.15/ruff-0.1.15-x86_64-unknown-linux-musl.tar.gz"
]If true, don't use Ruff when running pants fmt and pants fix and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-ruff#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.24/docs/reference-ruff#url_platform_mapping
{
"linux_arm64": "aarch64-unknown-linux-musl",
"linux_x86_64": "x86_64-unknown-linux-musl",
"macos_arm64": "aarch64-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.24/docs/reference-ruff#url_template
What action to take in case the requested version of Ruff is not supported https://www.pantsbuild.org/v2.24/docs/reference-ruff#use_unsupported_version
Use this version of Ruff https://www.pantsbuild.org/v2.24/docs/reference-ruff#version
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.
2 nested properties
Arguments to pass directly to the executed target, e.g. --run-args='val1 val2 --debug'
https://www.pantsbuild.org/v2.24/docs/reference-run#args
[]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.24/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.24/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.24/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.24/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.24/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.24/docs/reference-scala-infer#imports
Add dependency on the package object to every target https://www.pantsbuild.org/v2.24/docs/reference-scala-infer#package_objects
Internal tool for parsing Scala sources to identify dependencies
4 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.24/docs/reference-scala-parser#artifacts
[
"org.scalameta:scalameta_2.13:4.8.7",
"io.circe:circe-generic_2.13:0.14.1",
"org.scala-lang:scala-library:2.13.8"
]List of JVM options to pass to scala-parser JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-scala-parser#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-scala-parser#lockfile
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-scala-parser#version
The Scala compiler.
2 nested properties
Arguments to pass directly to scalac, e.g. --scalac-args='-encoding UTF-8'
https://www.pantsbuild.org/v2.24/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.24/docs/reference-scalac#plugins_for_resolve
{}scalafix (https://scalacenter.github.io/scalafix/)
9 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.24/docs/reference-scalafix#artifacts
[
"ch.epfl.scala:scalafix-cli_2.13.12:{version}"
]Name of a config file understood by scalafix (https://scalacenter.github.io/scalafix/docs/users/configuration.html) https://www.pantsbuild.org/v2.24/docs/reference-scalafix#config_file_name
List of JVM options to pass to scalafix JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-scalafix#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-scalafix#lockfile
Whether to ignore, error or show a warning when files are found that are not covered by the config file provided in [scalafix].config_file_name setting
https://www.pantsbuild.org/v2.24/docs/reference-scalafix#orphan_files_behavior
List of targets providing additional Scalafix rules https://www.pantsbuild.org/v2.24/docs/reference-scalafix#rule_targets
[]Whether semantic rules are enabled or not https://www.pantsbuild.org/v2.24/docs/reference-scalafix#semantic_rules
If true, don't use scalafix when running pants fix and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-scalafix#skip
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-scalafix#version
scalafmt (https://scalameta.org/scalafmt/)
7 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.24/docs/reference-scalafmt#artifacts
[
"org.scalameta:scalafmt-cli_2.13:{version}"
]Name of a config file understood by scalafmt (https://scalameta.org/scalafmt/docs/configuration.html) https://www.pantsbuild.org/v2.24/docs/reference-scalafmt#config_file_name
List of JVM options to pass to scalafmt JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-scalafmt#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-scalafmt#lockfile
Whether to ignore, error or show a warning when files are found that are not covered by the config file provided in [scalafmt].config_file_name setting
https://www.pantsbuild.org/v2.24/docs/reference-scalafmt#orphan_files_behavior
If true, don't use scalafmt when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-scalafmt#skip
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-scalafmt#version
The Scalatest test framework (https://www.scalatest.org/)
6 nested properties
Arguments to pass directly to Scalatest, e.g. --scalatest-args='-t $testname'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-scalatest#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-scalatest#lockfile
If true, don't use Scalatest when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-scalatest#skip
Version string for the tool https://www.pantsbuild.org/v2.24/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.24/docs/reference-scc#args
[]Known versions to verify downloads against https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-scc#url_template
What action to take in case the requested version of SCC is not supported https://www.pantsbuild.org/v2.24/docs/reference-scc#use_unsupported_version
Use this version of SCC https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-setup-py-generation#generate_setup_default
Python setuptools, used to package python_distribution targets.
This version of Pants uses setuptools version 74.1.2 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
2 nested properties
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-setuptools#install_from_resolve
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-setuptools#requirements
[]A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm).
This version of Pants uses setuptools-scm version 7.1.0 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
5 nested properties
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-setuptools-scm#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-setuptools-scm#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-setuptools-scm#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-setuptools-scm#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-setuptools-scm#requirements
[]Options for Pants's Shell support.
4 nested properties
Infer Shell dependencies on other Shell files by analyzing source statements
https://www.pantsbuild.org/v2.24/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.24/docs/reference-shell-setup#executable_search_paths
[
"<PATH>"
]If true, add shunit2_tests targets with the tailor goal
https://www.pantsbuild.org/v2.24/docs/reference-shell-setup#tailor_shunit2_tests
If true, add shell_sources targets with the tailor goal
https://www.pantsbuild.org/v2.24/docs/reference-shell-setup#tailor_sources
Options for Pants' Shell test support.
1 nested properties
If true, don't use Test with shell scripts when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-shell-test#skip
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.24/docs/reference-shellcheck#args
[]If true, Pants will include all relevant .shellcheckrc and shellcheckrc files during runs
https://www.pantsbuild.org/v2.24/docs/reference-shellcheck#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-shellcheck#known_versions
[
"v0.10.0|macos_arm64 |bbd2f14826328eee7679da7221f2bc3afb011f6a928b848c80c321f6046ddf81|7205756",
"v0.10.0|macos_x86_64|ef27684f23279d112d8ad84e0823642e43f838993bbb8c0963db9b58a90464c2|4371632",
"v0.10.0|linux_arm64 |324a7e89de8fa2aed0d0c28f3dab59cf84c6d74264022c00c22af665ed1a09bb|4291764",
"v0.10.0|linux_x86_64|6c881ab0698e4e6ea235245f22832860544f17ba386442fe7e9d629f8cbedf87|2404716"
]If true, don't use Shellcheck when running pants lint
https://www.pantsbuild.org/v2.24/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.24/docs/reference-shellcheck#url_platform_mapping
{
"linux_arm64": "linux.aarch64",
"linux_x86_64": "linux.x86_64",
"macos_arm64": "darwin.aarch64",
"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.24/docs/reference-shellcheck#url_template
What action to take in case the requested version of Shellcheck is not supported https://www.pantsbuild.org/v2.24/docs/reference-shellcheck#use_unsupported_version
Use this version of Shellcheck https://www.pantsbuild.org/v2.24/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.24/docs/reference-shfmt#args
[]If true, Pants will include all relevant .editorconfig files during runs
https://www.pantsbuild.org/v2.24/docs/reference-shfmt#config_discovery
Known versions to verify downloads against https://www.pantsbuild.org/v2.24/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",
"v3.6.0|macos_arm64 |633f242246ee0a866c5f5df25cbf61b6af0d5e143555aca32950059cf13d91e0|3065202",
"v3.6.0|macos_x86_64|b8c9c025b498e2816b62f0b717f6032e9ab49e725a45b8205f52f66318f17185|3047552",
"v3.6.0|linux_arm64 |fb1cf0af3dbe9aac7d98e38e3c7426765208ecfe23cb2da51037bb234776fd70|2818048",
"v3.6.0|linux_x86_64|5741a02a641de7e56b8da170e71a97e58050d66a3cf485fb268d6a5a8bb74afb|2850816",
"v3.8.0|macos_arm64 |1481240d2a90d4f0b530688d76d4f9117d17a756b6027cfa42b96f0707317f83|2736466",
"v3.8.0|macos_x86_64|c0218b47a0301bb006f49fad85d2c08de23df303472834faf5639d04121320f8|2747696",
"v3.8.0|linux_arm64 |27e1f69b0d57c584bcbf5c882b4c4f78ffcf945d0efef45c1fbfc6692213c7c3|2687128",
"v3.8.0|linux_x86_64|27b3c6f9d9592fc5b4856c341d1ff2c88856709b9e76469313642a1d7b558fe0|2703512"
]If true, don't use shfmt when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-shfmt#url_template
What action to take in case the requested version of shfmt is not supported https://www.pantsbuild.org/v2.24/docs/reference-shfmt#use_unsupported_version
Use this version of shfmt https://www.pantsbuild.org/v2.24/docs/reference-shfmt#version
shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2)
6 nested properties
Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-shunit2#known_versions
[
"b9102bb763cc603b3115ed30a5648bf950548097|macos_arm64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987",
"b9102bb763cc603b3115ed30a5648bf950548097|macos_x86_64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987",
"b9102bb763cc603b3115ed30a5648bf950548097|linux_x86_64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987",
"b9102bb763cc603b3115ed30a5648bf950548097|linux_arm64|1f11477b7948150d1ca50cdd41d89be4ed2acd137e26d2e0fe23966d0e272cc5|40987"
]If true, don't use shunit2 when running pants test
https://www.pantsbuild.org/v2.24/docs/reference-shunit2#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.24/docs/reference-shunit2#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.24/docs/reference-shunit2#url_template
What action to take in case the requested version of shunit2 is not supported https://www.pantsbuild.org/v2.24/docs/reference-shunit2#use_unsupported_version
Use this version of shunit2 https://www.pantsbuild.org/v2.24/docs/reference-shunit2#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.24/docs/reference-source#marker_filenames
[]A list of source root suffixes https://www.pantsbuild.org/v2.24/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.
4 nested properties
Output format for reporting stats https://www.pantsbuild.org/v2.24/docs/reference-stats#format
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.24/docs/reference-stats#log
At the end of the Pants run, report a summary of memory usage https://www.pantsbuild.org/v2.24/docs/reference-stats#memory_summary
Output the stats to this file https://www.pantsbuild.org/v2.24/docs/reference-stats#output_file
Reproducible Build Maven Plugin
4 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.24/docs/reference-strip-jar#artifacts
[
"io.github.zlika:reproducible-build-maven-plugin:{version}"
]List of JVM options to pass to strip-jar JVM processes
https://www.pantsbuild.org/v2.24/docs/reference-strip-jar#jvm_options
[]Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.24/docs/reference-strip-jar#lockfile
Version string for the tool https://www.pantsbuild.org/v2.24/docs/reference-strip-jar#version
Environment settings for forked subprocesses.
1 nested properties
Environment variables to set for process invocations https://www.pantsbuild.org/v2.24/docs/reference-subprocess-environment#env_vars
[
"LANG",
"LC_CTYPE",
"LC_ALL",
"SSL_CERT_FILE",
"SSL_CERT_DIR"
]System binaries related settings.
1 nested properties
The PATH value that will searched for executables https://www.pantsbuild.org/v2.24/docs/reference-system-binaries#system_binary_paths
[
"/usr/bin",
"/bin",
"/usr/local/bin",
"/opt/homebrew/bin"
]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.24/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.24/docs/reference-tailor#build_file_header
The indent to use when auto-editing BUILD files https://www.pantsbuild.org/v2.24/docs/reference-tailor#build_file_indent
The name to use for generated BUILD files https://www.pantsbuild.org/v2.24/docs/reference-tailor#build_file_name
Do not write changes to disk, only write back what would change https://www.pantsbuild.org/v2.24/docs/reference-tailor#check
Do not add these target definitions https://www.pantsbuild.org/v2.24/docs/reference-tailor#ignore_adding_targets
[]Do not edit or create BUILD files at these paths https://www.pantsbuild.org/v2.24/docs/reference-tailor#ignore_paths
[]An autoformatter for TOML files (https://taplo.tamasfe.dev/)
9 nested properties
Arguments to pass directly to Taplo, e.g. --taplo-args='--option=align_entries=false'
https://www.pantsbuild.org/v2.24/docs/reference-taplo#args
[]If true, Pants will include a taplo.toml or .taplo.toml file found in the build root during a run
https://www.pantsbuild.org/v2.24/docs/reference-taplo#config_discovery
A list of glob patterns of files to include/exclude in formatting relative to the build root https://www.pantsbuild.org/v2.24/docs/reference-taplo#glob_pattern
[
"**/*.toml",
"!.taplo.toml",
"!taplo.toml"
]Known versions to verify downloads against https://www.pantsbuild.org/v2.24/docs/reference-taplo#known_versions
[
"0.8.0|macos_arm64|79c1691c3c46be981fa0cec930ec9a6d6c4ffd27272d37d1885514ce59bd8ccf|3661689",
"0.8.0|macos_x86_64|a1917f1b9168cb4f7d579422dcdf9c733028d873963d8fa3a6f499e41719c502|3926263",
"0.8.0|linux_arm64|a6a94482f125c21090593f94cad23df099c4924f5b9620cda4a8653527c097a1|3995383",
"0.8.0|linux_x86_64|3703294fac37ca9a9f76308f9f98c3939ccb7588f8972acec68a48d7a10d8ee5|4123593"
]If true, don't use Taplo when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-taplo#skip
A dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.24/docs/reference-taplo#url_platform_mapping
{
"linux_arm64": "linux-aarch64",
"linux_x86_64": "linux-x86_64",
"macos_arm64": "darwin-aarch64",
"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.24/docs/reference-taplo#url_template
What action to take in case the requested version of Taplo is not supported https://www.pantsbuild.org/v2.24/docs/reference-taplo#use_unsupported_version
Use this version of Taplo https://www.pantsbuild.org/v2.24/docs/reference-taplo#version
Run tests.
17 nested properties
The number of attempts to run tests, in case of a test failure https://www.pantsbuild.org/v2.24/docs/reference-test#attempts_default
The target maximum number of files to be included in each run of batch-enabled test runners https://www.pantsbuild.org/v2.24/docs/reference-test#batch_size
Run tests sequentially in an interactive process https://www.pantsbuild.org/v2.24/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.24/docs/reference-test#debug_adapter
Report information about the test results https://www.pantsbuild.org/v2.24/docs/reference-test#experimental_report_test_result_info
Additional environment variables to include in test processes https://www.pantsbuild.org/v2.24/docs/reference-test#extra_env_vars
[]Force the tests to run, even if they could be satisfied from cache https://www.pantsbuild.org/v2.24/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.24/docs/reference-test#open_coverage
Show stdout/stderr for these tests https://www.pantsbuild.org/v2.24/docs/reference-test#output
Write test reports to --report-dir
https://www.pantsbuild.org/v2.24/docs/reference-test#report
Path to write test reports to https://www.pantsbuild.org/v2.24/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.24/docs/reference-test#shard
If tests fail, show an appropriate pants test ... invocation to rerun just those tests
https://www.pantsbuild.org/v2.24/docs/reference-test#show_rerun_command
The default timeout (in seconds) for a test target if the timeout field is not set on the target
https://www.pantsbuild.org/v2.24/docs/reference-test#timeout_default
The maximum timeout (in seconds) that may be used on a test target https://www.pantsbuild.org/v2.24/docs/reference-test#timeout_maximum
Enable test target timeouts https://www.pantsbuild.org/v2.24/docs/reference-test#timeouts
Generate a coverage report if the test runner supports it https://www.pantsbuild.org/v2.24/docs/reference-test#use_coverage
The utility for publishing Python distributions to PyPI and other Python repositories.
This version of Pants uses twine version 4.0.2 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
10 nested properties
Arguments to pass directly to Twine, e.g. --twine-args='--skip-existing'
https://www.pantsbuild.org/v2.24/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.24/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.24/docs/reference-twine#config
If true, Pants will include all relevant config files during runs (.pypirc)
https://www.pantsbuild.org/v2.24/docs/reference-twine#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-twine#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-twine#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-twine#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-twine#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-twine#requirements
[]If true, don't use Twine when running pants publish
https://www.pantsbuild.org/v2.24/docs/reference-twine#skip
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/2.24/docs/releases/upgrade-tips for upgrade tips.
4 nested properties
Do not write changes to disk, only write back what would change https://www.pantsbuild.org/v2.24/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.24/docs/reference-update-build-files#fix_safe_deprecations
Format BUILD files using Black, Ruff or Yapf https://www.pantsbuild.org/v2.24/docs/reference-update-build-files#fmt
Which formatter Pants should use to format BUILD files https://www.pantsbuild.org/v2.24/docs/reference-update-build-files#formatter
Display Pants version.
Options for the visibility rules implementation of the dependency rules API.
2 nested properties
Visibility rules are enforced whenever dependencies are calculated unless enforce is set to false
https://www.pantsbuild.org/v2.24/docs/reference-visibility#enforce
If true, don't use Visibility Rules when running pants lint
https://www.pantsbuild.org/v2.24/docs/reference-visibility#skip
Workunit Logger subsystem. Useful for debugging pants itself.
2 nested properties
Whether to enable workunit logging https://www.pantsbuild.org/v2.24/docs/reference-workunit-logger#enabled
Where to write the log to https://www.pantsbuild.org/v2.24/docs/reference-workunit-logger#logdir
A formatter for Python files (https://github.com/google/yapf).
This version of Pants uses yapf version 0.40.2 by default. Use a dedicated lockfile and the install_from_resolve option to control this.
9 nested properties
Arguments to pass directly to yapf, e.g. --yapf-args='--no-local-style'
https://www.pantsbuild.org/v2.24/docs/reference-yapf#args
[]Path to style file understood by yapf (https://github.com/google/yapf#formatting-style/) https://www.pantsbuild.org/v2.24/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.24/docs/reference-yapf#config_discovery
The console script for the tool https://www.pantsbuild.org/v2.24/docs/reference-yapf#console_script
The entry point for the tool https://www.pantsbuild.org/v2.24/docs/reference-yapf#entry_point
If specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.24/docs/reference-yapf#install_from_resolve
Python interpreter constraints for this tool https://www.pantsbuild.org/v2.24/docs/reference-yapf#interpreter_constraints
[
"CPython>=3.8,<4"
]If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.24/docs/reference-yapf#requirements
[]If true, don't use yapf when running pants fmt and pants lint
https://www.pantsbuild.org/v2.24/docs/reference-yapf#skip