{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://catalog.lintel.tools/schemas/schemastore/pantsbuild/versions/2.20.0.json",
"description": "Pants configuration file schema: ",
"x-lintel": {
"source": "https://www.schemastore.org/pantsbuild-2.20.0.json",
"sourceSha256": "cd838eb92c408c0e15c71ad9b9261429a97aa7ece170989a0bbe690a99e47d76",
"fileMatch": [
"pants*.toml"
],
"parsers": [
"toml"
]
},
"type": "object",
"properties": {
"GLOBAL": {
"description": "Options to control the overall behavior of Pants.",
"properties": {
"backend_packages": {
"default": [],
"description": "Register functionality from these backends\n",
"type": "array"
},
"build_file_prelude_globs": {
"default": [],
"description": "Python files to evaluate and whose symbols should be exposed to all BUILD files\n",
"type": "array"
},
"build_ignore": {
"default": [],
"description": "Path globs or literals to ignore when identifying BUILD files\n",
"type": "array"
},
"build_patterns": {
"default": [
"BUILD",
"BUILD.*"
],
"description": "The naming scheme for BUILD files, i.e. where you define targets\n",
"type": "array"
},
"ca_certs_path": {
"default": null,
"description": "Path to a file containing PEM-format CA certificates used for verifying secure connections when downloading files required by a build\n",
"type": "string"
},
"cache_content_behavior": {
"default": "fetch",
"description": "Controls how the content of cache entries is handled during process execution\n",
"enum": [
"fetch",
"validate",
"defer"
]
},
"colors": {
"default": false,
"description": "Whether Pants should use colors in output or not\n",
"type": "boolean"
},
"concurrent": {
"default": false,
"description": "Enable concurrent runs of Pants\n",
"type": "boolean"
},
"docker_execution": {
"default": true,
"description": "If true, `docker_environment` targets can be used to run builds inside a Docker container\n",
"type": "boolean"
},
"dynamic_ui": {
"default": true,
"description": "Display a dynamically-updating console UI as Pants runs\n",
"type": "boolean"
},
"dynamic_ui_renderer": {
"default": "indicatif-spinner",
"description": "If `--dynamic-ui` is enabled, selects the renderer\n",
"enum": [
"indicatif-spinner",
"experimental-prodash"
]
},
"engine_visualize_to": {
"default": null,
"description": "A directory to write execution and rule graphs to as `dot` files\n"
},
"ignore_warnings": {
"default": [],
"description": "Ignore logs and warnings matching these strings\n",
"type": "array"
},
"keep_sandboxes": {
"default": "never",
"description": "Controls whether Pants will clean up local directories used as chroots for running processes\n",
"enum": [
"always",
"on_failure",
"never"
]
},
"level": {
"default": "info",
"description": "Set the logging level\n",
"enum": [
"trace",
"debug",
"info",
"warn",
"error"
]
},
"local_cache": {
"default": true,
"description": "Whether to cache process executions in a local cache persisted to disk at `--local-store-dir`\n",
"type": "boolean"
},
"local_execution_root_dir": {
"default": "",
"description": "Directory to use for local process execution sandboxing\n",
"type": "string"
},
"local_store_dir": {
"default": "$XDG_CACHE_HOME/lmdb_store",
"description": "Directory to use for the local file store, which stores the results of subprocesses run by Pants\n",
"type": "string"
},
"local_store_directories_max_size_bytes": {
"default": 16000000000,
"description": "The maximum size in bytes of the local store containing directories\n",
"type": "number"
},
"local_store_files_max_size_bytes": {
"default": 256000000000,
"description": "The maximum size in bytes of the local store containing files\n",
"type": "number"
},
"local_store_processes_max_size_bytes": {
"default": 16000000000,
"description": "The maximum size in bytes of the local store containing process cache entries\n",
"type": "number"
},
"local_store_shard_count": {
"default": 16,
"description": "The number of LMDB shards created for the local store\n",
"type": "number"
},
"log_levels_by_target": {
"default": {},
"description": "Set a more specific logging level for one or more logging targets\n",
"type": "object"
},
"log_show_rust_3rdparty": {
"default": false,
"description": "Whether to show/hide logging done by 3rdparty Rust crates used by the Pants engine\n",
"type": "boolean"
},
"logdir": {
"default": null,
"description": "Write logs to files under this directory\n",
"type": "string"
},
"loop": {
"default": false,
"description": "Run goals continuously as file changes are detected\n",
"type": "boolean"
},
"loop_max": {
"default": 4294967296,
"description": "The maximum number of times to loop when `--loop` is specified\n",
"type": "number"
},
"named_caches_dir": {
"default": "$XDG_CACHE_HOME/named_caches",
"description": "Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches\n",
"type": "string"
},
"pants_bin_name": {
"default": "pants",
"description": "The name of the script or binary used to invoke Pants\n",
"type": "string"
},
"pants_config_files": {
"default": [
"/pants.toml"
],
"description": "Paths to Pants config files\n",
"type": "array"
},
"pants_distdir": {
"default": "/dist",
"description": "Write end products, such as the results of `pants package`, to this dir\n",
"type": "string"
},
"pants_ignore": {
"default": [
".*/",
"/dist/",
"__pycache__",
"!.semgrep/",
"!.github/"
],
"description": "Paths to ignore for all filesystem operations performed by pants (e.g\n",
"type": "array"
},
"pants_ignore_use_gitignore": {
"default": true,
"description": "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\n",
"type": "boolean"
},
"pants_physical_workdir_base": {
"default": null,
"description": "When set, a base directory in which to store `--pants-workdir` contents\n",
"type": "string"
},
"pants_subprocessdir": {
"default": "/.pants.d/pids",
"description": "The directory to use for tracking subprocess metadata\n",
"type": "string"
},
"pants_version": {
"default": "",
"description": "Use this Pants version\n",
"type": "string"
},
"pants_workdir": {
"default": "/.pants.d/workdir",
"description": "Write intermediate logs and output files to this dir\n",
"type": "string"
},
"pantsd": {
"default": true,
"description": "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\n",
"type": "boolean"
},
"pantsd_invalidation_globs": {
"default": [],
"description": "Filesystem events matching any of these globs will trigger a daemon restart\n",
"type": "array"
},
"pantsd_max_memory_usage": {
"default": "4GiB",
"description": "The maximum memory usage of the pantsd process\n"
},
"pantsd_pailgun_port": {
"default": 0,
"description": "The port to bind the Pants nailgun server to\n",
"type": "number"
},
"pantsd_timeout_when_multiple_invocations": {
"default": 60.0,
"description": "The maximum amount of time to wait for the invocation to start until raising a timeout exception\n",
"type": "number"
},
"pantsrc": {
"default": true,
"description": "Use pantsrc files located at the paths specified in the global option `pantsrc_files`\n",
"type": "boolean"
},
"pantsrc_files": {
"default": [
"/etc/pantsrc",
"~/.pants.rc",
".pants.rc"
],
"description": "Override config with values from these files, using syntax matching that of `--pants-config-files`\n",
"type": "array"
},
"plugins": {
"default": [],
"description": "Allow backends to be loaded from these plugins (usually released through PyPI). The default backends for each plugin will be loaded automatically\n",
"type": "array"
},
"plugins_force_resolve": {
"default": false,
"description": "Re-resolve plugins, even if previously resolved\n",
"type": "boolean"
},
"print_stacktrace": {
"default": false,
"description": "Print the full exception stack trace for any errors\n",
"type": "boolean"
},
"process_execution_cache_namespace": {
"default": null,
"description": "The cache namespace for process execution\n",
"type": "string"
},
"process_execution_graceful_shutdown_timeout": {
"default": 3,
"description": "The time in seconds to wait when gracefully shutting down an interactive process (such as one opened using `pants run`) before killing it\n",
"type": "number"
},
"process_execution_local_enable_nailgun": {
"default": true,
"description": "Whether or not to use nailgun to run JVM requests that are marked as supporting nailgun\n",
"type": "boolean"
},
"process_execution_local_parallelism": {
"default": "#cores",
"description": "Number of concurrent processes that may be executed locally\n",
"type": "number"
},
"process_execution_remote_parallelism": {
"default": 128,
"description": "Number of concurrent processes that may be executed remotely\n",
"type": "number"
},
"process_per_child_memory_usage": {
"default": "512MiB",
"description": "The default memory usage for a single \"pooled\" child process\n"
},
"process_total_child_memory_usage": {
"default": null,
"description": "The maximum memory usage for all \"pooled\" child processes\n"
},
"pythonpath": {
"default": [],
"description": "Add these directories to PYTHONPATH to search for plugins\n",
"type": "array"
},
"remote_ca_certs_path": {
"default": null,
"description": "Path to a PEM file containing CA certificates used for verifying secure connections to `[GLOBAL].remote_execution_address` and `[GLOBAL].remote_store_address`\n",
"type": "string"
},
"remote_cache_read": {
"default": false,
"description": "Whether to enable reading from a remote cache\n",
"type": "boolean"
},
"remote_cache_rpc_concurrency": {
"default": 128,
"description": "The number of concurrent requests allowed to the remote cache service\n",
"type": "number"
},
"remote_cache_rpc_timeout_millis": {
"default": 1500,
"description": "Timeout value for remote cache RPCs in milliseconds\n",
"type": "number"
},
"remote_cache_warnings": {
"default": "backoff",
"description": "How frequently to log remote cache failures at the `warn` log level\n",
"enum": [
"ignore",
"first_only",
"backoff",
"always"
]
},
"remote_cache_write": {
"default": false,
"description": "Whether to enable writing results to a remote cache\n",
"type": "boolean"
},
"remote_client_certs_path": {
"default": null,
"description": "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)\n",
"type": "string"
},
"remote_client_key_path": {
"default": null,
"description": "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)\n",
"type": "string"
},
"remote_execution": {
"default": false,
"description": "Enables remote workers for increased parallelism. (Alpha)\n",
"type": "boolean"
},
"remote_execution_address": {
"default": null,
"description": "The URI of a server/entity used as a remote execution scheduler\n",
"type": "string"
},
"remote_execution_append_only_caches_base_path": {
"default": null,
"description": "Sets the base path to use when setting up an append-only cache for a process running remotely\n",
"type": "string"
},
"remote_execution_extra_platform_properties": {
"default": [],
"description": "Platform properties to set on remote execution requests\n",
"type": "array"
},
"remote_execution_headers": {
"default": "{'user-agent': 'pants/'}",
"description": "Headers to set on remote execution requests\n",
"type": "object"
},
"remote_execution_overall_deadline_secs": {
"default": 3600,
"description": "Overall timeout in seconds for each remote execution request from time of submission\n",
"type": "number"
},
"remote_execution_rpc_concurrency": {
"default": 128,
"description": "The number of concurrent requests allowed to the remote execution service\n",
"type": "number"
},
"remote_instance_name": {
"default": null,
"description": "Name of the remote instance to use by remote caching and remote execution\n",
"type": "string"
},
"remote_oauth_bearer_token": {
"default": null,
"description": "An oauth token to use for gGRPC connections to `[GLOBAL].remote_execution_address` and `[GLOBAL].remote_store_address`\n",
"type": "string"
},
"remote_provider": {
"default": "reapi",
"description": "The type of provider to use, if using a remote cache and/or remote execution, See for details\n",
"enum": [
"reapi",
"experimental-file",
"experimental-github-actions-cache"
]
},
"remote_store_address": {
"default": null,
"description": "The URI of a server/entity used as a remote file store\n",
"type": "string"
},
"remote_store_batch_api_size_limit": {
"default": 4194304,
"description": "The maximum total size of blobs allowed to be sent in a single batch API call to the remote store\n",
"type": "number"
},
"remote_store_chunk_bytes": {
"default": 1048576,
"description": "Size in bytes of chunks transferred to/from the remote file store\n",
"type": "number"
},
"remote_store_headers": {
"default": "{'user-agent': 'pants/'}",
"description": "Headers to set on remote store requests\n",
"type": "object"
},
"remote_store_rpc_concurrency": {
"default": 128,
"description": "The number of concurrent requests allowed to the remote store service\n",
"type": "number"
},
"remote_store_rpc_retries": {
"default": 2,
"description": "Number of times to retry any RPC to the remote store before giving up\n",
"type": "number"
},
"remote_store_rpc_timeout_millis": {
"default": 30000,
"description": "Timeout value for remote store RPCs (not including streaming requests) in milliseconds\n",
"type": "number"
},
"rule_threads_core": {
"default": "max(2, #cores/2)",
"description": "The number of threads to keep active and ready to execute `@rule` logic (see also: `--rule-threads-max`)\n",
"type": "number"
},
"rule_threads_max": {
"default": null,
"description": "The maximum number of threads to use to execute `@rule` logic\n",
"type": "number"
},
"session_end_tasks_timeout": {
"default": 3.0,
"description": "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\n",
"type": "number"
},
"show_log_target": {
"default": false,
"description": "Display the target where a log message originates in that log message's output\n",
"type": "boolean"
},
"spec_files": {
"default": [],
"description": "Read additional specs (target addresses, files, and/or globs), one per line, from these files\n",
"type": "array"
},
"stats_record_option_scopes": {
"default": [
"*"
],
"description": "Option scopes to record in stats on run completion\n",
"type": "array"
},
"streaming_workunits_complete_async": {
"default": true,
"description": "True if stats recording should be allowed to complete asynchronously when `pantsd` is enabled\n",
"type": "boolean"
},
"streaming_workunits_level": {
"default": "debug",
"description": "The level of workunits that will be reported to streaming workunit event receivers\n",
"enum": [
"trace",
"debug",
"info",
"warn",
"error"
]
},
"streaming_workunits_report_interval": {
"default": 1.0,
"description": "Interval in seconds between when streaming workunit event receivers will be polled\n",
"type": "number"
},
"subproject_roots": {
"default": [],
"description": "Paths that correspond with build roots for any subproject that this project depends on\n",
"type": "array"
},
"tag": {
"default": [],
"description": "Include only targets with these tags (optional '+' prefix) or without these tags ('-' prefix)\n",
"type": "array"
},
"unmatched_build_file_globs": {
"default": "warn",
"description": "What to do when files and globs specified in BUILD files, such as in the `sources` field, cannot be found\n",
"enum": [
"ignore",
"warn",
"error"
]
},
"unmatched_cli_globs": {
"default": "error",
"description": "What to do when command line arguments, e.g. files and globs like `dir::`, cannot be found\n",
"enum": [
"ignore",
"warn",
"error"
]
},
"verify_config": {
"default": true,
"description": "Verify that all config file values correspond to known options\n",
"type": "boolean"
},
"watch_filesystem": {
"default": true,
"description": "Set to False if Pants should not watch the filesystem for changes. `pantsd` or `loop` may not be enabled\n",
"type": "boolean"
}
},
"type": "object"
},
"anonymous-telemetry": {
"description": "Options related to sending anonymous stats to the Pants project, to aid development.",
"properties": {
"enabled": {
"default": false,
"description": "Whether to send anonymous telemetry to the Pants project\n",
"type": "boolean"
},
"repo_id": {
"default": null,
"description": "An anonymized ID representing this repo\n",
"type": "string"
}
},
"type": "object"
},
"autoflake": {
"description": "The Autoflake Python code formatter (https://github.com/myint/autoflake).",
"properties": {
"args": {
"default": [
"--remove-all-unused-imports"
],
"description": "Arguments to pass directly to Autoflake, e.g. `--autoflake-args='--remove-all-unused-imports --target-version=py37 --quiet'`\n",
"type": "array"
},
"console_script": {
"default": "autoflake",
"description": "The console script for the tool\n",
"type": "string"
},
"entry_point": {
"default": null,
"description": "The entry point for the tool\n",
"type": "string"
},
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"interpreter_constraints": {
"default": [
"CPython>=3.7,<4"
],
"description": "Python interpreter constraints for this tool\n",
"type": "array"
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
},
"skip": {
"default": false,
"description": "If true, don't use Autoflake when running `pants fmt` and `pants lint`\n",
"type": "boolean"
}
},
"type": "object"
},
"black": {
"description": "The Black Python code formatter (https://black.readthedocs.io/).",
"properties": {
"args": {
"default": [],
"description": "Arguments to pass directly to Black, e.g. `--black-args='--target-version=py37 --quiet'`\n",
"type": "array"
},
"config": {
"default": null,
"description": "Path to a TOML config file understood by Black (https://github.com/psf/black#configuration-format)\n"
},
"config_discovery": {
"default": true,
"description": "If true, Pants will include any relevant pyproject.toml config files during runs\n",
"type": "boolean"
},
"console_script": {
"default": "black",
"description": "The console script for the tool\n",
"type": "string"
},
"entry_point": {
"default": null,
"description": "The entry point for the tool\n",
"type": "string"
},
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"interpreter_constraints": {
"default": [
"CPython>=3.7,<4"
],
"description": "Python interpreter constraints for this tool\n",
"type": "array"
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
},
"skip": {
"default": false,
"description": "If true, don't use Black when running `pants fmt` and `pants lint`\n",
"type": "boolean"
}
},
"type": "object"
},
"build-deprecations-fixer": {
"description": "A tool/plugin for fixing BUILD file deprecations (where possible).\n\nThis includes deprecations for:\n\n - Renamed targets\n - Renamed fields",
"properties": {
"skip": {
"default": false,
"description": "If true, don't use BUILD Deprecations Fixer when running `pants fix`\n",
"type": "boolean"
}
},
"type": "object"
},
"changed": {
"description": "Tell Pants to detect what files and targets have changed from Git.\n\nSee .",
"properties": {
"dependents": {
"default": "none",
"description": "Include direct or transitive dependents of changed targets\n",
"enum": [
"none",
"direct",
"transitive"
]
},
"diffspec": {
"default": null,
"description": "Calculate changes contained within a given Git spec (commit range/SHA/ref)\n",
"type": "string"
},
"since": {
"default": null,
"description": "Calculate changes since this Git spec (commit range/SHA/ref)\n",
"type": "string"
}
},
"type": "object"
},
"check": {
"description": "Run type checking or the lightest variant of compilation available for a language.",
"properties": {
"only": {
"default": [],
"description": "Only run these checkers and skip all others\n",
"type": "array"
}
},
"type": "object"
},
"check-default-tools": {
"description": "Options for checking that external tool default locations are correctly typed.",
"properties": {},
"type": "object"
},
"cli": {
"description": "Options for configuring CLI behavior, such as command line aliases.",
"properties": {
"alias": {
"default": {},
"description": "Register command line aliases\n",
"type": "object"
}
},
"type": "object"
},
"count-loc": {
"description": "Count lines of code.",
"properties": {},
"type": "object"
},
"coursier": {
"description": "A dependency resolver for the Maven ecosystem. (https://get-coursier.io/)",
"properties": {
"jvm_index": {
"default": "",
"description": "The JVM index to be used by Coursier\n",
"type": "string"
},
"known_versions": {
"default": [
"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"
],
"description": "Known versions to verify downloads against\n",
"type": "array"
},
"repos": {
"default": [
"https://maven-central.storage-download.googleapis.com/maven2",
"https://repo1.maven.org/maven2"
],
"description": "Maven style repositories to resolve artifacts from\n",
"type": "array"
},
"url_platform_mapping": {
"default": {
"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"
},
"description": "A dictionary mapping platforms to strings to be used when generating the URL to download the tool\n",
"type": "object"
},
"url_template": {
"default": "https://github.com/coursier/coursier/releases/download/{version}/cs-{platform}.gz",
"description": "URL to download the tool, either as a single binary file or a compressed file (e.g. zip file)\n",
"type": "string"
},
"use_unsupported_version": {
"default": "error",
"description": "What action to take in case the requested version of coursier is not supported\n",
"enum": [
"error",
"warning"
]
},
"version": {
"default": "v2.1.6",
"description": "Use this version of coursier\n",
"type": "string"
}
},
"type": "object"
},
"coverage-py": {
"description": "Configuration for Python test coverage measurement.",
"properties": {
"config": {
"default": null,
"description": "Path to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/stable/config.html)\n"
},
"config_discovery": {
"default": true,
"description": "If true, Pants will include any relevant config files during runs (`.coveragerc`, `setup.cfg`, `tox.ini`, and `pyproject.toml`)\n",
"type": "boolean"
},
"console_script": {
"default": "coverage",
"description": "The console script for the tool\n",
"type": "string"
},
"entry_point": {
"default": null,
"description": "The entry point for the tool\n",
"type": "string"
},
"fail_under": {
"default": null,
"description": "Fail if the total combined coverage percentage for all tests is less than this number\n",
"type": "number"
},
"filter": {
"default": [],
"description": "A list of Python modules or filesystem paths to use in the coverage report, e.g. `['helloworld_test', 'helloworld/util/dirutil']`\n",
"type": "array"
},
"global_report": {
"default": false,
"description": "If true, Pants will generate a global coverage report\n",
"type": "boolean"
},
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"interpreter_constraints": {
"default": [
"CPython>=3.7,<4"
],
"description": "Python interpreter constraints for this tool\n",
"type": "array"
},
"output_dir": {
"default": "{distdir}/coverage/python",
"description": "Path to write the Pytest Coverage report to\n",
"type": "string"
},
"report": {
"default": [
"console"
],
"description": "Which coverage report type(s) to emit\n",
"type": "array",
"items": {
"enum": [
"console",
"xml",
"html",
"raw",
"json",
"lcov"
]
}
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
}
},
"type": "object"
},
"debug-adapter": {
"description": "Options used to configure and launch a Debug Adapter server.\n\nSee for more information.",
"properties": {
"host": {
"default": "127.0.0.1",
"description": "The hostname to use when launching the server\n",
"type": "string"
},
"port": {
"default": 5678,
"description": "The port to use when launching the server\n",
"type": "number"
}
},
"type": "object"
},
"debugpy": {
"description": "An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).",
"properties": {
"args": {
"default": [],
"description": "Arguments to pass directly to debugpy, e.g. `--debugpy-args='--log-to-stderr'`\n",
"type": "array"
},
"console_script": {
"default": null,
"description": "The console script for the tool\n",
"type": "string"
},
"entry_point": {
"default": "debugpy",
"description": "The entry point for the tool\n",
"type": "string"
},
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"interpreter_constraints": {
"default": [
"CPython>=3.7,<4"
],
"description": "Python interpreter constraints for this tool\n",
"type": "array"
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
}
},
"type": "object"
},
"dependees": {
"description": "List all targets that depend on any of the input files/targets.",
"properties": {
"closed": {
"default": false,
"description": "Include the input targets in the output, along with the dependents\n",
"type": "boolean"
},
"format": {
"default": "text",
"description": "Output format for listing dependents\n",
"enum": [
"text",
"json"
]
},
"output_file": {
"default": null,
"description": "Output the goal's stdout to this file\n",
"type": "string"
},
"sep": {
"default": "\\n",
"description": "String to use to separate lines in line-oriented output\n",
"type": "string"
},
"transitive": {
"default": false,
"description": "List all transitive dependents\n",
"type": "boolean"
}
},
"type": "object"
},
"dependencies": {
"description": "List the dependencies of the input files/targets.",
"properties": {
"closed": {
"default": false,
"description": "Include the input targets in the output, along with the dependencies\n",
"type": "boolean"
},
"format": {
"default": "text",
"description": "Output format for listing dependencies\n",
"enum": [
"text",
"json"
]
},
"output_file": {
"default": null,
"description": "Output the goal's stdout to this file\n",
"type": "string"
},
"sep": {
"default": "\\n",
"description": "String to use to separate lines in line-oriented output\n",
"type": "string"
},
"transitive": {
"default": false,
"description": "List all transitive dependencies\n",
"type": "boolean"
}
},
"type": "object"
},
"dependents": {
"description": "List all targets that depend on any of the input files/targets.",
"properties": {
"closed": {
"default": false,
"description": "Include the input targets in the output, along with the dependents\n",
"type": "boolean"
},
"format": {
"default": "text",
"description": "Output format for listing dependents\n",
"enum": [
"text",
"json"
]
},
"output_file": {
"default": null,
"description": "Output the goal's stdout to this file\n",
"type": "string"
},
"sep": {
"default": "\\n",
"description": "String to use to separate lines in line-oriented output\n",
"type": "string"
},
"transitive": {
"default": false,
"description": "List all transitive dependents\n",
"type": "boolean"
}
},
"type": "object"
},
"docformatter": {
"description": "The Python docformatter tool (https://github.com/myint/docformatter).",
"properties": {
"args": {
"default": [],
"description": "Arguments to pass directly to docformatter, e.g. `--docformatter-args='--wrap-summaries=100 --pre-summary-newline'`\n",
"type": "array"
},
"console_script": {
"default": "docformatter",
"description": "The console script for the tool\n",
"type": "string"
},
"entry_point": {
"default": null,
"description": "The entry point for the tool\n",
"type": "string"
},
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"interpreter_constraints": {
"default": [
"CPython>=3.7,<4"
],
"description": "Python interpreter constraints for this tool\n",
"type": "array"
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
},
"skip": {
"default": false,
"description": "If true, don't use docformatter when running `pants fmt` and `pants lint`\n",
"type": "boolean"
}
},
"type": "object"
},
"docker": {
"description": "Options for interacting with Docker.",
"properties": {
"build_args": {
"default": [],
"description": "Global build arguments (for Docker `--build-arg` options) to use for all `docker build` invocations\n",
"type": "array"
},
"build_hosts": {
"default": {},
"description": "Hosts entries to be added to the `/etc/hosts` file in all built images\n",
"type": "object"
},
"build_no_cache": {
"default": false,
"description": "Do not use the Docker cache when building images\n",
"type": "boolean"
},
"build_target_stage": {
"default": null,
"description": "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`\n",
"type": "string"
},
"build_verbose": {
"default": false,
"description": "Whether to log the Docker output to the console\n",
"type": "boolean"
},
"default_context_root": {
"default": "",
"description": "Provide a default Docker build context root path for `docker_image` targets that does not specify their own `context_root` field\n"
},
"default_repository": {
"default": "{name}",
"description": "Configure the default repository name used in the Docker image tag\n",
"type": "string"
},
"env_vars": {
"default": [],
"description": "Environment variables to set for `docker` invocations\n",
"type": "array"
},
"executable_search_paths": {
"default": [
""
],
"description": "The PATH value that will be used to find the Docker client and any tools required\n",
"type": "array"
},
"registries": {
"default": {},
"description": "Configure Docker registries\n",
"oneOf": [
{
"type": "object"
},
{
"type": "string"
}
]
},
"run_args": {
"default": [],
"description": "Additional arguments to use for `docker run` invocations\n",
"type": "array"
},
"tailor": {
"default": true,
"description": "If true, add `docker_image` targets with the `tailor` goal\n",
"type": "boolean"
},
"tools": {
"default": [],
"description": "List any additional executable tools required for Docker to work\n",
"type": "array"
},
"use_buildx": {
"default": false,
"description": "Use [buildx](https://github.com/docker/buildx#buildx) (and BuildKit) for builds\n",
"type": "boolean"
}
},
"type": "object"
},
"dockerfile-parser": {
"description": "Used to parse Dockerfile build specs to infer their dependencies.",
"properties": {
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"interpreter_constraints": {
"default": [
"CPython>=3.7,<4"
],
"description": "Python interpreter constraints for this tool\n",
"type": "array"
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
}
},
"type": "object"
},
"environments-preview": {
"description": "A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux.",
"properties": {
"names": {
"default": {},
"description": "A mapping of logical names to addresses to environment targets\n",
"type": "object"
}
},
"type": "object"
},
"experimental-bsp": {
"description": "Setup repository for Build Server Protocol (https://build-server-protocol.github.io/).",
"properties": {
"groups_config_files": {
"default": [],
"description": "A list of config files that define groups of Pants targets to expose to IDEs via Build Server Protocol\n",
"type": "array"
},
"runner_env_vars": {
"default": [
"PATH"
],
"description": "Environment variables to set in the BSP runner script when setting up BSP in a repository\n",
"type": "array"
},
"server": {
"default": false,
"description": "Run the Build Server Protocol server\n",
"type": "boolean"
}
},
"type": "object"
},
"experimental-deploy": {
"description": "Perform a deployment process.",
"properties": {},
"type": "object"
},
"experimental-explorer": {
"description": "Run the Pants Explorer Web UI server.",
"properties": {
"address": {
"default": "localhost",
"description": "Server address to bind to\n",
"type": "string"
},
"port": {
"default": 8000,
"description": "Server port to bind to\n",
"type": "number"
}
},
"type": "object"
},
"export": {
"description": "Export Pants data for use in other tools, such as IDEs.\n\n:::caution Exporting tools requires creating a custom lockfile for them\n\nFollow [the instructions for creating tool lockfiles](../../docs/python/overview/lockfiles#lockfiles-for-tools)\n\n:::",
"properties": {
"py_editable_in_resolve": {
"default": [],
"description": "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\n",
"type": "array"
},
"py_resolve_format": {
"default": "mutable_virtualenv",
"description": "Export Python resolves using this format\n",
"enum": [
"mutable_virtualenv",
"symlinked_immutable_virtualenv"
]
},
"resolve": {
"default": [],
"description": "Export the specified resolve(s)\n",
"type": "array"
}
},
"type": "object"
},
"export-codegen": {
"description": "Write generated files to `dist/codegen` for use outside of Pants.",
"properties": {},
"type": "object"
},
"filedeps": {
"description": "List all source and BUILD files a target depends on.",
"properties": {
"absolute": {
"default": false,
"description": "If True, output with absolute path\n",
"type": "boolean"
},
"globs": {
"default": false,
"description": "Instead of outputting filenames, output the original globs used in the BUILD file\n",
"type": "boolean"
},
"output_file": {
"default": null,
"description": "Output the goal's stdout to this file\n",
"type": "string"
},
"sep": {
"default": "\\n",
"description": "String to use to separate lines in line-oriented output\n",
"type": "string"
},
"transitive": {
"default": false,
"description": "If True, list files from all dependencies, including transitive dependencies\n",
"type": "boolean"
}
},
"type": "object"
},
"filter": {
"description": "Filter the input targets based on various criteria.\n\nMost 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.\n\nEach of the filtering options may be specified multiple times, with an implied logical AND between them.",
"properties": {
"address_regex": {
"default": [],
"description": "Filter on target addresses matching these regexes\n",
"type": "array"
},
"granularity": {
"default": "all",
"description": "Filter to rendering only targets declared in BUILD files, only file-level targets, or all targets\n",
"enum": [
"all",
"file",
"BUILD"
]
},
"output_file": {
"default": null,
"description": "Output the goal's stdout to this file\n",
"type": "string"
},
"sep": {
"default": "\\n",
"description": "String to use to separate lines in line-oriented output\n",
"type": "string"
},
"tag_regex": {
"default": [],
"description": "Filter on targets with tags matching these regexes\n",
"type": "array"
},
"target_type": {
"default": [],
"description": "Filter on these target types, e.g. `resources` or `python_sources`\n",
"type": "array"
}
},
"type": "object"
},
"fix": {
"description": "Autofix source code.",
"properties": {
"batch_size": {
"default": 128,
"description": "The target number of files to be included in each fixer batch\n",
"type": "number"
},
"only": {
"default": [],
"description": "Only run these fixers and skip all others\n",
"type": "array"
},
"skip_formatters": {
"default": false,
"description": "If true, skip running all formatters\n",
"type": "boolean"
}
},
"type": "object"
},
"flake8": {
"description": "The Flake8 Python linter (https://flake8.pycqa.org/).",
"properties": {
"args": {
"default": [],
"description": "Arguments to pass directly to Flake8, e.g. `--flake8-args='--ignore E123,W456 --enable-extensions H111'`\n",
"type": "array"
},
"config": {
"default": null,
"description": "Path to an INI config file understood by Flake8 (https://flake8.pycqa.org/en/latest/user/configuration.html)\n"
},
"config_discovery": {
"default": true,
"description": "If true, Pants will include any relevant config files during runs (`.flake8`, `flake8`, `setup.cfg`, and `tox.ini`)\n",
"type": "boolean"
},
"console_script": {
"default": "flake8",
"description": "The console script for the tool\n",
"type": "string"
},
"entry_point": {
"default": null,
"description": "The entry point for the tool\n",
"type": "string"
},
"extra_files": {
"default": [],
"description": "Paths to extra files to include in the sandbox\n",
"type": "array"
},
"install_from_resolve": {
"default": null,
"description": "If specified, install the tool using the lockfile for this named resolve\n",
"type": "string"
},
"requirements": {
"default": [],
"description": "If `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile\n",
"type": "array"
},
"skip": {
"default": false,
"description": "If true, don't use Flake8 when running `pants lint`\n",
"type": "boolean"
},
"source_plugins": {
"default": [],
"description": "An optional list of `python_sources` target addresses to load first-party plugins\n",
"type": "array"
}
},
"type": "object"
},
"fmt": {
"description": "Autoformat source code.",
"properties": {
"batch_size": {
"default": 128,
"description": "The target number of files to be included in each formatter batch\n",
"type": "number"
},
"only": {
"default": [],
"description": "Only run these formatters and skip all others\n",
"type": "array"
}
},
"type": "object"
},
"generate-lockfiles": {
"description": "Generate lockfiles for third-party dependencies.",
"properties": {
"custom_command": {
"default": null,
"description": "If set, lockfile headers will say to run this command to regenerate the lockfile, rather than running `pants generate-lockfiles --resolve=` like normal\n",
"type": "string"
},
"diff": {
"default": true,
"description": "Print a summary of changed distributions after generating the lockfile\n",
"type": "boolean"
},
"diff_include_unchanged": {
"default": false,
"description": "Include unchanged distributions in the diff summary output\n",
"type": "boolean"
},
"resolve": {
"default": [],
"description": "Only generate lockfiles for the specified resolve(s)\n",
"type": "array"
}
},
"type": "object"
},
"generate-snapshots": {
"description": "Generate test snapshots.",
"properties": {},
"type": "object"
},
"go-generate": {
"description": "Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package.\n\nNote: 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.\n\nSee for details.",
"properties": {
"env_vars": {
"default": [
"LANG",
"LC_CTYPE",
"LC_ALL",
"PATH"
],
"description": "Environment variables to set when invoking generator programs\n",
"type": "array"
}
},
"type": "object"
},
"go-test": {
"description": "Options for Go tests.",
"properties": {
"args": {
"default": [],
"description": "Arguments to pass directly to Go test binary, e.g. `--go-test-args='-run TestFoo -v'`\n",
"type": "array"
},
"block_profile": {
"default": false,
"description": "Capture a goroutine blocking profile from the execution of the test runner\n",
"type": "boolean"
},
"cover_mode": {
"default": "set",
"description": "Coverage mode to use when running Go tests with coverage analysis enabled via `--test-use-coverage`\n",
"enum": [
"set",
"count",
"atomic"
]
},
"coverage_html": {
"default": true,
"description": "If true, then convert coverage reports to HTML format and write a `coverage.html` file next to the raw coverage data\n",
"type": "boolean"
},
"coverage_output_dir": {
"default": "{distdir}/coverage/go/{target_spec}",
"description": "Path to write the Go coverage reports to\n",
"type": "string"
},
"coverage_packages": {
"default": [],
"description": "A list of \"import path patterns\" for determining which import paths will be instrumented for code coverage\n",
"type": "array"
},
"cpu_profile": {
"default": false,
"description": "Capture a CPU profile from the execution of the test runner\n",
"type": "boolean"
},
"force_asan": {
"default": false,
"description": "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\n",
"type": "boolean"
},
"force_msan": {
"default": false,
"description": "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\n",
"type": "boolean"
},
"force_race": {
"default": false,
"description": "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\n",
"type": "boolean"
},
"mem_profile": {
"default": false,
"description": "Capture an allocation profile from the execution of the test runner after tests have passed\n",
"type": "boolean"
},
"mutex_profile": {
"default": false,
"description": "Capture a mutex contention profile from the execution of the test runner when all tests are complete\n",
"type": "boolean"
},
"output_test_binary": {
"default": false,
"description": "Write the test binary to the test extra output directory\n",
"type": "boolean"
},
"skip": {
"default": false,
"description": "If true, don't use Go test binary when running `pants test`\n",
"type": "boolean"
},
"trace": {
"default": false,
"description": "Capture an execution trace from the execution of the test runner\n",
"type": "boolean"
}
},
"type": "object"
},
"gofmt": {
"description": "Gofmt-specific options.",
"properties": {
"args": {
"default": [],
"description": "Arguments to pass directly to gofmt, e.g. `--gofmt-args='-s -e'`\n