mirror of
https://github.com/astral-sh/uv.git
synced 2025-11-20 03:49:54 +00:00
01c44af3c3
## Summary This PR declares and documents all environment variables that are used in one way or another in `uv`, either internally, or externally, or transitively under a common struct. I think over time as uv has grown there's been many environment variables introduced. Its harder to know which ones exists, which ones are missing, what they're used for, or where are they used across the code. The docs only documents a handful of them, for others you'd have to dive into the code and inspect across crates to know which crates they're used on or where they're relevant. This PR is a starting attempt to unify them, make it easier to discover which ones we have, and maybe unlock future posibilities in automating generating documentation for them. I think we can split out into multiple structs later to better organize, but given the high influx of PR's and possibly new environment variables introduced/re-used, it would be hard to try to organize them all now into their proper namespaced struct while this is all happening given merge conflicts and/or keeping up to date. I don't think this has any impact on performance as they all should still be inlined, although it may affect local build times on changes to the environment vars as more crates would likely need a rebuild. Lastly, some of them are declared but not used in the code, for example those in `build.rs`. I left them declared because I still think it's useful to at least have a reference. Did I miss any? Are their initial docs cohesive? Note, `uv-static` is a terrible name for a new crate, thoughts? Others considered `uv-vars`, `uv-consts`. ## Test Plan Existing tests
89 lines
2.1 KiB
Text
89 lines
2.1 KiB
Text
//! DO NOT EDIT
|
|
//!
|
|
//! Generated with `{{generated_with}}`
|
|
//! Scenarios from <{{generated_from}}>
|
|
//!
|
|
#![cfg(all(feature = "python", feature = "pypi"))]
|
|
#![allow(clippy::needless_raw_string_hashes)]
|
|
#![allow(clippy::doc_markdown)]
|
|
#![allow(clippy::doc_lazy_continuation)]
|
|
|
|
use anyhow::Result;
|
|
use assert_cmd::assert::OutputAssertExt;
|
|
use assert_fs::prelude::*;
|
|
use insta::assert_snapshot;
|
|
|
|
use uv_static::EnvVars;
|
|
|
|
use crate::common::{packse_index_url, TestContext, uv_snapshot};
|
|
|
|
{{#scenarios}}
|
|
|
|
/// {{description}}
|
|
///
|
|
/// ```text
|
|
/// {{name}}
|
|
{{#tree}}
|
|
/// {{.}}
|
|
{{/tree}}
|
|
/// ```
|
|
#[test]
|
|
fn {{module_name}}() -> Result<()> {
|
|
let context = TestContext::new("{{environment.python}}");
|
|
|
|
// In addition to the standard filters, swap out package names for shorter messages
|
|
let mut filters = context.filters();
|
|
filters.push((r"{{name}}-", "package-"));
|
|
|
|
let pyproject_toml = context.temp_dir.child("pyproject.toml");
|
|
pyproject_toml.write_str(
|
|
r###"
|
|
[project]
|
|
name = "project"
|
|
version = "0.1.0"
|
|
dependencies = [
|
|
{{#root.requires}}
|
|
'''{{requirement}}''',
|
|
{{/root.requires}}
|
|
]
|
|
{{#root.requires_python}}
|
|
requires-python = "{{.}}"
|
|
{{/root.requires_python}}
|
|
"###
|
|
)?;
|
|
|
|
let mut cmd = context.lock();
|
|
cmd.env_remove(EnvVars::UV_EXCLUDE_NEWER);
|
|
cmd.arg("--index-url").arg(packse_index_url());
|
|
{{#expected.explanation}}
|
|
// {{expected.explanation}}
|
|
{{/expected.explanation}}
|
|
uv_snapshot!(filters, cmd, @r###"<snapshot>
|
|
"###
|
|
);
|
|
|
|
{{#expected.satisfiable}}
|
|
let lock = context.read("uv.lock");
|
|
insta::with_settings!({
|
|
filters => filters,
|
|
}, {
|
|
assert_snapshot!(
|
|
lock, @r###"<snapshot>
|
|
"###
|
|
);
|
|
});
|
|
|
|
// Assert the idempotence of `uv lock` when resolving from the lockfile (`--locked`).
|
|
context
|
|
.lock()
|
|
.arg("--locked")
|
|
.env_remove(EnvVars::UV_EXCLUDE_NEWER)
|
|
.arg("--index-url")
|
|
.arg(packse_index_url())
|
|
.assert()
|
|
.success();
|
|
{{/expected.satisfiable}}
|
|
|
|
Ok(())
|
|
}
|
|
{{/scenarios}}
|