From 34751c9e0bb896ac3ef4dab9670574c6fb1811bc Mon Sep 17 00:00:00 2001 From: j-helland Date: Fri, 19 Dec 2025 21:18:40 -0700 Subject: [PATCH 1/2] Make preview feature commandline args take precedence over config file fields * Instead of merging commandline `--preview-features` with config file `preview-features`, now the commandline arguments take precedence. This matches the semantics of how uv handles other commandline arguments. * Removed unnecessary `PreviewFeaturesMode` type. * Fixed bug with `PreviewFeatures` serde serializer that produced a list of lists instead of a flat list as expected. --- uv.schema.json | 580 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 461 insertions(+), 119 deletions(-) diff --git a/uv.schema.json b/uv.schema.json index 859f4993f41..467cf340f7f 100644 --- a/uv.schema.json +++ b/uv.schema.json @@ -17,7 +17,10 @@ }, "allow-insecure-host": { "description": "Allow insecure connections to host.\n\nExpects to receive either a hostname (e.g., `localhost`), a host-port pair (e.g.,\n`localhost:8080`), or a URL (e.g., `https://localhost`).\n\nWARNING: Hosts included in this list will not be verified against the system's certificate\nstore. Only use `--allow-insecure-host` in a secure network with verified sources, as it\nbypasses SSL verification and could expose you to MITM attacks.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/TrustedHost" } @@ -35,18 +38,27 @@ }, "build-constraint-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } }, "cache-dir": { "description": "Path to the cache directory.\n\nDefaults to `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Linux and macOS, and\n`%LOCALAPPDATA%\\uv\\cache` on Windows.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "cache-keys": { "description": "The keys to consider when caching builds for the project.\n\nCache keys enable you to specify the files or directories that should trigger a rebuild when\nmodified. By default, uv will rebuild a project whenever the `pyproject.toml`, `setup.py`,\nor `setup.cfg` files in the project directory are modified, or if a `src` directory is\nadded or removed, i.e.:\n\n```toml\ncache-keys = [{ file = \"pyproject.toml\" }, { file = \"setup.py\" }, { file = \"setup.cfg\" }, { dir = \"src\" }]\n```\n\nAs an example: if a project uses dynamic metadata to read its dependencies from a\n`requirements.txt` file, you can specify `cache-keys = [{ file = \"requirements.txt\" }, { file = \"pyproject.toml\" }]`\nto ensure that the project is rebuilt whenever the `requirements.txt` file is modified (in\naddition to watching the `pyproject.toml`).\n\nGlobs are supported, following the syntax of the [`glob`](https://docs.rs/glob/0.3.1/glob/struct.Pattern.html)\ncrate. For example, to invalidate the cache whenever a `.toml` file in the project directory\nor any of its subdirectories is modified, you can specify `cache-keys = [{ file = \"**/*.toml\" }]`.\nNote that the use of globs can be expensive, as uv may need to walk the filesystem to\ndetermine whether any files have changed.\n\nCache keys can also include version control information. For example, if a project uses\n`setuptools_scm` to read its version from a Git commit, you can specify `cache-keys = [{ git = { commit = true }, { file = \"pyproject.toml\" }]`\nto include the current Git commit hash in the cache key (in addition to the\n`pyproject.toml`). Git tags are also supported via `cache-keys = [{ git = { commit = true, tags = true } }]`.\n\nCache keys can also include environment variables. For example, if a project relies on\n`MACOSX_DEPLOYMENT_TARGET` or other environment variables to determine its behavior, you can\nspecify `cache-keys = [{ env = \"MACOSX_DEPLOYMENT_TARGET\" }]` to invalidate the cache\nwhenever the environment variable changes.\n\nCache keys only affect the project defined by the `pyproject.toml` in which they're\nspecified (as opposed to, e.g., affecting all members in a workspace), and all paths and\nglobs are interpreted as relative to the project directory.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/CacheKey" } @@ -64,23 +76,35 @@ }, "compile-bytecode": { "description": "Compile Python files to bytecode after installation.\n\nBy default, uv does not compile Python (`.py`) files to bytecode (`__pycache__/*.pyc`);\ninstead, compilation is performed lazily the first time a module is imported. For use-cases\nin which start time is critical, such as CLI applications and Docker containers, this option\ncan be enabled to trade longer installation times for faster start times.\n\nWhen enabled, uv will process the entire site-packages directory (including packages that\nare not being modified by the current operation) for consistency. Like pip, it will also\nignore errors.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "concurrent-builds": { "description": "The maximum number of source distributions that uv will build concurrently at any given\ntime.\n\nDefaults to the number of available CPU cores.", - "type": ["integer", "null"], + "type": [ + "integer", + "null" + ], "format": "uint", "minimum": 1 }, "concurrent-downloads": { "description": "The maximum number of in-flight concurrent downloads that uv will perform at any given\ntime.", - "type": ["integer", "null"], + "type": [ + "integer", + "null" + ], "format": "uint", "minimum": 1 }, "concurrent-installs": { "description": "The number of threads used when installing and unzipping packages.\n\nDefaults to the number of available CPU cores.", - "type": ["integer", "null"], + "type": [ + "integer", + "null" + ], "format": "uint", "minimum": 1 }, @@ -119,7 +143,10 @@ }, "constraint-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } @@ -148,28 +175,40 @@ }, "dependency-metadata": { "description": "Pre-defined static metadata for dependencies of the project (direct or transitive). When\nprovided, enables the resolver to use the specified metadata instead of querying the\nregistry or building the relevant package from source.\n\nMetadata should be provided in adherence with the [Metadata 2.3](https://packaging.python.org/en/latest/specifications/core-metadata/)\nstandard, though only the following fields are respected:\n\n- `name`: The name of the package.\n- (Optional) `version`: The version of the package. If omitted, the metadata will be applied\n to all versions of the package.\n- (Optional) `requires-dist`: The dependencies of the package (e.g., `werkzeug>=0.14`).\n- (Optional) `requires-python`: The Python version required by the package (e.g., `>=3.10`).\n- (Optional) `provides-extra`: The extras provided by the package.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/StaticMetadata" } }, "dev-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } }, "environments": { "description": "A list of environment markers, e.g., `python_version >= '3.6'`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } }, "exclude-dependencies": { "description": "Package names to exclude, e.g., `werkzeug`, `numpy`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } @@ -220,14 +259,20 @@ }, "extra-index-url": { "description": "Extra URLs of package indexes to use, in addition to `--index-url`.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nAll indexes provided via this flag take priority over the index specified by\n[`index_url`](#index-url) or [`index`](#index) with `default = true`. When multiple indexes\nare provided, earlier values take priority.\n\nTo control uv's resolution strategy when multiple indexes are present, see\n[`index_strategy`](#index-strategy).\n\n(Deprecated: use `index` instead.)", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/IndexUrl" } }, "find-links": { "description": "Locations to search for candidate distributions, in addition to those found in the registry\nindexes.\n\nIf a path, the target must be a directory that contains packages as wheel files (`.whl`) or\nsource distributions (e.g., `.tar.gz` or `.zip`) at the top level.\n\nIf a URL, the page must contain a flat list of links to package files adhering to the\nformats described above.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/IndexUrl" } @@ -245,7 +290,10 @@ }, "index": { "description": "The indexes to use when resolving dependencies.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nIndexes are considered in the order in which they're defined, such that the first-defined\nindex has the highest priority. Further, the indexes provided by this setting are given\nhigher priority than any indexes specified via [`index_url`](#index-url) or\n[`extra_index_url`](#extra-index-url). uv will only consider the first index that contains\na given package, unless an alternative [index strategy](#index-strategy) is specified.\n\nIf an index is marked as `explicit = true`, it will be used exclusively for the\ndependencies that select it explicitly via `[tool.uv.sources]`, as in:\n\n```toml\n[[tool.uv.index]]\nname = \"pytorch\"\nurl = \"https://download.pytorch.org/whl/cu121\"\nexplicit = true\n\n[tool.uv.sources]\ntorch = { index = \"pytorch\" }\n```\n\nIf an index is marked as `default = true`, it will be moved to the end of the prioritized list, such that it is\ngiven the lowest priority when resolving packages. Additionally, marking an index as default will disable the\nPyPI default index.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "default": null, "items": { "$ref": "#/definitions/Index" @@ -297,71 +345,113 @@ }, "managed": { "description": "Whether the project is managed by uv. If `false`, uv will ignore the project when\n`uv run` is invoked.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "native-tls": { "description": "Whether to load TLS certificates from the platform's native certificate store.\n\nBy default, uv loads certificates from the bundled `webpki-roots` crate. The\n`webpki-roots` are a reliable set of trust roots from Mozilla, and including them in uv\nimproves portability and performance (especially on macOS).\n\nHowever, in some cases, you may want to use the platform's native certificate store,\nespecially if you're relying on a corporate trust root (e.g., for a mandatory proxy) that's\nincluded in your system's certificate store.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-binary": { "description": "Don't install pre-built wheels.\n\nThe given packages will be built and installed from source. The resolver will still use\npre-built wheels to extract package metadata, if available.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-binary-package": { "description": "Don't install pre-built wheels for a specific package.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "no-build": { "description": "Don't build source distributions.\n\nWhen enabled, resolving will not run arbitrary Python code. The cached wheels of\nalready-built source distributions will be reused, but operations that require building\ndistributions will exit with an error.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-build-isolation": { "description": "Disable isolation when building source distributions.\n\nAssumes that build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-build-isolation-package": { "description": "Disable isolation when building source distributions for a specific package.\n\nAssumes that the packages' build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "no-build-package": { "description": "Don't build source distributions for a specific package.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "no-cache": { "description": "Avoid reading from or writing to the cache, instead using a temporary directory for the\nduration of the operation.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-index": { "description": "Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and\nthose provided via `--find-links`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-sources": { "description": "Ignore the `tool.uv.sources` table when resolving dependencies. Used to lock against the\nstandards-compliant, publishable package metadata, as opposed to using any local or Git\nsources.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "offline": { "description": "Disable network access, relying only on locally cached data and locally available files.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "override-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } }, "package": { "description": "Whether the project should be considered a Python package, or a non-package (\"virtual\")\nproject.\n\nPackages are built and installed into the virtual environment in editable mode and thus\nrequire a build backend, while virtual projects are _not_ built or installed; instead, only\ntheir dependencies are included in the virtual environment.\n\nCreating a package requires that a `build-system` is present in the `pyproject.toml`, and\nthat the project adheres to a structure that adheres to the build backend's expectations\n(e.g., a `src` layout).", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "pip": { "anyOf": [ @@ -408,7 +498,10 @@ }, "pypy-install-mirror": { "description": "Mirror URL to use for downloading managed PyPy installations.\n\nBy default, managed PyPy installations are downloaded from [downloads.python.org](https://downloads.python.org/).\nThis variable can be set to a mirror URL to use a different source for PyPy installations.\nThe provided URL will replace `https://downloads.python.org/pypy` in, e.g., `https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.\n\nDistributions can be read from a\nlocal directory by using the `file://` URL scheme.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "python-downloads": { "description": "Whether to allow Python downloads.", @@ -423,11 +516,17 @@ }, "python-downloads-json-url": { "description": "URL pointing to JSON of custom Python installations.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "python-install-mirror": { "description": "Mirror URL for downloading managed Python installations.\n\nBy default, managed Python installations are downloaded from [`python-build-standalone`](https://github.com/astral-sh/python-build-standalone).\nThis variable can be set to a mirror URL to use a different source for Python installations.\nThe provided URL will replace `https://github.com/astral-sh/python-build-standalone/releases/download` in, e.g., `https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.\n\nDistributions can be read from a local directory by using the `file://` URL scheme.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "python-preference": { "description": "Whether to prefer using Python installations that are already present on the system, or\nthose that are downloaded and installed by uv.", @@ -442,18 +541,27 @@ }, "reinstall": { "description": "Reinstall all packages, regardless of whether they're already installed. Implies `refresh`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "reinstall-package": { "description": "Reinstall a specific package, regardless of whether it's already installed. Implies\n`refresh-package`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "required-environments": { "description": "A list of environment markers, e.g., `sys_platform == 'darwin'.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "type": "string" } @@ -515,11 +623,17 @@ }, "upgrade": { "description": "Allow package upgrades, ignoring pinned versions in any existing output file.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "upgrade-package": { "description": "Allow upgrades for a specific package, ignoring pinned versions in any existing output\nfile.\n\nAccepts both standalone package names (`ruff`) and version specifiers (`ruff<0.5.0`).", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/Requirement" } @@ -685,7 +799,9 @@ } }, "additionalProperties": false, - "required": ["file"] + "required": [ + "file" + ] }, { "description": "Ex) `{ dir = \"src\" }`", @@ -696,7 +812,9 @@ } }, "additionalProperties": false, - "required": ["dir"] + "required": [ + "dir" + ] }, { "description": "Ex) `{ git = true }` or `{ git = { commit = true, tags = false } }`", @@ -707,7 +825,9 @@ } }, "additionalProperties": false, - "required": ["git"] + "required": [ + "git" + ] }, { "description": "Ex) `{ env = \"UV_CACHE_INFO\" }`", @@ -718,7 +838,9 @@ } }, "additionalProperties": false, - "required": ["env"] + "required": [ + "env" + ] } ] }, @@ -766,7 +888,10 @@ "properties": { "requires-python": { "description": "Version of python to require when installing this group", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] } } }, @@ -809,7 +934,10 @@ "$ref": "#/definitions/Requirement" } }, - "required": ["requirement", "match-runtime"] + "required": [ + "requirement", + "match-runtime" + ] } ] }, @@ -855,10 +983,16 @@ "type": "object", "properties": { "commit": { - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "tags": { - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] } }, "additionalProperties": false @@ -912,7 +1046,10 @@ }, "ignore-error-codes": { "description": "Status codes that uv should ignore when deciding whether\nto continue searching in the next index after a failure.\n\n```toml\n[[tool.uv.index]]\nname = \"my-index\"\nurl = \"https:///simple\"\nignore-error-codes = [401, 403]\n```", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "default": null, "items": { "$ref": "#/definitions/StatusCode" @@ -949,7 +1086,9 @@ ] } }, - "required": ["url"] + "required": [ + "url" + ] }, "IndexCacheControl": { "description": "Cache control configuration for an index.", @@ -957,11 +1096,17 @@ "properties": { "api": { "description": "Cache control header for Simple API requests.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "files": { "description": "Cache control header for file downloads.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] } } }, @@ -1089,10 +1234,15 @@ "$ref": "#/definitions/GroupName" }, "path": { - "type": ["string", "null"] + "type": [ + "string", + "null" + ] } }, - "required": ["name"] + "required": [ + "name" + ] }, "PipOptions": { "description": "Settings that are specific to the `uv pip` command-line interface.\n\nThese values will be ignored when running commands outside the `uv pip` namespace (e.g.,\n`uv lock`, `uvx`).", @@ -1100,11 +1250,17 @@ "properties": { "all-extras": { "description": "Include all optional dependencies.\n\nOnly applies to `pyproject.toml`, `setup.py`, and `setup.cfg` sources.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "allow-empty-requirements": { "description": "Allow `uv pip sync` with empty requirements, which will clear the environment of all\npackages.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "annotation-style": { "description": "The style of the annotation comments included in the output file, used to indicate the\nsource of each package.", @@ -1119,11 +1275,17 @@ }, "break-system-packages": { "description": "Allow uv to modify an `EXTERNALLY-MANAGED` Python installation.\n\nWARNING: `--break-system-packages` is intended for use in continuous integration (CI)\nenvironments, when installing into Python installations that are managed by an external\npackage manager, like `apt`. It should be used with caution, as such Python installations\nexplicitly recommend against modifications by other package managers (like uv or pip).", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "compile-bytecode": { "description": "Compile Python files to bytecode after installation.\n\nBy default, uv does not compile Python (`.py`) files to bytecode (`__pycache__/*.pyc`);\ninstead, compilation is performed lazily the first time a module is imported. For use-cases\nin which start time is critical, such as CLI applications and Docker containers, this option\ncan be enabled to trade longer installation times for faster start times.\n\nWhen enabled, uv will process the entire site-packages directory (including packages that\nare not being modified by the current operation) for consistency. Like pip, it will also\nignore errors.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "config-settings": { "description": "Settings to pass to the [PEP 517](https://peps.python.org/pep-0517/) build backend,\nspecified as `KEY=VALUE` pairs.", @@ -1149,34 +1311,55 @@ }, "custom-compile-command": { "description": "The header comment to include at the top of the output file generated by `uv pip compile`.\n\nUsed to reflect custom build scripts and commands that wrap `uv pip compile`.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "dependency-metadata": { "description": "Pre-defined static metadata for dependencies of the project (direct or transitive). When\nprovided, enables the resolver to use the specified metadata instead of querying the\nregistry or building the relevant package from source.\n\nMetadata should be provided in adherence with the [Metadata 2.3](https://packaging.python.org/en/latest/specifications/core-metadata/)\nstandard, though only the following fields are respected:\n\n- `name`: The name of the package.\n- (Optional) `version`: The version of the package. If omitted, the metadata will be applied\n to all versions of the package.\n- (Optional) `requires-dist`: The dependencies of the package (e.g., `werkzeug>=0.14`).\n- (Optional) `requires-python`: The Python version required by the package (e.g., `>=3.10`).\n- (Optional) `provides-extra`: The extras provided by the package.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/StaticMetadata" } }, "emit-build-options": { "description": "Include `--no-binary` and `--only-binary` entries in the output file generated by `uv pip compile`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "emit-find-links": { "description": "Include `--find-links` entries in the output file generated by `uv pip compile`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "emit-index-annotation": { "description": "Include comment annotations indicating the index used to resolve each package (e.g.,\n`# from https://pypi.org/simple`).", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "emit-index-url": { "description": "Include `--index-url` and `--extra-index-url` entries in the output file generated by `uv pip compile`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "emit-marker-expression": { "description": "Whether to emit a marker string indicating the conditions under which the set of pinned\ndependencies is valid.\n\nThe pinned dependencies may be valid even when the marker expression is\nfalse, but when the expression is true, the requirements are known to\nbe correct.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "exclude-newer": { "description": "Limit candidate packages to those that were uploaded prior to a given point in time.\n\nAccepts a superset of [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) (e.g.,\n`2006-12-02T02:07:43Z`). A full timestamp is required to ensure that the resolver will\nbehave consistently across timezones.", @@ -1202,7 +1385,10 @@ }, "extra": { "description": "Include optional dependencies from the specified extra; may be provided more than once.\n\nOnly applies to `pyproject.toml`, `setup.py`, and `setup.cfg` sources.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/ExtraName" } @@ -1231,14 +1417,20 @@ }, "extra-index-url": { "description": "Extra URLs of package indexes to use, in addition to `--index-url`.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nAll indexes provided via this flag take priority over the index specified by\n[`index_url`](#index-url). When multiple indexes are provided, earlier values take priority.\n\nTo control uv's resolution strategy when multiple indexes are present, see\n[`index_strategy`](#index-strategy).", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/IndexUrl" } }, "find-links": { "description": "Locations to search for candidate distributions, in addition to those found in the registry\nindexes.\n\nIf a path, the target must be a directory that contains packages as wheel files (`.whl`) or\nsource distributions (e.g., `.tar.gz` or `.zip`) at the top level.\n\nIf a URL, the page must contain a flat list of links to package files adhering to the\nformats described above.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/IndexUrl" } @@ -1256,11 +1448,17 @@ }, "generate-hashes": { "description": "Include distribution hashes in the output file.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "group": { "description": "Include the following dependency groups.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PipGroupName" } @@ -1311,82 +1509,130 @@ }, "no-annotate": { "description": "Exclude comment annotations indicating the source of each package from the output file\ngenerated by `uv pip compile`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-binary": { "description": "Don't install pre-built wheels.\n\nThe given packages will be built and installed from source. The resolver will still use\npre-built wheels to extract package metadata, if available.\n\nMultiple packages may be provided. Disable binaries for all packages with `:all:`.\nClear previously specified packages with `:none:`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageNameSpecifier" } }, "no-build": { "description": "Don't build source distributions.\n\nWhen enabled, resolving will not run arbitrary Python code. The cached wheels of\nalready-built source distributions will be reused, but operations that require building\ndistributions will exit with an error.\n\nAlias for `--only-binary :all:`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-build-isolation": { "description": "Disable isolation when building source distributions.\n\nAssumes that build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-build-isolation-package": { "description": "Disable isolation when building source distributions for a specific package.\n\nAssumes that the packages' build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "no-deps": { "description": "Ignore package dependencies, instead only add those packages explicitly listed\non the command line to the resulting requirements file.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-emit-package": { "description": "Specify a package to omit from the output resolution. Its dependencies will still be\nincluded in the resolution. Equivalent to pip-compile's `--unsafe-package` option.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "no-extra": { "description": "Exclude the specified optional dependencies if `all-extras` is supplied.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/ExtraName" } }, "no-header": { "description": "Exclude the comment header at the top of output file generated by `uv pip compile`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-index": { "description": "Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and\nthose provided via `--find-links`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-sources": { "description": "Ignore the `tool.uv.sources` table when resolving dependencies. Used to lock against the\nstandards-compliant, publishable package metadata, as opposed to using any local or Git\nsources.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-strip-extras": { "description": "Include extras in the output file.\n\nBy default, uv strips extras, as any packages pulled in by the extras are already included\nas dependencies in the output file directly. Further, output files generated with\n`--no-strip-extras` cannot be used as constraints files in `install` and `sync` invocations.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "no-strip-markers": { "description": "Include environment markers in the output file generated by `uv pip compile`.\n\nBy default, uv strips environment markers, as the resolution generated by `compile` is\nonly guaranteed to be correct for the target environment.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "only-binary": { "description": "Only use pre-built wheels; don't build source distributions.\n\nWhen enabled, resolving will not run code from the given packages. The cached wheels of already-built\nsource distributions will be reused, but operations that require building distributions will\nexit with an error.\n\nMultiple packages may be provided. Disable binaries for all packages with `:all:`.\nClear previously specified packages with `:none:`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageNameSpecifier" } }, "output-file": { "description": "Write the requirements generated by `uv pip compile` to the given `requirements.txt` file.\n\nIf the file already exists, the existing versions will be preferred when resolving\ndependencies, unless `--upgrade` is also specified.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "prefix": { "description": "Install packages into `lib`, `bin`, and other top-level folders under the specified\ndirectory, as if a virtual environment were present at that location.\n\nIn general, prefer the use of `--python` to install into an alternate environment, as\nscripts and other artifacts installed via `--prefix` will reference the installing\ninterpreter, rather than any interpreter added to the `--prefix` directory, rendering them\nnon-portable.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "prerelease": { "description": "The strategy to use when considering pre-release versions.\n\nBy default, uv will accept pre-releases for packages that _only_ publish pre-releases,\nalong with first-party requirements that contain an explicit pre-release marker in the\ndeclared specifiers (`if-necessary-or-explicit`).", @@ -1401,7 +1647,10 @@ }, "python": { "description": "The Python interpreter into which packages should be installed.\n\nBy default, uv installs into the virtual environment in the current working directory or\nany parent directory. The `--python` option allows you to specify a different interpreter,\nwhich is intended for use in continuous integration (CI) environments or other automated\nworkflows.\n\nSupported formats:\n- `3.10` looks for an installed Python 3.10 in the registry on Windows (see\n `py --list-paths`), or `python3.10` on Linux and macOS.\n- `python3.10` or `python.exe` looks for a binary with the given name in `PATH`.\n- `/home/ferris/.local/bin/python3.10` uses the exact Python at the given path.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "python-platform": { "description": "The platform for which requirements should be resolved.\n\nRepresented as a \"target triple\", a string that describes the target platform in terms of\nits CPU, vendor, and operating system name, like `x86_64-unknown-linux-gnu` or\n`aarch64-apple-darwin`.", @@ -1427,18 +1676,27 @@ }, "reinstall": { "description": "Reinstall all packages, regardless of whether they're already installed. Implies `refresh`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "reinstall-package": { "description": "Reinstall a specific package, regardless of whether it's already installed. Implies\n`refresh-package`.", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/PackageName" } }, "require-hashes": { "description": "Require a matching hash for each requirement.\n\nHash-checking mode is all or nothing. If enabled, _all_ requirements must be provided\nwith a corresponding hash or set of hashes. Additionally, if enabled, _all_ requirements\nmust either be pinned to exact versions (e.g., `==1.0.0`), or be specified via direct URL.\n\nHash-checking mode introduces a number of additional constraints:\n\n- Git dependencies are not supported.\n- Editable installations are not supported.\n- Local dependencies are not supported, unless they point to a specific wheel (`.whl`) or\n source archive (`.zip`, `.tar.gz`), as opposed to a directory.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "resolution": { "description": "The strategy to use when selecting between the different compatible versions for a given\npackage requirement.\n\nBy default, uv will use the latest compatible version of each package (`highest`).", @@ -1453,15 +1711,24 @@ }, "strict": { "description": "Validate the Python environment, to detect packages with missing dependencies and other\nissues.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "system": { "description": "Install packages into the system Python environment.\n\nBy default, uv installs into the virtual environment in the current working directory or\nany parent directory. The `--system` option instructs uv to instead use the first Python\nfound in the system `PATH`.\n\nWARNING: `--system` is intended for use in continuous integration (CI) environments and\nshould be used with caution, as it can modify the system Python installation.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "target": { "description": "Install packages into the specified directory, rather than into the virtual or system Python\nenvironment. The packages will be installed at the top-level of the directory.", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "torch-backend": { "description": "The backend to use when fetching packages in the PyTorch ecosystem.\n\nWhen set, uv will ignore the configured index URLs for packages in the PyTorch ecosystem,\nand will instead use the defined backend.\n\nFor example, when set to `cpu`, uv will use the CPU-only PyTorch index; when set to `cu126`,\nuv will use the PyTorch index for CUDA 12.6.\n\nThe `auto` mode will attempt to detect the appropriate PyTorch index based on the currently\ninstalled CUDA drivers.\n\nThis setting is only respected by `uv pip` commands.\n\nThis option is in preview and may change in any future release.", @@ -1476,22 +1743,34 @@ }, "universal": { "description": "Perform a universal resolution, attempting to generate a single `requirements.txt` output\nfile that is compatible with all operating systems, architectures, and Python\nimplementations.\n\nIn universal mode, the current Python version (or user-provided `--python-version`) will be\ntreated as a lower bound. For example, `--universal --python-version 3.7` would produce a\nuniversal resolution for Python 3.7 and later.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "upgrade": { "description": "Allow package upgrades, ignoring pinned versions in any existing output file.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "upgrade-package": { "description": "Allow upgrades for a specific package, ignoring pinned versions in any existing output\nfile.\n\nAccepts both standalone package names (`ruff`) and version specifiers (`ruff<0.5.0`).", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/Requirement" } }, "verify-hashes": { "description": "Validate any hashes provided in the requirements file.\n\nUnlike `--require-hashes`, `--verify-hashes` does not require that all requirements have\nhashes; instead, it will limit itself to verifying the hashes of those requirements that do\ninclude them.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] } }, "additionalProperties": false @@ -1690,7 +1969,10 @@ "type": "object", "properties": { "branch": { - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "extra": { "anyOf": [ @@ -1722,13 +2004,19 @@ }, "lfs": { "description": "Whether to use Git LFS when cloning the repository.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "marker": { "$ref": "#/definitions/MarkerTree" }, "rev": { - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "subdirectory": { "description": "The path to the directory with the `pyproject.toml`, if it's not in the archive root.", @@ -1742,11 +2030,16 @@ ] }, "tag": { - "type": ["string", "null"] + "type": [ + "string", + "null" + ] } }, "additionalProperties": false, - "required": ["git"] + "required": [ + "git" + ] }, { "description": "A remote `http://` or `https://` URL, either a wheel (`.whl`) or a source distribution\n(`.zip`, `.tar.gz`).\n\nExample:\n```toml\nflask = { url = \"https://files.pythonhosted.org/packages/61/80/ffe1da13ad9300f87c93af113edd0638c75138c42a0994becfacac078c06/flask-3.0.3-py3-none-any.whl\" }\n```", @@ -1791,7 +2084,9 @@ } }, "additionalProperties": false, - "required": ["url"] + "required": [ + "url" + ] }, { "description": "The path to a dependency, either a wheel (a `.whl` file), source distribution (a `.zip` or\n`.tar.gz` file), or source tree (i.e., a directory containing a `pyproject.toml` or\n`setup.py` file in the root).", @@ -1799,7 +2094,10 @@ "properties": { "editable": { "description": "`false` by default.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "extra": { "anyOf": [ @@ -1826,14 +2124,19 @@ }, "package": { "description": "Whether to treat the dependency as a buildable Python package (`true`) or as a virtual\npackage (`false`). If `false`, the package will not be built or installed, but its\ndependencies will be included in the virtual environment.\n\nWhen omitted, the package status is inferred based on the presence of a `[build-system]`\nin the project's `pyproject.toml`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "path": { "$ref": "#/definitions/PortablePathBuf" } }, "additionalProperties": false, - "required": ["path"] + "required": [ + "path" + ] }, { "description": "A dependency pinned to a specific index, e.g., `torch` after setting `torch` to `https://download.pytorch.org/whl/cu118`.", @@ -1867,7 +2170,9 @@ } }, "additionalProperties": false, - "required": ["index"] + "required": [ + "index" + ] }, { "description": "A dependency on another package in the workspace.", @@ -1875,7 +2180,10 @@ "properties": { "editable": { "description": "Whether the package should be installed as editable. Defaults to `true`.", - "type": ["boolean", "null"] + "type": [ + "boolean", + "null" + ] }, "extra": { "anyOf": [ @@ -1906,7 +2214,9 @@ } }, "additionalProperties": false, - "required": ["workspace"] + "required": [ + "workspace" + ] } ] }, @@ -1946,15 +2256,23 @@ }, "requires-python": { "description": "PEP 508-style Python requirement, e.g., `>=3.10`", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] }, "version": { "description": "PEP 440-style package version, e.g., `1.2.3`", - "type": ["string", "null"] + "type": [ + "string", + "null" + ] } }, "additionalProperties": false, - "required": ["name"] + "required": [ + "name" + ] }, "StatusCode": { "description": "HTTP status code (100-599)", @@ -2209,14 +2527,20 @@ "properties": { "exclude": { "description": "Packages to exclude as workspace members. If a package matches both `members` and\n`exclude`, it will be excluded.\n\nSupports both globs and explicit paths.\n\nFor more information on the glob syntax, refer to the [`glob` documentation](https://docs.rs/glob/latest/glob/struct.Pattern.html).", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/SerdePattern" } }, "members": { "description": "Packages to include as workspace members.\n\nSupports both globs and explicit paths.\n\nFor more information on the glob syntax, refer to the [`glob` documentation](https://docs.rs/glob/latest/glob/struct.Pattern.html).", - "type": ["array", "null"], + "type": [ + "array", + "null" + ], "items": { "$ref": "#/definitions/SerdePattern" } @@ -2467,7 +2791,10 @@ "oneOf": [ { "type": "string", - "enum": ["always", "never"] + "enum": [ + "always", + "never" + ] }, { "description": "Attempt trusted publishing when we're in a supported environment, continue if that fails.\n\nSupported environments include GitHub Actions and GitLab CI/CD.", @@ -2481,27 +2808,42 @@ "type": "object", "properties": { "data": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "default": null }, "headers": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "default": null }, "platlib": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "default": null }, "purelib": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "default": null }, "scripts": { - "type": ["string", "null"], + "type": [ + "string", + "null" + ], "default": null } }, "additionalProperties": false } } -} +} \ No newline at end of file From ab5f1cdb672dea1a4d9066a789721eb9931b576f Mon Sep 17 00:00:00 2001 From: j-helland Date: Sat, 20 Dec 2025 17:30:11 -0700 Subject: [PATCH 2/2] Add additional validation flow for configuration file settings. Specifically, disallow specifying both `preview` and `preview-features` in the config files. The implementation is intended to be extensible, should more validation rules be needed in the future. --- crates/uv-settings/src/lib.rs | 11 + crates/uv-settings/src/validation.rs | 48 ++ crates/uv/tests/it/show_settings.rs | 734 +++++++++------------------ uv.schema.json | 580 +++++---------------- 4 files changed, 411 insertions(+), 962 deletions(-) create mode 100644 crates/uv-settings/src/validation.rs diff --git a/crates/uv-settings/src/lib.rs b/crates/uv-settings/src/lib.rs index 52a2cbe631f..0799b1c362e 100644 --- a/crates/uv-settings/src/lib.rs +++ b/crates/uv-settings/src/lib.rs @@ -12,8 +12,11 @@ use uv_warnings::warn_user; pub use crate::combine::*; pub use crate::settings::*; +use crate::validation::{Context, ValidationError, Validator}; + mod combine; mod settings; +mod validation; /// The [`Options`] as loaded from a configuration file on disk. #[derive(Debug, Clone)] @@ -47,6 +50,7 @@ impl FilesystemOptions { match read_file(&file) { Ok(options) => { tracing::debug!("Found user configuration in: `{}`", file.display()); + options.validate(&Context { path: &file })?; validate_uv_toml(&file, &options)?; Ok(Some(Self(options))) } @@ -71,6 +75,7 @@ impl FilesystemOptions { tracing::debug!("Found system configuration in: `{}`", file.display()); let options = read_file(&file)?; + options.validate(&Context { path: &file })?; validate_uv_toml(&file, &options)?; Ok(Some(Self(options))) } @@ -130,6 +135,7 @@ impl FilesystemOptions { } tracing::debug!("Found workspace configuration at `{}`", path.display()); + options.validate(&Context { path: &path })?; validate_uv_toml(&path, &options)?; return Ok(Some(Self(options))); } @@ -162,6 +168,7 @@ impl FilesystemOptions { let options = options.relative_to(&std::path::absolute(dir)?)?; tracing::debug!("Found workspace configuration at `{}`", path.display()); + options.validate(&Context { path: &path })?; return Ok(Some(Self(options))); } Err(err) if err.kind() == std::io::ErrorKind::NotFound => {} @@ -177,6 +184,7 @@ impl FilesystemOptions { tracing::debug!("Reading user configuration from: `{}`", path.display()); let options = read_file(path)?; + options.validate(&Context { path })?; validate_uv_toml(path, &options)?; Ok(Self(options)) } @@ -577,6 +585,9 @@ pub enum Error { value: String, err: String, }, + + #[error(transparent)] + Validation(#[from] ValidationError), } #[derive(Copy, Clone, Debug)] diff --git a/crates/uv-settings/src/validation.rs b/crates/uv-settings/src/validation.rs new file mode 100644 index 00000000000..d927d2b94d6 --- /dev/null +++ b/crates/uv-settings/src/validation.rs @@ -0,0 +1,48 @@ +use std::path::{Path, PathBuf}; + +use uv_fs::Simplified; + +use crate::{GlobalOptions, Options}; + +pub(crate) trait Validator { + fn validate(&self, ctx: &Context) -> Result<(), Err>; +} + +pub(crate) struct Context<'p> { + pub path: &'p Path, +} + +impl<'path> Validator> for Options { + /// Validate that an [`Options`] struct has correct values. + fn validate(&self, ctx: &Context<'path>) -> Result<(), ValidationError> { + let Self { globals, .. } = self; + globals.validate(ctx) + } +} + +#[derive(thiserror::Error, Debug)] +pub enum ValidationError { + #[error(transparent)] + GlobalOptions(#[from] GlobalOptionsError), +} + +impl<'path> Validator> for GlobalOptions { + /// Validate that a [`GlobalOptions`] struct has correct values. + fn validate(&self, ctx: &Context<'path>) -> Result<(), ValidationError> { + let Self { + preview, + preview_features, + .. + } = self; + if preview.is_some() && preview_features.is_some() { + return Err(GlobalOptionsError::PreviewFeatures(ctx.path.to_path_buf()).into()); + } + Ok(()) + } +} + +#[derive(thiserror::Error, Debug)] +pub enum GlobalOptionsError { + #[error("Failed to parse: `{}`. Cannot specify both `preview` and `preview-features`.", _0.user_display())] + PreviewFeatures(PathBuf), +} diff --git a/crates/uv/tests/it/show_settings.rs b/crates/uv/tests/it/show_settings.rs index 60bedafe37a..fec8517d404 100644 --- a/crates/uv/tests/it/show_settings.rs +++ b/crates/uv/tests/it/show_settings.rs @@ -4334,6 +4334,201 @@ fn resolve_both_special_fields() -> anyhow::Result<()> { Ok(()) } +/// Parsing both `uv.toml` and `pyproject.toml` with invalid options in the ignored file succeeds with a warning. +#[test] +#[cfg_attr( + windows, + ignore = "Configuration tests are not yet supported on Windows" +)] +fn resolve_both_with_ignored_invalid_options() -> anyhow::Result<()> { + let context = TestContext::new("3.12"); + + let config = context.temp_dir.child("uv.toml"); + config.write_str(indoc::indoc! {r" + preview = false + "})?; + + // Invalid options in `pyproject.toml` will be ignored in favor of `uv.toml`. + let config = context.temp_dir.child("pyproject.toml"); + config.write_str(indoc::indoc! {r#" + [tool.uv] + preview = false + preview-features = ["pylock"] + "#})?; + + uv_snapshot!(context.filters(), add_shared_args(context.pip_compile(), context.temp_dir.path()) + .arg("--show-settings") + .arg("requirements.in"), @r#" + success: true + exit_code: 0 + ----- stdout ----- + GlobalSettings { + required_version: None, + quiet: 0, + verbose: 0, + color: Auto, + network_settings: NetworkSettings { + connectivity: Online, + native_tls: false, + allow_insecure_host: [], + timeout: [TIME], + retries: 3, + }, + concurrency: Concurrency { + downloads: 50, + builds: 16, + installs: 8, + }, + show_settings: true, + preview: Preview { + flags: PreviewFeatures( + 0x0, + ), + }, + python_preference: Managed, + python_downloads: Automatic, + no_progress: false, + installer_metadata: true, + } + CacheSettings { + no_cache: false, + cache_dir: Some( + "[CACHE_DIR]/", + ), + } + PipCompileSettings { + format: None, + src_file: [ + "requirements.in", + ], + constraints: [], + overrides: [], + excludes: [], + build_constraints: [], + constraints_from_workspace: [], + overrides_from_workspace: [], + excludes_from_workspace: [], + build_constraints_from_workspace: [], + environments: SupportedEnvironments( + [], + ), + refresh: None( + Timestamp( + SystemTime { + tv_sec: [TIME], + tv_nsec: [TIME], + }, + ), + ), + settings: PipSettings { + index_locations: IndexLocations { + indexes: [], + flat_index: [], + no_index: false, + }, + python: None, + install_mirrors: PythonInstallMirrors { + python_install_mirror: None, + pypy_install_mirror: None, + python_downloads_json_url: None, + }, + system: false, + extras: ExtrasSpecification( + ExtrasSpecificationInner { + include: Some( + [], + ), + exclude: [], + only_extras: false, + history: ExtrasSpecificationHistory { + extra: [], + only_extra: [], + no_extra: [], + all_extras: false, + no_default_extras: false, + defaults: List( + [], + ), + }, + }, + ), + groups: [], + break_system_packages: false, + target: None, + prefix: None, + index_strategy: FirstIndex, + keyring_provider: Disabled, + torch_backend: None, + build_isolation: Isolate, + extra_build_dependencies: ExtraBuildDependencies( + {}, + ), + extra_build_variables: ExtraBuildVariables( + {}, + ), + build_options: BuildOptions { + no_binary: None, + no_build: None, + }, + allow_empty_requirements: false, + strict: false, + dependency_mode: Transitive, + resolution: Highest, + prerelease: IfNecessaryOrExplicit, + fork_strategy: RequiresPython, + dependency_metadata: DependencyMetadata( + {}, + ), + output_file: None, + no_strip_extras: false, + no_strip_markers: false, + no_annotate: false, + no_header: false, + custom_compile_command: None, + generate_hashes: false, + config_setting: ConfigSettings( + {}, + ), + config_settings_package: PackageConfigSettings( + {}, + ), + python_version: None, + python_platform: None, + universal: false, + exclude_newer: ExcludeNewer { + global: None, + package: ExcludeNewerPackage( + {}, + ), + }, + no_emit_package: [], + emit_index_url: false, + emit_find_links: false, + emit_build_options: false, + emit_marker_expression: false, + emit_index_annotation: false, + annotation_style: Split, + link_mode: Clone, + compile_bytecode: false, + sources: Enabled, + hash_checking: Some( + Verify, + ), + upgrade: None, + reinstall: None, + }, + } + + ----- stderr ----- + warning: Found both a `uv.toml` file and a `[tool.uv]` section in an adjacent `pyproject.toml`. The following fields from `[tool.uv]` will be ignored in favor of the `uv.toml` file: + - preview + - preview-features + "# + ); + + Ok(()) +} + /// Tests that errors when parsing `conflicts` are reported. #[test] fn invalid_conflicts() -> anyhow::Result<()> { @@ -8530,8 +8725,33 @@ fn preview_features_precedence() -> anyhow::Result<()> { preview-features = ["format"] "#})?; - // `uv.tool.preview = false` disables all features regardless of `uv.tool.preview-features`. - uv_snapshot!(context.filters(), cmd(), @r#" + // Both `uv.tool.preview` and `uv.tool.preview-features` cannot both be specified. + uv_snapshot!(context.filters(), cmd(), @r" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + error: Failed to parse: `pyproject.toml`. Cannot specify both `preview` and `preview-features`. + " + ); + + let config = context.temp_dir.child("pyproject.toml"); + config.write_str( + r#" + [project] + name = "demo" + version = "0.1.0" + + [tool.uv] + preview-features = ["format"] + "#, + )?; + + // CLI `--preview` takes precedence over config settings. + uv_snapshot!(context.filters(), cmd() + .arg("--preview") + .arg("pylock"), @r#" success: true exit_code: 0 ----- stdout ----- @@ -8555,7 +8775,7 @@ fn preview_features_precedence() -> anyhow::Result<()> { show_settings: true, preview: Preview { flags: PreviewFeatures( - 0x0, + PYTHON_INSTALL_DEFAULT | PYTHON_UPGRADE | JSON_OUTPUT | PYLOCK | ADD_BOUNDS | PACKAGE_CONFLICTS | EXTRA_BUILD_DEPENDENCIES | DETECT_MODULE_CONFLICTS | FORMAT | NATIVE_AUTH | S3_ENDPOINT | CACHE_SIZE | INIT_PROJECT_FLAG | WORKSPACE_METADATA | WORKSPACE_DIR | WORKSPACE_LIST | SBOM_EXPORT | AUTH_HELPER, ), }, python_preference: Managed, @@ -8570,7 +8790,9 @@ fn preview_features_precedence() -> anyhow::Result<()> { ), } VersionSettings { - value: None, + value: Some( + "pylock", + ), bump: [], short: false, output_format: Text, @@ -8646,10 +8868,9 @@ fn preview_features_precedence() -> anyhow::Result<()> { "# ); - // `tool.uv.preview-features` will not merge with CLI `--preview-features` - // if `tool.uv.preview = false` + // CLI `--no-preview` takes precedence over config settings. uv_snapshot!(context.filters(), cmd() - .arg("--preview-features") + .arg("--no-preview") .arg("pylock"), @r#" success: true exit_code: 0 @@ -8674,7 +8895,7 @@ fn preview_features_precedence() -> anyhow::Result<()> { show_settings: true, preview: Preview { flags: PreviewFeatures( - PYLOCK, + 0x0, ), }, python_preference: Managed, @@ -8689,7 +8910,9 @@ fn preview_features_precedence() -> anyhow::Result<()> { ), } VersionSettings { - value: None, + value: Some( + "pylock", + ), bump: [], short: false, output_format: Text, @@ -8765,498 +8988,7 @@ fn preview_features_precedence() -> anyhow::Result<()> { "# ); - // CLI `--preview` takes precedence over configs settings. - uv_snapshot!(context.filters(), cmd().arg("--preview") , @r#" - success: true - exit_code: 0 - ----- stdout ----- - GlobalSettings { - required_version: None, - quiet: 0, - verbose: 0, - color: Auto, - network_settings: NetworkSettings { - connectivity: Online, - native_tls: false, - allow_insecure_host: [], - timeout: [TIME], - retries: 3, - }, - concurrency: Concurrency { - downloads: 50, - builds: 16, - installs: 8, - }, - show_settings: true, - preview: Preview { - flags: PreviewFeatures( - PYTHON_INSTALL_DEFAULT | PYTHON_UPGRADE | JSON_OUTPUT | PYLOCK | ADD_BOUNDS | PACKAGE_CONFLICTS | EXTRA_BUILD_DEPENDENCIES | DETECT_MODULE_CONFLICTS | FORMAT | NATIVE_AUTH | S3_ENDPOINT | CACHE_SIZE | INIT_PROJECT_FLAG | WORKSPACE_METADATA | WORKSPACE_DIR | WORKSPACE_LIST | SBOM_EXPORT | AUTH_HELPER, - ), - }, - python_preference: Managed, - python_downloads: Automatic, - no_progress: false, - installer_metadata: true, - } - CacheSettings { - no_cache: false, - cache_dir: Some( - "[CACHE_DIR]/", - ), - } - VersionSettings { - value: None, - bump: [], - short: false, - output_format: Text, - dry_run: false, - lock_check: Disabled, - frozen: false, - active: None, - no_sync: false, - package: None, - python: None, - install_mirrors: PythonInstallMirrors { - python_install_mirror: None, - pypy_install_mirror: None, - python_downloads_json_url: None, - }, - refresh: None( - Timestamp( - SystemTime { - tv_sec: [TIME], - tv_nsec: [TIME], - }, - ), - ), - settings: ResolverInstallerSettings { - resolver: ResolverSettings { - build_options: BuildOptions { - no_binary: None, - no_build: None, - }, - config_setting: ConfigSettings( - {}, - ), - config_settings_package: PackageConfigSettings( - {}, - ), - dependency_metadata: DependencyMetadata( - {}, - ), - exclude_newer: ExcludeNewer { - global: None, - package: ExcludeNewerPackage( - {}, - ), - }, - fork_strategy: RequiresPython, - index_locations: IndexLocations { - indexes: [], - flat_index: [], - no_index: false, - }, - index_strategy: FirstIndex, - keyring_provider: Disabled, - link_mode: Clone, - build_isolation: Isolate, - extra_build_dependencies: ExtraBuildDependencies( - {}, - ), - extra_build_variables: ExtraBuildVariables( - {}, - ), - prerelease: IfNecessaryOrExplicit, - resolution: Highest, - sources: Enabled, - torch_backend: None, - upgrade: None, - }, - compile_bytecode: false, - reinstall: None, - }, - } - - ----- stderr ----- - "# - ); - - let config = context.temp_dir.child("pyproject.toml"); - config.write_str( - r#" - [project] - name = "demo" - version = "0.1.0" - - [tool.uv] - preview = true - preview-features = ["format"] - "#, - )?; - - // `uv.tool.preview = true` enables all features, regardless of `uv.tool.preview-features` - uv_snapshot!(context.filters(), cmd(), @r#" - success: true - exit_code: 0 - ----- stdout ----- - GlobalSettings { - required_version: None, - quiet: 0, - verbose: 0, - color: Auto, - network_settings: NetworkSettings { - connectivity: Online, - native_tls: false, - allow_insecure_host: [], - timeout: [TIME], - retries: 3, - }, - concurrency: Concurrency { - downloads: 50, - builds: 16, - installs: 8, - }, - show_settings: true, - preview: Preview { - flags: PreviewFeatures( - PYTHON_INSTALL_DEFAULT | PYTHON_UPGRADE | JSON_OUTPUT | PYLOCK | ADD_BOUNDS | PACKAGE_CONFLICTS | EXTRA_BUILD_DEPENDENCIES | DETECT_MODULE_CONFLICTS | FORMAT | NATIVE_AUTH | S3_ENDPOINT | CACHE_SIZE | INIT_PROJECT_FLAG | WORKSPACE_METADATA | WORKSPACE_DIR | WORKSPACE_LIST | SBOM_EXPORT | AUTH_HELPER, - ), - }, - python_preference: Managed, - python_downloads: Automatic, - no_progress: false, - installer_metadata: true, - } - CacheSettings { - no_cache: false, - cache_dir: Some( - "[CACHE_DIR]/", - ), - } - VersionSettings { - value: None, - bump: [], - short: false, - output_format: Text, - dry_run: false, - lock_check: Disabled, - frozen: false, - active: None, - no_sync: false, - package: None, - python: None, - install_mirrors: PythonInstallMirrors { - python_install_mirror: None, - pypy_install_mirror: None, - python_downloads_json_url: None, - }, - refresh: None( - Timestamp( - SystemTime { - tv_sec: [TIME], - tv_nsec: [TIME], - }, - ), - ), - settings: ResolverInstallerSettings { - resolver: ResolverSettings { - build_options: BuildOptions { - no_binary: None, - no_build: None, - }, - config_setting: ConfigSettings( - {}, - ), - config_settings_package: PackageConfigSettings( - {}, - ), - dependency_metadata: DependencyMetadata( - {}, - ), - exclude_newer: ExcludeNewer { - global: None, - package: ExcludeNewerPackage( - {}, - ), - }, - fork_strategy: RequiresPython, - index_locations: IndexLocations { - indexes: [], - flat_index: [], - no_index: false, - }, - index_strategy: FirstIndex, - keyring_provider: Disabled, - link_mode: Clone, - build_isolation: Isolate, - extra_build_dependencies: ExtraBuildDependencies( - {}, - ), - extra_build_variables: ExtraBuildVariables( - {}, - ), - prerelease: IfNecessaryOrExplicit, - resolution: Highest, - sources: Enabled, - torch_backend: None, - upgrade: None, - }, - compile_bytecode: false, - reinstall: None, - }, - } - - ----- stderr ----- - "# - ); - - // CLI `--preview-features` takes precedence over `uv.tool.preview = true`. - uv_snapshot!(context.filters(), cmd() - .arg("--preview-features") - .arg("pylock"), @r#" - success: true - exit_code: 0 - ----- stdout ----- - GlobalSettings { - required_version: None, - quiet: 0, - verbose: 0, - color: Auto, - network_settings: NetworkSettings { - connectivity: Online, - native_tls: false, - allow_insecure_host: [], - timeout: [TIME], - retries: 3, - }, - concurrency: Concurrency { - downloads: 50, - builds: 16, - installs: 8, - }, - show_settings: true, - preview: Preview { - flags: PreviewFeatures( - PYLOCK, - ), - }, - python_preference: Managed, - python_downloads: Automatic, - no_progress: false, - installer_metadata: true, - } - CacheSettings { - no_cache: false, - cache_dir: Some( - "[CACHE_DIR]/", - ), - } - VersionSettings { - value: None, - bump: [], - short: false, - output_format: Text, - dry_run: false, - lock_check: Disabled, - frozen: false, - active: None, - no_sync: false, - package: None, - python: None, - install_mirrors: PythonInstallMirrors { - python_install_mirror: None, - pypy_install_mirror: None, - python_downloads_json_url: None, - }, - refresh: None( - Timestamp( - SystemTime { - tv_sec: [TIME], - tv_nsec: [TIME], - }, - ), - ), - settings: ResolverInstallerSettings { - resolver: ResolverSettings { - build_options: BuildOptions { - no_binary: None, - no_build: None, - }, - config_setting: ConfigSettings( - {}, - ), - config_settings_package: PackageConfigSettings( - {}, - ), - dependency_metadata: DependencyMetadata( - {}, - ), - exclude_newer: ExcludeNewer { - global: None, - package: ExcludeNewerPackage( - {}, - ), - }, - fork_strategy: RequiresPython, - index_locations: IndexLocations { - indexes: [], - flat_index: [], - no_index: false, - }, - index_strategy: FirstIndex, - keyring_provider: Disabled, - link_mode: Clone, - build_isolation: Isolate, - extra_build_dependencies: ExtraBuildDependencies( - {}, - ), - extra_build_variables: ExtraBuildVariables( - {}, - ), - prerelease: IfNecessaryOrExplicit, - resolution: Highest, - sources: Enabled, - torch_backend: None, - upgrade: None, - }, - compile_bytecode: false, - reinstall: None, - }, - } - - ----- stderr ----- - "# - ); - - // CLI `--no-preview` takes precedence over config settings. - uv_snapshot!(context.filters(), cmd().arg("--no-preview"), @r#" - success: true - exit_code: 0 - ----- stdout ----- - GlobalSettings { - required_version: None, - quiet: 0, - verbose: 0, - color: Auto, - network_settings: NetworkSettings { - connectivity: Online, - native_tls: false, - allow_insecure_host: [], - timeout: [TIME], - retries: 3, - }, - concurrency: Concurrency { - downloads: 50, - builds: 16, - installs: 8, - }, - show_settings: true, - preview: Preview { - flags: PreviewFeatures( - 0x0, - ), - }, - python_preference: Managed, - python_downloads: Automatic, - no_progress: false, - installer_metadata: true, - } - CacheSettings { - no_cache: false, - cache_dir: Some( - "[CACHE_DIR]/", - ), - } - VersionSettings { - value: None, - bump: [], - short: false, - output_format: Text, - dry_run: false, - lock_check: Disabled, - frozen: false, - active: None, - no_sync: false, - package: None, - python: None, - install_mirrors: PythonInstallMirrors { - python_install_mirror: None, - pypy_install_mirror: None, - python_downloads_json_url: None, - }, - refresh: None( - Timestamp( - SystemTime { - tv_sec: [TIME], - tv_nsec: [TIME], - }, - ), - ), - settings: ResolverInstallerSettings { - resolver: ResolverSettings { - build_options: BuildOptions { - no_binary: None, - no_build: None, - }, - config_setting: ConfigSettings( - {}, - ), - config_settings_package: PackageConfigSettings( - {}, - ), - dependency_metadata: DependencyMetadata( - {}, - ), - exclude_newer: ExcludeNewer { - global: None, - package: ExcludeNewerPackage( - {}, - ), - }, - fork_strategy: RequiresPython, - index_locations: IndexLocations { - indexes: [], - flat_index: [], - no_index: false, - }, - index_strategy: FirstIndex, - keyring_provider: Disabled, - link_mode: Clone, - build_isolation: Isolate, - extra_build_dependencies: ExtraBuildDependencies( - {}, - ), - extra_build_variables: ExtraBuildVariables( - {}, - ), - prerelease: IfNecessaryOrExplicit, - resolution: Highest, - sources: Enabled, - torch_backend: None, - upgrade: None, - }, - compile_bytecode: false, - reinstall: None, - }, - } - - ----- stderr ----- - "# - ); - - let config = context.temp_dir.child("pyproject.toml"); - config.write_str( - r#" - [project] - name = "demo" - version = "0.1.0" - - [tool.uv] - preview-features = ["format"] - "#, - )?; - - // CLI `--preview-features` takes precedence over `uv.tool.preview-features` + // CLI `--preview-features` takes precedence over config settings. uv_snapshot!(context.filters(), cmd() .arg("--preview-features") .arg("pylock"), @r#" diff --git a/uv.schema.json b/uv.schema.json index 467cf340f7f..859f4993f41 100644 --- a/uv.schema.json +++ b/uv.schema.json @@ -17,10 +17,7 @@ }, "allow-insecure-host": { "description": "Allow insecure connections to host.\n\nExpects to receive either a hostname (e.g., `localhost`), a host-port pair (e.g.,\n`localhost:8080`), or a URL (e.g., `https://localhost`).\n\nWARNING: Hosts included in this list will not be verified against the system's certificate\nstore. Only use `--allow-insecure-host` in a secure network with verified sources, as it\nbypasses SSL verification and could expose you to MITM attacks.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/TrustedHost" } @@ -38,27 +35,18 @@ }, "build-constraint-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } }, "cache-dir": { "description": "Path to the cache directory.\n\nDefaults to `$XDG_CACHE_HOME/uv` or `$HOME/.cache/uv` on Linux and macOS, and\n`%LOCALAPPDATA%\\uv\\cache` on Windows.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "cache-keys": { "description": "The keys to consider when caching builds for the project.\n\nCache keys enable you to specify the files or directories that should trigger a rebuild when\nmodified. By default, uv will rebuild a project whenever the `pyproject.toml`, `setup.py`,\nor `setup.cfg` files in the project directory are modified, or if a `src` directory is\nadded or removed, i.e.:\n\n```toml\ncache-keys = [{ file = \"pyproject.toml\" }, { file = \"setup.py\" }, { file = \"setup.cfg\" }, { dir = \"src\" }]\n```\n\nAs an example: if a project uses dynamic metadata to read its dependencies from a\n`requirements.txt` file, you can specify `cache-keys = [{ file = \"requirements.txt\" }, { file = \"pyproject.toml\" }]`\nto ensure that the project is rebuilt whenever the `requirements.txt` file is modified (in\naddition to watching the `pyproject.toml`).\n\nGlobs are supported, following the syntax of the [`glob`](https://docs.rs/glob/0.3.1/glob/struct.Pattern.html)\ncrate. For example, to invalidate the cache whenever a `.toml` file in the project directory\nor any of its subdirectories is modified, you can specify `cache-keys = [{ file = \"**/*.toml\" }]`.\nNote that the use of globs can be expensive, as uv may need to walk the filesystem to\ndetermine whether any files have changed.\n\nCache keys can also include version control information. For example, if a project uses\n`setuptools_scm` to read its version from a Git commit, you can specify `cache-keys = [{ git = { commit = true }, { file = \"pyproject.toml\" }]`\nto include the current Git commit hash in the cache key (in addition to the\n`pyproject.toml`). Git tags are also supported via `cache-keys = [{ git = { commit = true, tags = true } }]`.\n\nCache keys can also include environment variables. For example, if a project relies on\n`MACOSX_DEPLOYMENT_TARGET` or other environment variables to determine its behavior, you can\nspecify `cache-keys = [{ env = \"MACOSX_DEPLOYMENT_TARGET\" }]` to invalidate the cache\nwhenever the environment variable changes.\n\nCache keys only affect the project defined by the `pyproject.toml` in which they're\nspecified (as opposed to, e.g., affecting all members in a workspace), and all paths and\nglobs are interpreted as relative to the project directory.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/CacheKey" } @@ -76,35 +64,23 @@ }, "compile-bytecode": { "description": "Compile Python files to bytecode after installation.\n\nBy default, uv does not compile Python (`.py`) files to bytecode (`__pycache__/*.pyc`);\ninstead, compilation is performed lazily the first time a module is imported. For use-cases\nin which start time is critical, such as CLI applications and Docker containers, this option\ncan be enabled to trade longer installation times for faster start times.\n\nWhen enabled, uv will process the entire site-packages directory (including packages that\nare not being modified by the current operation) for consistency. Like pip, it will also\nignore errors.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "concurrent-builds": { "description": "The maximum number of source distributions that uv will build concurrently at any given\ntime.\n\nDefaults to the number of available CPU cores.", - "type": [ - "integer", - "null" - ], + "type": ["integer", "null"], "format": "uint", "minimum": 1 }, "concurrent-downloads": { "description": "The maximum number of in-flight concurrent downloads that uv will perform at any given\ntime.", - "type": [ - "integer", - "null" - ], + "type": ["integer", "null"], "format": "uint", "minimum": 1 }, "concurrent-installs": { "description": "The number of threads used when installing and unzipping packages.\n\nDefaults to the number of available CPU cores.", - "type": [ - "integer", - "null" - ], + "type": ["integer", "null"], "format": "uint", "minimum": 1 }, @@ -143,10 +119,7 @@ }, "constraint-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } @@ -175,40 +148,28 @@ }, "dependency-metadata": { "description": "Pre-defined static metadata for dependencies of the project (direct or transitive). When\nprovided, enables the resolver to use the specified metadata instead of querying the\nregistry or building the relevant package from source.\n\nMetadata should be provided in adherence with the [Metadata 2.3](https://packaging.python.org/en/latest/specifications/core-metadata/)\nstandard, though only the following fields are respected:\n\n- `name`: The name of the package.\n- (Optional) `version`: The version of the package. If omitted, the metadata will be applied\n to all versions of the package.\n- (Optional) `requires-dist`: The dependencies of the package (e.g., `werkzeug>=0.14`).\n- (Optional) `requires-python`: The Python version required by the package (e.g., `>=3.10`).\n- (Optional) `provides-extra`: The extras provided by the package.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/StaticMetadata" } }, "dev-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } }, "environments": { "description": "A list of environment markers, e.g., `python_version >= '3.6'`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } }, "exclude-dependencies": { "description": "Package names to exclude, e.g., `werkzeug`, `numpy`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } @@ -259,20 +220,14 @@ }, "extra-index-url": { "description": "Extra URLs of package indexes to use, in addition to `--index-url`.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nAll indexes provided via this flag take priority over the index specified by\n[`index_url`](#index-url) or [`index`](#index) with `default = true`. When multiple indexes\nare provided, earlier values take priority.\n\nTo control uv's resolution strategy when multiple indexes are present, see\n[`index_strategy`](#index-strategy).\n\n(Deprecated: use `index` instead.)", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/IndexUrl" } }, "find-links": { "description": "Locations to search for candidate distributions, in addition to those found in the registry\nindexes.\n\nIf a path, the target must be a directory that contains packages as wheel files (`.whl`) or\nsource distributions (e.g., `.tar.gz` or `.zip`) at the top level.\n\nIf a URL, the page must contain a flat list of links to package files adhering to the\nformats described above.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/IndexUrl" } @@ -290,10 +245,7 @@ }, "index": { "description": "The indexes to use when resolving dependencies.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nIndexes are considered in the order in which they're defined, such that the first-defined\nindex has the highest priority. Further, the indexes provided by this setting are given\nhigher priority than any indexes specified via [`index_url`](#index-url) or\n[`extra_index_url`](#extra-index-url). uv will only consider the first index that contains\na given package, unless an alternative [index strategy](#index-strategy) is specified.\n\nIf an index is marked as `explicit = true`, it will be used exclusively for the\ndependencies that select it explicitly via `[tool.uv.sources]`, as in:\n\n```toml\n[[tool.uv.index]]\nname = \"pytorch\"\nurl = \"https://download.pytorch.org/whl/cu121\"\nexplicit = true\n\n[tool.uv.sources]\ntorch = { index = \"pytorch\" }\n```\n\nIf an index is marked as `default = true`, it will be moved to the end of the prioritized list, such that it is\ngiven the lowest priority when resolving packages. Additionally, marking an index as default will disable the\nPyPI default index.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "default": null, "items": { "$ref": "#/definitions/Index" @@ -345,113 +297,71 @@ }, "managed": { "description": "Whether the project is managed by uv. If `false`, uv will ignore the project when\n`uv run` is invoked.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "native-tls": { "description": "Whether to load TLS certificates from the platform's native certificate store.\n\nBy default, uv loads certificates from the bundled `webpki-roots` crate. The\n`webpki-roots` are a reliable set of trust roots from Mozilla, and including them in uv\nimproves portability and performance (especially on macOS).\n\nHowever, in some cases, you may want to use the platform's native certificate store,\nespecially if you're relying on a corporate trust root (e.g., for a mandatory proxy) that's\nincluded in your system's certificate store.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-binary": { "description": "Don't install pre-built wheels.\n\nThe given packages will be built and installed from source. The resolver will still use\npre-built wheels to extract package metadata, if available.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-binary-package": { "description": "Don't install pre-built wheels for a specific package.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "no-build": { "description": "Don't build source distributions.\n\nWhen enabled, resolving will not run arbitrary Python code. The cached wheels of\nalready-built source distributions will be reused, but operations that require building\ndistributions will exit with an error.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-build-isolation": { "description": "Disable isolation when building source distributions.\n\nAssumes that build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-build-isolation-package": { "description": "Disable isolation when building source distributions for a specific package.\n\nAssumes that the packages' build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "no-build-package": { "description": "Don't build source distributions for a specific package.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "no-cache": { "description": "Avoid reading from or writing to the cache, instead using a temporary directory for the\nduration of the operation.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-index": { "description": "Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and\nthose provided via `--find-links`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-sources": { "description": "Ignore the `tool.uv.sources` table when resolving dependencies. Used to lock against the\nstandards-compliant, publishable package metadata, as opposed to using any local or Git\nsources.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "offline": { "description": "Disable network access, relying only on locally cached data and locally available files.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "override-dependencies": { "description": "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } }, "package": { "description": "Whether the project should be considered a Python package, or a non-package (\"virtual\")\nproject.\n\nPackages are built and installed into the virtual environment in editable mode and thus\nrequire a build backend, while virtual projects are _not_ built or installed; instead, only\ntheir dependencies are included in the virtual environment.\n\nCreating a package requires that a `build-system` is present in the `pyproject.toml`, and\nthat the project adheres to a structure that adheres to the build backend's expectations\n(e.g., a `src` layout).", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "pip": { "anyOf": [ @@ -498,10 +408,7 @@ }, "pypy-install-mirror": { "description": "Mirror URL to use for downloading managed PyPy installations.\n\nBy default, managed PyPy installations are downloaded from [downloads.python.org](https://downloads.python.org/).\nThis variable can be set to a mirror URL to use a different source for PyPy installations.\nThe provided URL will replace `https://downloads.python.org/pypy` in, e.g., `https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2`.\n\nDistributions can be read from a\nlocal directory by using the `file://` URL scheme.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "python-downloads": { "description": "Whether to allow Python downloads.", @@ -516,17 +423,11 @@ }, "python-downloads-json-url": { "description": "URL pointing to JSON of custom Python installations.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "python-install-mirror": { "description": "Mirror URL for downloading managed Python installations.\n\nBy default, managed Python installations are downloaded from [`python-build-standalone`](https://github.com/astral-sh/python-build-standalone).\nThis variable can be set to a mirror URL to use a different source for Python installations.\nThe provided URL will replace `https://github.com/astral-sh/python-build-standalone/releases/download` in, e.g., `https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz`.\n\nDistributions can be read from a local directory by using the `file://` URL scheme.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "python-preference": { "description": "Whether to prefer using Python installations that are already present on the system, or\nthose that are downloaded and installed by uv.", @@ -541,27 +442,18 @@ }, "reinstall": { "description": "Reinstall all packages, regardless of whether they're already installed. Implies `refresh`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "reinstall-package": { "description": "Reinstall a specific package, regardless of whether it's already installed. Implies\n`refresh-package`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "required-environments": { "description": "A list of environment markers, e.g., `sys_platform == 'darwin'.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "type": "string" } @@ -623,17 +515,11 @@ }, "upgrade": { "description": "Allow package upgrades, ignoring pinned versions in any existing output file.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "upgrade-package": { "description": "Allow upgrades for a specific package, ignoring pinned versions in any existing output\nfile.\n\nAccepts both standalone package names (`ruff`) and version specifiers (`ruff<0.5.0`).", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/Requirement" } @@ -799,9 +685,7 @@ } }, "additionalProperties": false, - "required": [ - "file" - ] + "required": ["file"] }, { "description": "Ex) `{ dir = \"src\" }`", @@ -812,9 +696,7 @@ } }, "additionalProperties": false, - "required": [ - "dir" - ] + "required": ["dir"] }, { "description": "Ex) `{ git = true }` or `{ git = { commit = true, tags = false } }`", @@ -825,9 +707,7 @@ } }, "additionalProperties": false, - "required": [ - "git" - ] + "required": ["git"] }, { "description": "Ex) `{ env = \"UV_CACHE_INFO\" }`", @@ -838,9 +718,7 @@ } }, "additionalProperties": false, - "required": [ - "env" - ] + "required": ["env"] } ] }, @@ -888,10 +766,7 @@ "properties": { "requires-python": { "description": "Version of python to require when installing this group", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] } } }, @@ -934,10 +809,7 @@ "$ref": "#/definitions/Requirement" } }, - "required": [ - "requirement", - "match-runtime" - ] + "required": ["requirement", "match-runtime"] } ] }, @@ -983,16 +855,10 @@ "type": "object", "properties": { "commit": { - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "tags": { - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] } }, "additionalProperties": false @@ -1046,10 +912,7 @@ }, "ignore-error-codes": { "description": "Status codes that uv should ignore when deciding whether\nto continue searching in the next index after a failure.\n\n```toml\n[[tool.uv.index]]\nname = \"my-index\"\nurl = \"https:///simple\"\nignore-error-codes = [401, 403]\n```", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "default": null, "items": { "$ref": "#/definitions/StatusCode" @@ -1086,9 +949,7 @@ ] } }, - "required": [ - "url" - ] + "required": ["url"] }, "IndexCacheControl": { "description": "Cache control configuration for an index.", @@ -1096,17 +957,11 @@ "properties": { "api": { "description": "Cache control header for Simple API requests.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "files": { "description": "Cache control header for file downloads.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] } } }, @@ -1234,15 +1089,10 @@ "$ref": "#/definitions/GroupName" }, "path": { - "type": [ - "string", - "null" - ] + "type": ["string", "null"] } }, - "required": [ - "name" - ] + "required": ["name"] }, "PipOptions": { "description": "Settings that are specific to the `uv pip` command-line interface.\n\nThese values will be ignored when running commands outside the `uv pip` namespace (e.g.,\n`uv lock`, `uvx`).", @@ -1250,17 +1100,11 @@ "properties": { "all-extras": { "description": "Include all optional dependencies.\n\nOnly applies to `pyproject.toml`, `setup.py`, and `setup.cfg` sources.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "allow-empty-requirements": { "description": "Allow `uv pip sync` with empty requirements, which will clear the environment of all\npackages.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "annotation-style": { "description": "The style of the annotation comments included in the output file, used to indicate the\nsource of each package.", @@ -1275,17 +1119,11 @@ }, "break-system-packages": { "description": "Allow uv to modify an `EXTERNALLY-MANAGED` Python installation.\n\nWARNING: `--break-system-packages` is intended for use in continuous integration (CI)\nenvironments, when installing into Python installations that are managed by an external\npackage manager, like `apt`. It should be used with caution, as such Python installations\nexplicitly recommend against modifications by other package managers (like uv or pip).", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "compile-bytecode": { "description": "Compile Python files to bytecode after installation.\n\nBy default, uv does not compile Python (`.py`) files to bytecode (`__pycache__/*.pyc`);\ninstead, compilation is performed lazily the first time a module is imported. For use-cases\nin which start time is critical, such as CLI applications and Docker containers, this option\ncan be enabled to trade longer installation times for faster start times.\n\nWhen enabled, uv will process the entire site-packages directory (including packages that\nare not being modified by the current operation) for consistency. Like pip, it will also\nignore errors.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "config-settings": { "description": "Settings to pass to the [PEP 517](https://peps.python.org/pep-0517/) build backend,\nspecified as `KEY=VALUE` pairs.", @@ -1311,55 +1149,34 @@ }, "custom-compile-command": { "description": "The header comment to include at the top of the output file generated by `uv pip compile`.\n\nUsed to reflect custom build scripts and commands that wrap `uv pip compile`.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "dependency-metadata": { "description": "Pre-defined static metadata for dependencies of the project (direct or transitive). When\nprovided, enables the resolver to use the specified metadata instead of querying the\nregistry or building the relevant package from source.\n\nMetadata should be provided in adherence with the [Metadata 2.3](https://packaging.python.org/en/latest/specifications/core-metadata/)\nstandard, though only the following fields are respected:\n\n- `name`: The name of the package.\n- (Optional) `version`: The version of the package. If omitted, the metadata will be applied\n to all versions of the package.\n- (Optional) `requires-dist`: The dependencies of the package (e.g., `werkzeug>=0.14`).\n- (Optional) `requires-python`: The Python version required by the package (e.g., `>=3.10`).\n- (Optional) `provides-extra`: The extras provided by the package.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/StaticMetadata" } }, "emit-build-options": { "description": "Include `--no-binary` and `--only-binary` entries in the output file generated by `uv pip compile`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "emit-find-links": { "description": "Include `--find-links` entries in the output file generated by `uv pip compile`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "emit-index-annotation": { "description": "Include comment annotations indicating the index used to resolve each package (e.g.,\n`# from https://pypi.org/simple`).", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "emit-index-url": { "description": "Include `--index-url` and `--extra-index-url` entries in the output file generated by `uv pip compile`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "emit-marker-expression": { "description": "Whether to emit a marker string indicating the conditions under which the set of pinned\ndependencies is valid.\n\nThe pinned dependencies may be valid even when the marker expression is\nfalse, but when the expression is true, the requirements are known to\nbe correct.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "exclude-newer": { "description": "Limit candidate packages to those that were uploaded prior to a given point in time.\n\nAccepts a superset of [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) (e.g.,\n`2006-12-02T02:07:43Z`). A full timestamp is required to ensure that the resolver will\nbehave consistently across timezones.", @@ -1385,10 +1202,7 @@ }, "extra": { "description": "Include optional dependencies from the specified extra; may be provided more than once.\n\nOnly applies to `pyproject.toml`, `setup.py`, and `setup.cfg` sources.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/ExtraName" } @@ -1417,20 +1231,14 @@ }, "extra-index-url": { "description": "Extra URLs of package indexes to use, in addition to `--index-url`.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)\n(the simple repository API), or a local directory laid out in the same format.\n\nAll indexes provided via this flag take priority over the index specified by\n[`index_url`](#index-url). When multiple indexes are provided, earlier values take priority.\n\nTo control uv's resolution strategy when multiple indexes are present, see\n[`index_strategy`](#index-strategy).", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/IndexUrl" } }, "find-links": { "description": "Locations to search for candidate distributions, in addition to those found in the registry\nindexes.\n\nIf a path, the target must be a directory that contains packages as wheel files (`.whl`) or\nsource distributions (e.g., `.tar.gz` or `.zip`) at the top level.\n\nIf a URL, the page must contain a flat list of links to package files adhering to the\nformats described above.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/IndexUrl" } @@ -1448,17 +1256,11 @@ }, "generate-hashes": { "description": "Include distribution hashes in the output file.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "group": { "description": "Include the following dependency groups.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PipGroupName" } @@ -1509,130 +1311,82 @@ }, "no-annotate": { "description": "Exclude comment annotations indicating the source of each package from the output file\ngenerated by `uv pip compile`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-binary": { "description": "Don't install pre-built wheels.\n\nThe given packages will be built and installed from source. The resolver will still use\npre-built wheels to extract package metadata, if available.\n\nMultiple packages may be provided. Disable binaries for all packages with `:all:`.\nClear previously specified packages with `:none:`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageNameSpecifier" } }, "no-build": { "description": "Don't build source distributions.\n\nWhen enabled, resolving will not run arbitrary Python code. The cached wheels of\nalready-built source distributions will be reused, but operations that require building\ndistributions will exit with an error.\n\nAlias for `--only-binary :all:`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-build-isolation": { "description": "Disable isolation when building source distributions.\n\nAssumes that build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-build-isolation-package": { "description": "Disable isolation when building source distributions for a specific package.\n\nAssumes that the packages' build dependencies specified by [PEP 518](https://peps.python.org/pep-0518/)\nare already installed.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "no-deps": { "description": "Ignore package dependencies, instead only add those packages explicitly listed\non the command line to the resulting requirements file.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-emit-package": { "description": "Specify a package to omit from the output resolution. Its dependencies will still be\nincluded in the resolution. Equivalent to pip-compile's `--unsafe-package` option.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "no-extra": { "description": "Exclude the specified optional dependencies if `all-extras` is supplied.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/ExtraName" } }, "no-header": { "description": "Exclude the comment header at the top of output file generated by `uv pip compile`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-index": { "description": "Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and\nthose provided via `--find-links`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-sources": { "description": "Ignore the `tool.uv.sources` table when resolving dependencies. Used to lock against the\nstandards-compliant, publishable package metadata, as opposed to using any local or Git\nsources.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-strip-extras": { "description": "Include extras in the output file.\n\nBy default, uv strips extras, as any packages pulled in by the extras are already included\nas dependencies in the output file directly. Further, output files generated with\n`--no-strip-extras` cannot be used as constraints files in `install` and `sync` invocations.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "no-strip-markers": { "description": "Include environment markers in the output file generated by `uv pip compile`.\n\nBy default, uv strips environment markers, as the resolution generated by `compile` is\nonly guaranteed to be correct for the target environment.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "only-binary": { "description": "Only use pre-built wheels; don't build source distributions.\n\nWhen enabled, resolving will not run code from the given packages. The cached wheels of already-built\nsource distributions will be reused, but operations that require building distributions will\nexit with an error.\n\nMultiple packages may be provided. Disable binaries for all packages with `:all:`.\nClear previously specified packages with `:none:`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageNameSpecifier" } }, "output-file": { "description": "Write the requirements generated by `uv pip compile` to the given `requirements.txt` file.\n\nIf the file already exists, the existing versions will be preferred when resolving\ndependencies, unless `--upgrade` is also specified.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "prefix": { "description": "Install packages into `lib`, `bin`, and other top-level folders under the specified\ndirectory, as if a virtual environment were present at that location.\n\nIn general, prefer the use of `--python` to install into an alternate environment, as\nscripts and other artifacts installed via `--prefix` will reference the installing\ninterpreter, rather than any interpreter added to the `--prefix` directory, rendering them\nnon-portable.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "prerelease": { "description": "The strategy to use when considering pre-release versions.\n\nBy default, uv will accept pre-releases for packages that _only_ publish pre-releases,\nalong with first-party requirements that contain an explicit pre-release marker in the\ndeclared specifiers (`if-necessary-or-explicit`).", @@ -1647,10 +1401,7 @@ }, "python": { "description": "The Python interpreter into which packages should be installed.\n\nBy default, uv installs into the virtual environment in the current working directory or\nany parent directory. The `--python` option allows you to specify a different interpreter,\nwhich is intended for use in continuous integration (CI) environments or other automated\nworkflows.\n\nSupported formats:\n- `3.10` looks for an installed Python 3.10 in the registry on Windows (see\n `py --list-paths`), or `python3.10` on Linux and macOS.\n- `python3.10` or `python.exe` looks for a binary with the given name in `PATH`.\n- `/home/ferris/.local/bin/python3.10` uses the exact Python at the given path.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "python-platform": { "description": "The platform for which requirements should be resolved.\n\nRepresented as a \"target triple\", a string that describes the target platform in terms of\nits CPU, vendor, and operating system name, like `x86_64-unknown-linux-gnu` or\n`aarch64-apple-darwin`.", @@ -1676,27 +1427,18 @@ }, "reinstall": { "description": "Reinstall all packages, regardless of whether they're already installed. Implies `refresh`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "reinstall-package": { "description": "Reinstall a specific package, regardless of whether it's already installed. Implies\n`refresh-package`.", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/PackageName" } }, "require-hashes": { "description": "Require a matching hash for each requirement.\n\nHash-checking mode is all or nothing. If enabled, _all_ requirements must be provided\nwith a corresponding hash or set of hashes. Additionally, if enabled, _all_ requirements\nmust either be pinned to exact versions (e.g., `==1.0.0`), or be specified via direct URL.\n\nHash-checking mode introduces a number of additional constraints:\n\n- Git dependencies are not supported.\n- Editable installations are not supported.\n- Local dependencies are not supported, unless they point to a specific wheel (`.whl`) or\n source archive (`.zip`, `.tar.gz`), as opposed to a directory.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "resolution": { "description": "The strategy to use when selecting between the different compatible versions for a given\npackage requirement.\n\nBy default, uv will use the latest compatible version of each package (`highest`).", @@ -1711,24 +1453,15 @@ }, "strict": { "description": "Validate the Python environment, to detect packages with missing dependencies and other\nissues.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "system": { "description": "Install packages into the system Python environment.\n\nBy default, uv installs into the virtual environment in the current working directory or\nany parent directory. The `--system` option instructs uv to instead use the first Python\nfound in the system `PATH`.\n\nWARNING: `--system` is intended for use in continuous integration (CI) environments and\nshould be used with caution, as it can modify the system Python installation.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "target": { "description": "Install packages into the specified directory, rather than into the virtual or system Python\nenvironment. The packages will be installed at the top-level of the directory.", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "torch-backend": { "description": "The backend to use when fetching packages in the PyTorch ecosystem.\n\nWhen set, uv will ignore the configured index URLs for packages in the PyTorch ecosystem,\nand will instead use the defined backend.\n\nFor example, when set to `cpu`, uv will use the CPU-only PyTorch index; when set to `cu126`,\nuv will use the PyTorch index for CUDA 12.6.\n\nThe `auto` mode will attempt to detect the appropriate PyTorch index based on the currently\ninstalled CUDA drivers.\n\nThis setting is only respected by `uv pip` commands.\n\nThis option is in preview and may change in any future release.", @@ -1743,34 +1476,22 @@ }, "universal": { "description": "Perform a universal resolution, attempting to generate a single `requirements.txt` output\nfile that is compatible with all operating systems, architectures, and Python\nimplementations.\n\nIn universal mode, the current Python version (or user-provided `--python-version`) will be\ntreated as a lower bound. For example, `--universal --python-version 3.7` would produce a\nuniversal resolution for Python 3.7 and later.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "upgrade": { "description": "Allow package upgrades, ignoring pinned versions in any existing output file.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "upgrade-package": { "description": "Allow upgrades for a specific package, ignoring pinned versions in any existing output\nfile.\n\nAccepts both standalone package names (`ruff`) and version specifiers (`ruff<0.5.0`).", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/Requirement" } }, "verify-hashes": { "description": "Validate any hashes provided in the requirements file.\n\nUnlike `--require-hashes`, `--verify-hashes` does not require that all requirements have\nhashes; instead, it will limit itself to verifying the hashes of those requirements that do\ninclude them.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] } }, "additionalProperties": false @@ -1969,10 +1690,7 @@ "type": "object", "properties": { "branch": { - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "extra": { "anyOf": [ @@ -2004,19 +1722,13 @@ }, "lfs": { "description": "Whether to use Git LFS when cloning the repository.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "marker": { "$ref": "#/definitions/MarkerTree" }, "rev": { - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "subdirectory": { "description": "The path to the directory with the `pyproject.toml`, if it's not in the archive root.", @@ -2030,16 +1742,11 @@ ] }, "tag": { - "type": [ - "string", - "null" - ] + "type": ["string", "null"] } }, "additionalProperties": false, - "required": [ - "git" - ] + "required": ["git"] }, { "description": "A remote `http://` or `https://` URL, either a wheel (`.whl`) or a source distribution\n(`.zip`, `.tar.gz`).\n\nExample:\n```toml\nflask = { url = \"https://files.pythonhosted.org/packages/61/80/ffe1da13ad9300f87c93af113edd0638c75138c42a0994becfacac078c06/flask-3.0.3-py3-none-any.whl\" }\n```", @@ -2084,9 +1791,7 @@ } }, "additionalProperties": false, - "required": [ - "url" - ] + "required": ["url"] }, { "description": "The path to a dependency, either a wheel (a `.whl` file), source distribution (a `.zip` or\n`.tar.gz` file), or source tree (i.e., a directory containing a `pyproject.toml` or\n`setup.py` file in the root).", @@ -2094,10 +1799,7 @@ "properties": { "editable": { "description": "`false` by default.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "extra": { "anyOf": [ @@ -2124,19 +1826,14 @@ }, "package": { "description": "Whether to treat the dependency as a buildable Python package (`true`) or as a virtual\npackage (`false`). If `false`, the package will not be built or installed, but its\ndependencies will be included in the virtual environment.\n\nWhen omitted, the package status is inferred based on the presence of a `[build-system]`\nin the project's `pyproject.toml`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "path": { "$ref": "#/definitions/PortablePathBuf" } }, "additionalProperties": false, - "required": [ - "path" - ] + "required": ["path"] }, { "description": "A dependency pinned to a specific index, e.g., `torch` after setting `torch` to `https://download.pytorch.org/whl/cu118`.", @@ -2170,9 +1867,7 @@ } }, "additionalProperties": false, - "required": [ - "index" - ] + "required": ["index"] }, { "description": "A dependency on another package in the workspace.", @@ -2180,10 +1875,7 @@ "properties": { "editable": { "description": "Whether the package should be installed as editable. Defaults to `true`.", - "type": [ - "boolean", - "null" - ] + "type": ["boolean", "null"] }, "extra": { "anyOf": [ @@ -2214,9 +1906,7 @@ } }, "additionalProperties": false, - "required": [ - "workspace" - ] + "required": ["workspace"] } ] }, @@ -2256,23 +1946,15 @@ }, "requires-python": { "description": "PEP 508-style Python requirement, e.g., `>=3.10`", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] }, "version": { "description": "PEP 440-style package version, e.g., `1.2.3`", - "type": [ - "string", - "null" - ] + "type": ["string", "null"] } }, "additionalProperties": false, - "required": [ - "name" - ] + "required": ["name"] }, "StatusCode": { "description": "HTTP status code (100-599)", @@ -2527,20 +2209,14 @@ "properties": { "exclude": { "description": "Packages to exclude as workspace members. If a package matches both `members` and\n`exclude`, it will be excluded.\n\nSupports both globs and explicit paths.\n\nFor more information on the glob syntax, refer to the [`glob` documentation](https://docs.rs/glob/latest/glob/struct.Pattern.html).", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/SerdePattern" } }, "members": { "description": "Packages to include as workspace members.\n\nSupports both globs and explicit paths.\n\nFor more information on the glob syntax, refer to the [`glob` documentation](https://docs.rs/glob/latest/glob/struct.Pattern.html).", - "type": [ - "array", - "null" - ], + "type": ["array", "null"], "items": { "$ref": "#/definitions/SerdePattern" } @@ -2791,10 +2467,7 @@ "oneOf": [ { "type": "string", - "enum": [ - "always", - "never" - ] + "enum": ["always", "never"] }, { "description": "Attempt trusted publishing when we're in a supported environment, continue if that fails.\n\nSupported environments include GitHub Actions and GitLab CI/CD.", @@ -2808,42 +2481,27 @@ "type": "object", "properties": { "data": { - "type": [ - "string", - "null" - ], + "type": ["string", "null"], "default": null }, "headers": { - "type": [ - "string", - "null" - ], + "type": ["string", "null"], "default": null }, "platlib": { - "type": [ - "string", - "null" - ], + "type": ["string", "null"], "default": null }, "purelib": { - "type": [ - "string", - "null" - ], + "type": ["string", "null"], "default": null }, "scripts": { - "type": [ - "string", - "null" - ], + "type": ["string", "null"], "default": null } }, "additionalProperties": false } } -} \ No newline at end of file +}