diff --git a/crates/uv-settings/src/combine.rs b/crates/uv-settings/src/combine.rs index dfd39085e463..61cc7368feb7 100644 --- a/crates/uv-settings/src/combine.rs +++ b/crates/uv-settings/src/combine.rs @@ -1,5 +1,6 @@ use std::num::NonZeroUsize; use std::path::PathBuf; + use url::Url; use uv_configuration::{ @@ -124,3 +125,9 @@ impl Combine for serde::de::IgnoredAny { self } } + +impl Combine for Option { + fn combine(self, _other: Self) -> Self { + self + } +} diff --git a/crates/uv-settings/src/lib.rs b/crates/uv-settings/src/lib.rs index c493bbc66d23..367950bf656b 100644 --- a/crates/uv-settings/src/lib.rs +++ b/crates/uv-settings/src/lib.rs @@ -47,6 +47,7 @@ impl FilesystemOptions { match read_file(&file) { Ok(options) => { debug!("Found user configuration in: `{}`", file.display()); + validate_uv_toml(&file, &options)?; Ok(Some(Self(options))) } Err(Error::Io(err)) if err.kind() == std::io::ErrorKind::NotFound => Ok(None), @@ -83,11 +84,11 @@ impl FilesystemOptions { Ok(None) => { // Continue traversing the directory tree. } - Err(Error::PyprojectToml(file, err)) => { + Err(Error::PyprojectToml(path, err)) => { // If we see an invalid `pyproject.toml`, warn but continue. warn_user!( "Failed to parse `{}` during settings discovery:\n{}", - file.cyan(), + path.user_display().cyan(), textwrap::indent(&err.to_string(), " ") ); } @@ -108,7 +109,7 @@ impl FilesystemOptions { match fs_err::read_to_string(&path) { Ok(content) => { let options: Options = toml::from_str(&content) - .map_err(|err| Error::UvToml(path.user_display().to_string(), err))?; + .map_err(|err| Error::UvToml(path.clone(), Box::new(err)))?; // If the directory also contains a `[tool.uv]` table in a `pyproject.toml` file, // warn. @@ -125,6 +126,8 @@ impl FilesystemOptions { } debug!("Found workspace configuration at `{}`", path.display()); + + validate_uv_toml(&path, &options)?; return Ok(Some(Self(options))); } Err(err) if err.kind() == std::io::ErrorKind::NotFound => {} @@ -137,7 +140,7 @@ impl FilesystemOptions { Ok(content) => { // Parse, but skip any `pyproject.toml` that doesn't have a `[tool.uv]` section. let pyproject: PyProjectToml = toml::from_str(&content) - .map_err(|err| Error::PyprojectToml(path.user_display().to_string(), err))?; + .map_err(|err| Error::PyprojectToml(path.clone(), Box::new(err)))?; let Some(tool) = pyproject.tool else { debug!( "Skipping `pyproject.toml` in `{}` (no `[tool]` section)", @@ -238,21 +241,56 @@ fn system_config_file() -> Option { /// Load [`Options`] from a `uv.toml` file. fn read_file(path: &Path) -> Result { let content = fs_err::read_to_string(path)?; - let options: Options = toml::from_str(&content) - .map_err(|err| Error::UvToml(path.user_display().to_string(), err))?; + let options: Options = + toml::from_str(&content).map_err(|err| Error::UvToml(path.to_path_buf(), Box::new(err)))?; Ok(options) } +/// Validate that an [`Options`] schema is compatible with `uv.toml`. +fn validate_uv_toml(path: &Path, options: &Options) -> Result<(), Error> { + // The `uv.toml` format is not allowed to include any of the following, which are + // permitted by the schema since they _can_ be included in `pyproject.toml` files + // (and we want to use `deny_unknown_fields`). + if options.workspace.is_some() { + return Err(Error::PyprojectOnlyField(path.to_path_buf(), "workspace")); + } + if options.sources.is_some() { + return Err(Error::PyprojectOnlyField(path.to_path_buf(), "sources")); + } + if options.dev_dependencies.is_some() { + return Err(Error::PyprojectOnlyField( + path.to_path_buf(), + "dev-dependencies", + )); + } + if options.default_groups.is_some() { + return Err(Error::PyprojectOnlyField( + path.to_path_buf(), + "default-groups", + )); + } + if options.managed.is_some() { + return Err(Error::PyprojectOnlyField(path.to_path_buf(), "managed")); + } + if options.package.is_some() { + return Err(Error::PyprojectOnlyField(path.to_path_buf(), "package")); + } + Ok(()) +} + #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] Io(#[from] std::io::Error), - #[error("Failed to parse: `{0}`")] - PyprojectToml(String, #[source] toml::de::Error), + #[error("Failed to parse: `{}`", _0.user_display())] + PyprojectToml(PathBuf, #[source] Box), + + #[error("Failed to parse: `{}`", _0.user_display())] + UvToml(PathBuf, #[source] Box), - #[error("Failed to parse: `{0}`")] - UvToml(String, #[source] toml::de::Error), + #[error("Failed to parse: `{}`. The `{1}` field is not allowed in a `uv.toml` file. `{1}` is only applicable in the context of a project, and should be placed in a `pyproject.toml` file instead.", _0.user_display())] + PyprojectOnlyField(PathBuf, &'static str), } #[cfg(test)] diff --git a/crates/uv-settings/src/settings.rs b/crates/uv-settings/src/settings.rs index 6ccb7d5eb752..5e0ee6051f0d 100644 --- a/crates/uv-settings/src/settings.rs +++ b/crates/uv-settings/src/settings.rs @@ -86,7 +86,8 @@ pub struct Options { cache_keys: Option>, // NOTE(charlie): These fields are shared with `ToolUv` in - // `crates/uv-workspace/src/pyproject.rs`, and the documentation lives on that struct. + // `crates/uv-workspace/src/pyproject.rs`. The documentation lives on that struct. + // They're respected in both `pyproject.toml` and `uv.toml` files. #[cfg_attr(feature = "schemars", schemars(skip))] pub override_dependencies: Option>>, @@ -95,6 +96,27 @@ pub struct Options { #[cfg_attr(feature = "schemars", schemars(skip))] pub environments: Option, + + // NOTE(charlie): These fields should be kept in-sync with `ToolUv` in + // `crates/uv-workspace/src/pyproject.rs`. The documentation lives on that struct. + // They're only respected in `pyproject.toml` files, and should be rejected in `uv.toml` files. + #[cfg_attr(feature = "schemars", schemars(skip))] + pub workspace: Option, + + #[cfg_attr(feature = "schemars", schemars(skip))] + pub sources: Option, + + #[cfg_attr(feature = "schemars", schemars(skip))] + pub dev_dependencies: Option, + + #[cfg_attr(feature = "schemars", schemars(skip))] + pub default_groups: Option, + + #[cfg_attr(feature = "schemars", schemars(skip))] + pub managed: Option, + + #[cfg_attr(feature = "schemars", schemars(skip))] + pub r#package: Option, } impl Options { @@ -1551,24 +1573,20 @@ pub struct OptionsWire { cache_keys: Option>, // NOTE(charlie): These fields are shared with `ToolUv` in - // `crates/uv-workspace/src/pyproject.rs`, and the documentation lives on that struct. + // `crates/uv-workspace/src/pyproject.rs`. The documentation lives on that struct. + // They're respected in both `pyproject.toml` and `uv.toml` files. override_dependencies: Option>>, constraint_dependencies: Option>>, environments: Option, // NOTE(charlie): These fields should be kept in-sync with `ToolUv` in - // `crates/uv-workspace/src/pyproject.rs`. - #[allow(dead_code)] + // `crates/uv-workspace/src/pyproject.rs`. The documentation lives on that struct. + // They're only respected in `pyproject.toml` files, and should be rejected in `uv.toml` files. workspace: Option, - #[allow(dead_code)] sources: Option, - #[allow(dead_code)] managed: Option, - #[allow(dead_code)] r#package: Option, - #[allow(dead_code)] default_groups: Option, - #[allow(dead_code)] dev_dependencies: Option, } @@ -1618,12 +1636,12 @@ impl From for Options { environments, publish_url, trusted_publishing, - workspace: _, - sources: _, - managed: _, - package: _, - default_groups: _, - dev_dependencies: _, + workspace, + sources, + default_groups, + dev_dependencies, + managed, + package, } = value; Self { @@ -1667,15 +1685,21 @@ impl From for Options { no_binary, no_binary_package, }, - publish: PublishOptions { - publish_url, - trusted_publishing, - }, pip, cache_keys, override_dependencies, constraint_dependencies, environments, + publish: PublishOptions { + publish_url, + trusted_publishing, + }, + workspace, + sources, + dev_dependencies, + default_groups, + managed, + package, } } } diff --git a/crates/uv-workspace/src/pyproject.rs b/crates/uv-workspace/src/pyproject.rs index 10d077501c95..b7dfe409c89d 100644 --- a/crates/uv-workspace/src/pyproject.rs +++ b/crates/uv-workspace/src/pyproject.rs @@ -230,7 +230,7 @@ pub struct ToolUv { /// /// See [Dependencies](../concepts/dependencies.md) for more. #[option( - default = "\"[]\"", + default = "{}", value_type = "dict", example = r#" [tool.uv.sources] @@ -269,7 +269,7 @@ pub struct ToolUv { /// given the lowest priority when resolving packages. Additionally, marking an index as default will disable the /// PyPI default index. #[option( - default = "\"[]\"", + default = "[]", value_type = "dict", example = r#" [[tool.uv.index]] @@ -340,7 +340,7 @@ pub struct ToolUv { ) )] #[option( - default = r#"[]"#, + default = "[]", value_type = "list[str]", example = r#" dev-dependencies = ["ruff==0.5.0"] @@ -374,7 +374,7 @@ pub struct ToolUv { ) )] #[option( - default = r#"[]"#, + default = "[]", value_type = "list[str]", example = r#" # Always install Werkzeug 2.3.0, regardless of whether transitive dependencies request @@ -405,7 +405,7 @@ pub struct ToolUv { ) )] #[option( - default = r#"[]"#, + default = "[]", value_type = "list[str]", example = r#" # Ensure that the grpcio version is always less than 1.65, if it's requested by a @@ -431,7 +431,7 @@ pub struct ToolUv { ) )] #[option( - default = r#"[]"#, + default = "[]", value_type = "str | list[str]", example = r#" # Resolve for macOS, but not for Linux or Windows. @@ -511,7 +511,7 @@ pub struct ToolUvWorkspace { /// /// For more information on the glob syntax, refer to the [`glob` documentation](https://docs.rs/glob/latest/glob/struct.Pattern.html). #[option( - default = r#"[]"#, + default = "[]", value_type = "list[str]", example = r#" members = ["member1", "path/to/member2", "libs/*"] @@ -525,7 +525,7 @@ pub struct ToolUvWorkspace { /// /// For more information on the glob syntax, refer to the [`glob` documentation](https://docs.rs/glob/latest/glob/struct.Pattern.html). #[option( - default = r#"[]"#, + default = "[]", value_type = "list[str]", example = r#" exclude = ["member1", "path/to/member2", "libs/*"] diff --git a/crates/uv/tests/it/pip_install.rs b/crates/uv/tests/it/pip_install.rs index 1862e80e7759..6c18b305ee13 100644 --- a/crates/uv/tests/it/pip_install.rs +++ b/crates/uv/tests/it/pip_install.rs @@ -201,6 +201,28 @@ fn invalid_pyproject_toml_option_unknown_field() -> Result<()> { Ok(()) } +#[test] +fn invalid_uv_toml_option_disallowed() -> Result<()> { + let context = TestContext::new("3.12"); + let uv_toml = context.temp_dir.child("uv.toml"); + uv_toml.write_str(indoc! {r" + managed = true + "})?; + + uv_snapshot!(context.pip_install() + .arg("iniconfig"), @r###" + success: false + exit_code: 2 + ----- stdout ----- + + ----- stderr ----- + error: Failed to parse: `uv.toml`. The `managed` field is not allowed in a `uv.toml` file. `managed` is only applicable in the context of a project, and should be placed in a `pyproject.toml` file instead. + "### + ); + + Ok(()) +} + /// For indirect, non-user controlled pyproject.toml, we don't enforce correctness. /// /// If we fail to extract the PEP 621 metadata, we fall back to treating it as a source diff --git a/docs/reference/settings.md b/docs/reference/settings.md index 222eed8be524..43672ae1ebb5 100644 --- a/docs/reference/settings.md +++ b/docs/reference/settings.md @@ -127,7 +127,7 @@ If an index is marked as `default = true`, it will be moved to the end of the pr given the lowest priority when resolving packages. Additionally, marking an index as default will disable the PyPI default index. -**Default value**: `"[]"` +**Default value**: `[]` **Type**: `dict` @@ -232,7 +232,7 @@ alternative registry. See [Dependencies](../concepts/dependencies.md) for more. -**Default value**: `"[]"` +**Default value**: `{}` **Type**: `dict`