uv_settings/
lib.rs

1use std::num::NonZeroUsize;
2use std::ops::Deref;
3use std::path::{Path, PathBuf};
4use std::str::FromStr;
5use std::time::Duration;
6use tracing::info_span;
7use uv_client::{DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT, DEFAULT_READ_TIMEOUT_UPLOAD};
8use uv_configuration::RequiredVersion;
9use uv_dirs::{system_config_file, user_config_dir};
10use uv_distribution_types::Origin;
11use uv_flags::EnvironmentFlags;
12use uv_fs::Simplified;
13use uv_normalize::{GroupName, PackageName};
14use uv_pep440::Version;
15use uv_redacted::DisplaySafeUrl;
16use uv_static::{EnvVars, InvalidEnvironmentVariable, parse_boolish_environment_variable};
17use uv_torch::AmdGpuArchitecture;
18use uv_warnings::warn_user;
19
20pub use crate::combine::*;
21pub use crate::settings::*;
22
23mod combine;
24mod settings;
25
26/// The [`Options`] as loaded from a configuration file on disk.
27#[derive(Debug, Clone)]
28pub struct FilesystemOptions(Options);
29
30impl FilesystemOptions {
31    /// Convert the [`FilesystemOptions`] into [`Options`].
32    pub fn into_options(self) -> Options {
33        self.0
34    }
35}
36
37impl Deref for FilesystemOptions {
38    type Target = Options;
39
40    fn deref(&self) -> &Self::Target {
41        &self.0
42    }
43}
44
45impl FilesystemOptions {
46    /// Load the user [`FilesystemOptions`].
47    pub fn user() -> Result<Option<Self>, Error> {
48        let Some(dir) = user_config_dir() else {
49            return Ok(None);
50        };
51        let root = dir.join("uv");
52        let file = root.join("uv.toml");
53
54        tracing::debug!("Searching for user configuration in: `{}`", file.display());
55        match read_file(&file) {
56            Ok(options) => {
57                tracing::debug!("Found user configuration in: `{}`", file.display());
58                validate_uv_toml(&file, &options)?;
59                Ok(Some(Self(options.with_origin(Origin::User))))
60            }
61            Err(Error::Io(err))
62                if matches!(
63                    err.kind(),
64                    std::io::ErrorKind::NotFound
65                        | std::io::ErrorKind::NotADirectory
66                        | std::io::ErrorKind::PermissionDenied
67                ) =>
68            {
69                Ok(None)
70            }
71            Err(err) => Err(err),
72        }
73    }
74
75    pub fn system() -> Result<Option<Self>, Error> {
76        if parse_boolish_environment_variable(EnvVars::UV_NO_SYSTEM_CONFIG)? == Some(true) {
77            return Ok(None);
78        }
79
80        let Some(file) = system_config_file() else {
81            return Ok(None);
82        };
83
84        tracing::debug!("Found system configuration in: `{}`", file.display());
85        let options = read_file(&file)?;
86        validate_uv_toml(&file, &options)?;
87        Ok(Some(Self(options.with_origin(Origin::System))))
88    }
89
90    /// Find the [`FilesystemOptions`] for the given path.
91    ///
92    /// The search starts at the given path and goes up the directory tree until a `uv.toml` file or
93    /// `pyproject.toml` file is found.
94    pub fn find(path: &Path) -> Result<Option<Self>, Error> {
95        for ancestor in path.ancestors() {
96            match Self::from_directory(ancestor) {
97                Ok(Some(options)) => {
98                    return Ok(Some(options));
99                }
100                Ok(None) => {
101                    // Continue traversing the directory tree.
102                }
103                Err(Error::PyprojectToml(path, err)) => {
104                    // If we see an invalid `pyproject.toml`, warn but continue.
105                    warn_user!(
106                        "Failed to parse `{}` during settings discovery:\n{}",
107                        path.user_display().cyan(),
108                        textwrap::indent(&err.to_string(), "  ")
109                    );
110                }
111                Err(err) => {
112                    // Otherwise, warn and stop.
113                    return Err(err);
114                }
115            }
116        }
117        Ok(None)
118    }
119
120    /// Load a [`FilesystemOptions`] from a directory, preferring a `uv.toml` file over a
121    /// `pyproject.toml` file.
122    fn from_directory(dir: &Path) -> Result<Option<Self>, Error> {
123        // Read a `uv.toml` file in the current directory.
124        let path = dir.join("uv.toml");
125        match fs_err::read_to_string(&path) {
126            Ok(content) => {
127                let options =
128                    info_span!("toml::from_str filesystem options uv.toml", path = %path.display())
129                        .in_scope(|| toml::from_str::<Options>(&content))
130                        .map_err(|err| {
131                            check_uv_toml_required_version(
132                                &path,
133                                &content,
134                                Error::UvToml(path.clone(), Box::new(err)),
135                            )
136                        })?
137                        .relative_to(&std::path::absolute(dir)?)?;
138
139                // If the directory also contains a `[tool.uv]` table in a `pyproject.toml` file,
140                // warn.
141                let pyproject = dir.join("pyproject.toml");
142                if let Ok(content) = fs_err::read_to_string(&pyproject) {
143                    let result = info_span!("toml::from_str filesystem options pyproject.toml", path = %pyproject.display())
144                        .in_scope(|| toml::from_str::<PyProjectToml>(&content)).ok();
145                    if let Some(options) =
146                        result.and_then(|pyproject| pyproject.tool.and_then(|tool| tool.uv))
147                    {
148                        warn_uv_toml_masked_fields(&options);
149                    }
150                }
151
152                tracing::debug!("Found workspace configuration at `{}`", path.display());
153                validate_uv_toml(&path, &options)?;
154                return Ok(Some(Self(options.with_origin(Origin::Project))));
155            }
156            Err(err) if err.kind() == std::io::ErrorKind::NotFound => {}
157            Err(err) => return Err(err.into()),
158        }
159
160        // Read a `pyproject.toml` file in the current directory.
161        let path = dir.join("pyproject.toml");
162        match fs_err::read_to_string(&path) {
163            Ok(content) => {
164                // Parse, but skip any `pyproject.toml` that doesn't have a `[tool.uv]` section.
165                let pyproject =
166                    info_span!("toml::from_str filesystem options pyproject.toml", path = %path.display())
167                        .in_scope(|| toml::from_str::<PyProjectToml>(&content))
168                        .map_err(|err| {
169                            check_pyproject_required_version(&path, &content, err)
170                        })?;
171                let Some(tool) = pyproject.tool else {
172                    tracing::debug!(
173                        "Skipping `pyproject.toml` in `{}` (no `[tool]` section)",
174                        dir.display()
175                    );
176                    return Ok(None);
177                };
178                let Some(options) = tool.uv else {
179                    tracing::debug!(
180                        "Skipping `pyproject.toml` in `{}` (no `[tool.uv]` section)",
181                        dir.display()
182                    );
183                    return Ok(None);
184                };
185
186                let options = options.relative_to(&std::path::absolute(dir)?)?;
187
188                tracing::debug!("Found workspace configuration at `{}`", path.display());
189                return Ok(Some(Self(options)));
190            }
191            Err(err) if err.kind() == std::io::ErrorKind::NotFound => {}
192            Err(err) => return Err(err.into()),
193        }
194
195        Ok(None)
196    }
197
198    /// Load a [`FilesystemOptions`] from a `uv.toml` file.
199    pub fn from_file(path: impl AsRef<Path>) -> Result<Self, Error> {
200        let path = path.as_ref();
201        tracing::debug!("Reading user configuration from: `{}`", path.display());
202
203        let options = read_file(path)?;
204        validate_uv_toml(path, &options)?;
205        Ok(Self(options))
206    }
207}
208
209impl From<Options> for FilesystemOptions {
210    fn from(options: Options) -> Self {
211        Self(options)
212    }
213}
214
215/// Load [`Options`] from a `uv.toml` file.
216fn read_file(path: &Path) -> Result<Options, Error> {
217    let content = fs_err::read_to_string(path)?;
218    let options = info_span!("toml::from_str filesystem options uv.toml", path = %path.display())
219        .in_scope(|| toml::from_str::<Options>(&content))
220        .map_err(|err| {
221            check_uv_toml_required_version(
222                path,
223                &content,
224                Error::UvToml(path.to_path_buf(), Box::new(err)),
225            )
226        })?;
227    let options = if let Some(parent) = std::path::absolute(path)?.parent() {
228        options.relative_to(parent)?
229    } else {
230        options
231    };
232    Ok(options)
233}
234
235/// If `required_version` is set and incompatible with the running uv, return the corresponding
236/// [`Error::RequiredVersion`].
237fn required_version_mismatch(required_version: Option<RequiredVersion>) -> Option<Error> {
238    let required_version = required_version?;
239    let package_version = Version::from_str(uv_version::version())
240        .expect("uv crate version to be a valid PEP 440 version");
241    if required_version.contains(&package_version) {
242        None
243    } else {
244        Some(Error::RequiredVersion {
245            required_version,
246            package_version,
247        })
248    }
249}
250
251/// On a `pyproject.toml` settings parse error, check whether `tool.uv.required-version` should
252/// take precedence over that error.
253fn check_pyproject_required_version(path: &Path, content: &str, source: toml::de::Error) -> Error {
254    let fallback = || Error::PyprojectToml(path.to_path_buf(), Box::new(source));
255    let Ok(pyproject) = info_span!(
256        "toml::from_str filesystem required-version pyproject.toml",
257        path = %path.display()
258    )
259    .in_scope(|| toml::from_str::<PyProjectRequiredVersionToml>(content)) else {
260        return fallback();
261    };
262
263    let required_version = pyproject
264        .tool
265        .and_then(|tool| tool.uv)
266        .and_then(|uv| uv.required_version);
267    required_version_mismatch(required_version).unwrap_or_else(fallback)
268}
269
270/// On a `uv.toml` settings parse or schema error, check whether top-level `required-version`
271/// should take precedence over that error.
272fn check_uv_toml_required_version(path: &Path, content: &str, source: Error) -> Error {
273    let Ok(uv_toml) = info_span!(
274        "toml::from_str filesystem required-version uv.toml",
275        path = %path.display()
276    )
277    .in_scope(|| toml::from_str::<UvRequiredVersionToml>(content)) else {
278        return source;
279    };
280    required_version_mismatch(uv_toml.required_version).unwrap_or(source)
281}
282
283/// Validate that an [`Options`] schema is compatible with `uv.toml`.
284fn validate_uv_toml(path: &Path, options: &Options) -> Result<(), Error> {
285    // A `required-version` mismatch takes precedence over a schema error.
286    if let Some(err) = required_version_mismatch(options.globals.required_version.clone()) {
287        return Err(err);
288    }
289    let Options {
290        globals: _,
291        top_level: _,
292        install_mirrors: _,
293        publish: _,
294        add: _,
295        audit: _,
296        pip: _,
297        cache_keys: _,
298        override_dependencies: _,
299        exclude_dependencies: _,
300        constraint_dependencies: _,
301        build_constraint_dependencies: _,
302        environments,
303        required_environments,
304        conflicts,
305        workspace,
306        sources,
307        dev_dependencies,
308        default_groups,
309        dependency_groups,
310        managed,
311        package,
312        build_backend,
313    } = options;
314    // The `uv.toml` format is not allowed to include any of the following, which are
315    // permitted by the schema since they _can_ be included in `pyproject.toml` files
316    // (and we want to use `deny_unknown_fields`).
317    if conflicts.is_some() {
318        return Err(Error::PyprojectOnlyField(path.to_path_buf(), "conflicts"));
319    }
320    if workspace.is_some() {
321        return Err(Error::PyprojectOnlyField(path.to_path_buf(), "workspace"));
322    }
323    if sources.is_some() {
324        return Err(Error::PyprojectOnlyField(path.to_path_buf(), "sources"));
325    }
326    if dev_dependencies.is_some() {
327        return Err(Error::PyprojectOnlyField(
328            path.to_path_buf(),
329            "dev-dependencies",
330        ));
331    }
332    if default_groups.is_some() {
333        return Err(Error::PyprojectOnlyField(
334            path.to_path_buf(),
335            "default-groups",
336        ));
337    }
338    if dependency_groups.is_some() {
339        return Err(Error::PyprojectOnlyField(
340            path.to_path_buf(),
341            "dependency-groups",
342        ));
343    }
344    if managed.is_some() {
345        return Err(Error::PyprojectOnlyField(path.to_path_buf(), "managed"));
346    }
347    if package.is_some() {
348        return Err(Error::PyprojectOnlyField(path.to_path_buf(), "package"));
349    }
350    if build_backend.is_some() {
351        return Err(Error::PyprojectOnlyField(
352            path.to_path_buf(),
353            "build-backend",
354        ));
355    }
356    if environments.is_some() {
357        return Err(Error::PyprojectOnlyField(
358            path.to_path_buf(),
359            "environments",
360        ));
361    }
362    if required_environments.is_some() {
363        return Err(Error::PyprojectOnlyField(
364            path.to_path_buf(),
365            "required-environments",
366        ));
367    }
368    Ok(())
369}
370
371/// Validate that an [`Options`] contains no fields that `uv.toml` would mask
372///
373/// This is essentially the inverse of [`validate_uv_toml`].
374#[allow(deprecated)]
375fn warn_uv_toml_masked_fields(options: &Options) {
376    let Options {
377        globals:
378            GlobalOptions {
379                required_version,
380                system_certs,
381                native_tls,
382                offline,
383                no_cache,
384                cache_dir,
385                preview,
386                python_preference,
387                python_downloads,
388                concurrent_downloads,
389                concurrent_builds,
390                concurrent_installs,
391                allow_insecure_host,
392                http_proxy,
393                https_proxy,
394                no_proxy,
395            },
396        top_level:
397            ResolverInstallerSchema {
398                index,
399                index_url,
400                extra_index_url,
401                no_index,
402                find_links,
403                index_strategy,
404                keyring_provider,
405                resolution,
406                prerelease,
407                fork_strategy,
408                dependency_metadata,
409                config_settings,
410                config_settings_package,
411                no_build_isolation,
412                no_build_isolation_package,
413                extra_build_dependencies,
414                extra_build_variables,
415                exclude_newer,
416                exclude_newer_package,
417                link_mode,
418                compile_bytecode,
419                no_sources,
420                no_sources_package: _,
421                upgrade,
422                upgrade_package,
423                reinstall,
424                reinstall_package,
425                no_build,
426                no_build_package,
427                no_binary,
428                no_binary_package,
429                torch_backend,
430            },
431        install_mirrors:
432            PythonInstallMirrors {
433                python_install_mirror,
434                pypy_install_mirror,
435                python_downloads_json_url,
436            },
437        publish:
438            PublishOptions {
439                publish_url,
440                trusted_publishing,
441                check_url,
442            },
443        add: AddOptions { add_bounds },
444        audit: _,
445        pip,
446        cache_keys,
447        override_dependencies,
448        exclude_dependencies,
449        constraint_dependencies,
450        build_constraint_dependencies,
451        environments: _,
452        required_environments: _,
453        conflicts: _,
454        workspace: _,
455        sources: _,
456        dev_dependencies: _,
457        default_groups: _,
458        dependency_groups: _,
459        managed: _,
460        package: _,
461        build_backend: _,
462    } = options;
463
464    let mut masked_fields = vec![];
465
466    if required_version.is_some() {
467        masked_fields.push("required-version");
468    }
469    if system_certs.is_some() {
470        masked_fields.push("system-certs");
471    }
472    if native_tls.is_some() {
473        masked_fields.push("native-tls");
474    }
475    if offline.is_some() {
476        masked_fields.push("offline");
477    }
478    if no_cache.is_some() {
479        masked_fields.push("no-cache");
480    }
481    if cache_dir.is_some() {
482        masked_fields.push("cache-dir");
483    }
484    match preview {
485        Some(PreviewOption::Preview(_)) => masked_fields.push("preview"),
486        Some(PreviewOption::PreviewFeatures(_)) => masked_fields.push("preview-features"),
487        None => (),
488    }
489    if python_preference.is_some() {
490        masked_fields.push("python-preference");
491    }
492    if python_downloads.is_some() {
493        masked_fields.push("python-downloads");
494    }
495    if concurrent_downloads.is_some() {
496        masked_fields.push("concurrent-downloads");
497    }
498    if concurrent_builds.is_some() {
499        masked_fields.push("concurrent-builds");
500    }
501    if concurrent_installs.is_some() {
502        masked_fields.push("concurrent-installs");
503    }
504    if allow_insecure_host.is_some() {
505        masked_fields.push("allow-insecure-host");
506    }
507    if http_proxy.is_some() {
508        masked_fields.push("http-proxy");
509    }
510    if https_proxy.is_some() {
511        masked_fields.push("https-proxy");
512    }
513    if no_proxy.is_some() {
514        masked_fields.push("no-proxy");
515    }
516    if index.is_some() {
517        masked_fields.push("index");
518    }
519    if index_url.is_some() {
520        masked_fields.push("index-url");
521    }
522    if extra_index_url.is_some() {
523        masked_fields.push("extra-index-url");
524    }
525    if no_index.is_some() {
526        masked_fields.push("no-index");
527    }
528    if find_links.is_some() {
529        masked_fields.push("find-links");
530    }
531    if index_strategy.is_some() {
532        masked_fields.push("index-strategy");
533    }
534    if keyring_provider.is_some() {
535        masked_fields.push("keyring-provider");
536    }
537    if resolution.is_some() {
538        masked_fields.push("resolution");
539    }
540    if prerelease.is_some() {
541        masked_fields.push("prerelease");
542    }
543    if fork_strategy.is_some() {
544        masked_fields.push("fork-strategy");
545    }
546    if dependency_metadata.is_some() {
547        masked_fields.push("dependency-metadata");
548    }
549    if config_settings.is_some() {
550        masked_fields.push("config-settings");
551    }
552    if config_settings_package.is_some() {
553        masked_fields.push("config-settings-package");
554    }
555    if no_build_isolation.is_some() {
556        masked_fields.push("no-build-isolation");
557    }
558    if no_build_isolation_package.is_some() {
559        masked_fields.push("no-build-isolation-package");
560    }
561    if extra_build_dependencies.is_some() {
562        masked_fields.push("extra-build-dependencies");
563    }
564    if extra_build_variables.is_some() {
565        masked_fields.push("extra-build-variables");
566    }
567    if exclude_newer.is_some() {
568        masked_fields.push("exclude-newer");
569    }
570    if exclude_newer_package.is_some() {
571        masked_fields.push("exclude-newer-package");
572    }
573    if link_mode.is_some() {
574        masked_fields.push("link-mode");
575    }
576    if compile_bytecode.is_some() {
577        masked_fields.push("compile-bytecode");
578    }
579    if no_sources.is_some() {
580        masked_fields.push("no-sources");
581    }
582    if upgrade.is_some() {
583        masked_fields.push("upgrade");
584    }
585    if upgrade_package.is_some() {
586        masked_fields.push("upgrade-package");
587    }
588    if reinstall.is_some() {
589        masked_fields.push("reinstall");
590    }
591    if reinstall_package.is_some() {
592        masked_fields.push("reinstall-package");
593    }
594    if no_build.is_some() {
595        masked_fields.push("no-build");
596    }
597    if no_build_package.is_some() {
598        masked_fields.push("no-build-package");
599    }
600    if no_binary.is_some() {
601        masked_fields.push("no-binary");
602    }
603    if no_binary_package.is_some() {
604        masked_fields.push("no-binary-package");
605    }
606    if torch_backend.is_some() {
607        masked_fields.push("torch-backend");
608    }
609    if python_install_mirror.is_some() {
610        masked_fields.push("python-install-mirror");
611    }
612    if pypy_install_mirror.is_some() {
613        masked_fields.push("pypy-install-mirror");
614    }
615    if python_downloads_json_url.is_some() {
616        masked_fields.push("python-downloads-json-url");
617    }
618    if publish_url.is_some() {
619        masked_fields.push("publish-url");
620    }
621    if trusted_publishing.is_some() {
622        masked_fields.push("trusted-publishing");
623    }
624    if check_url.is_some() {
625        masked_fields.push("check-url");
626    }
627    if add_bounds.is_some() {
628        masked_fields.push("add-bounds");
629    }
630    if pip.is_some() {
631        masked_fields.push("pip");
632    }
633    if cache_keys.is_some() {
634        masked_fields.push("cache_keys");
635    }
636    if override_dependencies.is_some() {
637        masked_fields.push("override-dependencies");
638    }
639    if exclude_dependencies.is_some() {
640        masked_fields.push("exclude-dependencies");
641    }
642    if constraint_dependencies.is_some() {
643        masked_fields.push("constraint-dependencies");
644    }
645    if build_constraint_dependencies.is_some() {
646        masked_fields.push("build-constraint-dependencies");
647    }
648    if !masked_fields.is_empty() {
649        let field_listing = masked_fields.join("\n- ");
650        warn_user!(
651            "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:\n- {}",
652            field_listing,
653        );
654    }
655}
656
657#[derive(thiserror::Error, Debug)]
658pub enum Error {
659    #[error(transparent)]
660    Io(#[from] std::io::Error),
661
662    #[error(transparent)]
663    Index(#[from] uv_distribution_types::IndexUrlError),
664
665    #[error("Failed to parse: `{}`", _0.user_display())]
666    PyprojectToml(PathBuf, #[source] Box<toml::de::Error>),
667
668    #[error("Failed to parse: `{}`", _0.user_display())]
669    UvToml(PathBuf, #[source] Box<toml::de::Error>),
670
671    #[error("Failed to parse: `{}`. The `{}` field is not allowed in a `uv.toml` file. `{}` is only applicable in the context of a project, and should be placed in a `pyproject.toml` file instead.", _0.user_display(), _1, _1
672    )]
673    PyprojectOnlyField(PathBuf, &'static str),
674
675    #[error(
676        "Required uv version `{required_version}` does not match the running version `{package_version}`"
677    )]
678    RequiredVersion {
679        required_version: RequiredVersion,
680        package_version: Version,
681    },
682
683    #[error(transparent)]
684    InvalidEnvironmentVariable(#[from] InvalidEnvironmentVariable),
685}
686
687#[derive(Copy, Clone, Debug)]
688pub struct Concurrency {
689    pub downloads: Option<NonZeroUsize>,
690    pub builds: Option<NonZeroUsize>,
691    pub installs: Option<NonZeroUsize>,
692}
693
694/// A boolean flag parsed from an environment variable.
695///
696/// Stores both the value and the environment variable name for use in error messages.
697#[derive(Debug, Clone, Copy)]
698pub struct EnvFlag {
699    pub value: Option<bool>,
700    pub env_var: &'static str,
701}
702
703impl EnvFlag {
704    /// Create a new [`EnvFlag`] by parsing the given environment variable.
705    fn new(env_var: &'static str) -> Result<Self, Error> {
706        Ok(Self {
707            value: parse_boolish_environment_variable(env_var)?,
708            env_var,
709        })
710    }
711}
712
713/// Options loaded from environment variables.
714///
715/// This is currently a subset of all respected environment variables, most are parsed via Clap at
716/// the CLI level, however there are limited semantics in that context.
717#[derive(Debug, Clone)]
718pub struct EnvironmentOptions {
719    pub ruff_path: Option<PathBuf>,
720    pub ty_path: Option<PathBuf>,
721    pub skip_wheel_filename_check: Option<bool>,
722    pub hide_build_output: Option<bool>,
723    pub python_install_bin: Option<bool>,
724    pub python_install_registry: Option<bool>,
725    pub python_no_registry: EnvFlag,
726    pub install_mirrors: PythonInstallMirrors,
727    pub log_context: Option<bool>,
728    pub lfs: Option<bool>,
729    pub cuda_driver_version: Option<Version>,
730    pub amd_gpu_architecture: Option<AmdGpuArchitecture>,
731    pub http_connect_timeout: Duration,
732    pub http_read_timeout: Duration,
733    /// There's no upload timeout in reqwest, instead we have to use a read timeout as upload
734    /// timeout.
735    pub http_read_timeout_upload: Duration,
736    pub http_retries: u32,
737    pub concurrency: Concurrency,
738    #[cfg(feature = "tracing-durations-export")]
739    pub tracing_durations_file: Option<PathBuf>,
740    pub frozen: EnvFlag,
741    pub locked: EnvFlag,
742    pub offline: EnvFlag,
743    pub no_sync: EnvFlag,
744    pub managed_python: EnvFlag,
745    pub no_managed_python: EnvFlag,
746    pub native_tls: EnvFlag,
747    pub system_certs: EnvFlag,
748    pub preview: EnvFlag,
749    pub isolated: EnvFlag,
750    pub no_progress: EnvFlag,
751    pub no_installer_metadata: EnvFlag,
752    pub dev: EnvFlag,
753    pub no_dev: EnvFlag,
754    pub show_resolution: EnvFlag,
755    pub no_editable: EnvFlag,
756    pub no_install_project: EnvFlag,
757    pub no_install_workspace: EnvFlag,
758    pub no_install_local: EnvFlag,
759    pub only_install_project: EnvFlag,
760    pub only_install_workspace: EnvFlag,
761    pub only_install_local: EnvFlag,
762    pub no_env_file: EnvFlag,
763    pub no_group: Option<Vec<GroupName>>,
764    pub no_binary_package: Option<Vec<PackageName>>,
765    pub no_build_package: Option<Vec<PackageName>>,
766    pub no_sources_package: Option<Vec<PackageName>>,
767    pub venv_seed: EnvFlag,
768    pub venv_clear: EnvFlag,
769    pub venv_relocatable: EnvFlag,
770    pub init_bare: EnvFlag,
771    pub malware_check: EnvFlag,
772    pub malware_check_url: Option<DisplaySafeUrl>,
773}
774
775impl EnvironmentOptions {
776    /// Create a new [`EnvironmentOptions`] from environment variables.
777    pub fn new() -> Result<Self, Error> {
778        // Timeout options, matching https://doc.rust-lang.org/nightly/cargo/reference/config.html#httptimeout
779        // `UV_REQUEST_TIMEOUT` is provided for backwards compatibility with v0.1.6
780        let http_read_timeout = parse_integer_environment_variable(
781            EnvVars::UV_HTTP_TIMEOUT,
782            Some("value should be an integer number of seconds"),
783        )?
784        .or(parse_integer_environment_variable(
785            EnvVars::UV_REQUEST_TIMEOUT,
786            Some("value should be an integer number of seconds"),
787        )?)
788        .or(parse_integer_environment_variable(
789            EnvVars::HTTP_TIMEOUT,
790            Some("value should be an integer number of seconds"),
791        )?)
792        .map(Duration::from_secs);
793
794        Ok(Self {
795            ruff_path: parse_path_environment_variable(EnvVars::RUFF),
796            ty_path: parse_path_environment_variable(EnvVars::TY),
797            skip_wheel_filename_check: parse_boolish_environment_variable(
798                EnvVars::UV_SKIP_WHEEL_FILENAME_CHECK,
799            )?,
800            hide_build_output: parse_boolish_environment_variable(EnvVars::UV_HIDE_BUILD_OUTPUT)?,
801            python_install_bin: parse_boolish_environment_variable(EnvVars::UV_PYTHON_INSTALL_BIN)?,
802            python_install_registry: parse_boolish_environment_variable(
803                EnvVars::UV_PYTHON_INSTALL_REGISTRY,
804            )?,
805            python_no_registry: EnvFlag::new(EnvVars::UV_PYTHON_NO_REGISTRY)?,
806            concurrency: Concurrency {
807                downloads: parse_integer_environment_variable(
808                    EnvVars::UV_CONCURRENT_DOWNLOADS,
809                    None,
810                )?,
811                builds: parse_integer_environment_variable(EnvVars::UV_CONCURRENT_BUILDS, None)?,
812                installs: parse_integer_environment_variable(
813                    EnvVars::UV_CONCURRENT_INSTALLS,
814                    None,
815                )?,
816            },
817            install_mirrors: PythonInstallMirrors {
818                python_install_mirror: parse_string_environment_variable(
819                    EnvVars::UV_PYTHON_INSTALL_MIRROR,
820                )?,
821                pypy_install_mirror: parse_string_environment_variable(
822                    EnvVars::UV_PYPY_INSTALL_MIRROR,
823                )?,
824                python_downloads_json_url: parse_string_environment_variable(
825                    EnvVars::UV_PYTHON_DOWNLOADS_JSON_URL,
826                )?,
827            },
828            log_context: parse_boolish_environment_variable(EnvVars::UV_LOG_CONTEXT)?,
829            lfs: parse_boolish_environment_variable(EnvVars::UV_GIT_LFS)?,
830            cuda_driver_version: parse_typed_environment_variable(
831                EnvVars::UV_CUDA_DRIVER_VERSION,
832                None,
833            )?,
834            amd_gpu_architecture: parse_typed_environment_variable(
835                EnvVars::UV_AMD_GPU_ARCHITECTURE,
836                None,
837            )?,
838            http_read_timeout_upload: parse_integer_environment_variable(
839                EnvVars::UV_UPLOAD_HTTP_TIMEOUT,
840                Some("value should be an integer number of seconds"),
841            )?
842            .map(Duration::from_secs)
843            .or(http_read_timeout)
844            .unwrap_or(DEFAULT_READ_TIMEOUT_UPLOAD),
845            http_read_timeout: http_read_timeout.unwrap_or(DEFAULT_READ_TIMEOUT),
846            http_connect_timeout: parse_integer_environment_variable(
847                EnvVars::UV_HTTP_CONNECT_TIMEOUT,
848                Some("value should be an integer number of seconds"),
849            )?
850            .map(Duration::from_secs)
851            .unwrap_or(DEFAULT_CONNECT_TIMEOUT),
852            http_retries: parse_integer_environment_variable(EnvVars::UV_HTTP_RETRIES, None)?
853                .unwrap_or(uv_client::DEFAULT_RETRIES),
854            #[cfg(feature = "tracing-durations-export")]
855            tracing_durations_file: parse_path_environment_variable(
856                EnvVars::TRACING_DURATIONS_FILE,
857            ),
858            frozen: EnvFlag::new(EnvVars::UV_FROZEN)?,
859            locked: EnvFlag::new(EnvVars::UV_LOCKED)?,
860            offline: EnvFlag::new(EnvVars::UV_OFFLINE)?,
861            no_sync: EnvFlag::new(EnvVars::UV_NO_SYNC)?,
862            managed_python: EnvFlag::new(EnvVars::UV_MANAGED_PYTHON)?,
863            no_managed_python: EnvFlag::new(EnvVars::UV_NO_MANAGED_PYTHON)?,
864            native_tls: EnvFlag::new(EnvVars::UV_NATIVE_TLS)?,
865            system_certs: EnvFlag::new(EnvVars::UV_SYSTEM_CERTS)?,
866            preview: EnvFlag::new(EnvVars::UV_PREVIEW)?,
867            isolated: EnvFlag::new(EnvVars::UV_ISOLATED)?,
868            no_progress: EnvFlag::new(EnvVars::UV_NO_PROGRESS)?,
869            no_installer_metadata: EnvFlag::new(EnvVars::UV_NO_INSTALLER_METADATA)?,
870            dev: EnvFlag::new(EnvVars::UV_DEV)?,
871            no_dev: EnvFlag::new(EnvVars::UV_NO_DEV)?,
872            show_resolution: EnvFlag::new(EnvVars::UV_SHOW_RESOLUTION)?,
873            no_editable: EnvFlag::new(EnvVars::UV_NO_EDITABLE)?,
874            no_install_project: EnvFlag::new(EnvVars::UV_NO_INSTALL_PROJECT)?,
875            no_install_workspace: EnvFlag::new(EnvVars::UV_NO_INSTALL_WORKSPACE)?,
876            no_install_local: EnvFlag::new(EnvVars::UV_NO_INSTALL_LOCAL)?,
877            only_install_project: EnvFlag::new(EnvVars::UV_ONLY_INSTALL_PROJECT)?,
878            only_install_workspace: EnvFlag::new(EnvVars::UV_ONLY_INSTALL_WORKSPACE)?,
879            only_install_local: EnvFlag::new(EnvVars::UV_ONLY_INSTALL_LOCAL)?,
880            no_env_file: EnvFlag::new(EnvVars::UV_NO_ENV_FILE)?,
881            no_group: parse_name_list_environment_variable(EnvVars::UV_NO_GROUP)?,
882            no_binary_package: parse_name_list_environment_variable(EnvVars::UV_NO_BINARY_PACKAGE)?,
883            no_build_package: parse_name_list_environment_variable(EnvVars::UV_NO_BUILD_PACKAGE)?,
884            no_sources_package: parse_name_list_environment_variable(
885                EnvVars::UV_NO_SOURCES_PACKAGE,
886            )?,
887            venv_seed: EnvFlag::new(EnvVars::UV_VENV_SEED)?,
888            venv_clear: EnvFlag::new(EnvVars::UV_VENV_CLEAR)?,
889            venv_relocatable: EnvFlag::new(EnvVars::UV_VENV_RELOCATABLE)?,
890            init_bare: EnvFlag::new(EnvVars::UV_INIT_BARE)?,
891            malware_check: EnvFlag::new(EnvVars::UV_MALWARE_CHECK)?,
892            malware_check_url: parse_string_environment_variable(EnvVars::UV_MALWARE_CHECK_URL)?
893                .map(|value| {
894                    value.parse::<DisplaySafeUrl>().map_err(|err| {
895                        Error::InvalidEnvironmentVariable(InvalidEnvironmentVariable {
896                            name: EnvVars::UV_MALWARE_CHECK_URL.to_string(),
897                            value,
898                            err: err.to_string(),
899                        })
900                    })
901                })
902                .transpose()?,
903        })
904    }
905}
906
907/// Parse a string environment variable.
908fn parse_string_environment_variable(name: &'static str) -> Result<Option<String>, Error> {
909    match std::env::var(name) {
910        Ok(v) => {
911            if v.is_empty() {
912                Ok(None)
913            } else {
914                Ok(Some(v))
915            }
916        }
917        Err(e) => match e {
918            std::env::VarError::NotPresent => Ok(None),
919            std::env::VarError::NotUnicode(err) => Err(Error::InvalidEnvironmentVariable(
920                InvalidEnvironmentVariable {
921                    name: name.to_string(),
922                    value: err.to_string_lossy().to_string(),
923                    err: "expected a valid UTF-8 string".to_string(),
924                },
925            )),
926        },
927    }
928}
929
930/// Parse an environment variable containing a whitespace-delimited list of names.
931fn parse_name_list_environment_variable<T>(name: &'static str) -> Result<Option<Vec<T>>, Error>
932where
933    T: FromStr,
934    <T as FromStr>::Err: std::fmt::Display,
935{
936    let Some(value) = parse_string_environment_variable(name)? else {
937        return Ok(None);
938    };
939
940    let names = value
941        .split_whitespace()
942        .map(|entry| {
943            entry.parse::<T>().map_err(|err| {
944                Error::InvalidEnvironmentVariable(InvalidEnvironmentVariable {
945                    name: name.to_string(),
946                    value: value.clone(),
947                    err: err.to_string(),
948                })
949            })
950        })
951        .collect::<Result<Vec<_>, _>>()?;
952
953    if names.is_empty() {
954        Ok(None)
955    } else {
956        Ok(Some(names))
957    }
958}
959
960fn parse_typed_environment_variable<T>(
961    name: &'static str,
962    help: Option<&str>,
963) -> Result<Option<T>, Error>
964where
965    T: std::str::FromStr,
966    <T as std::str::FromStr>::Err: std::fmt::Display,
967{
968    let value = match std::env::var(name) {
969        Ok(v) => v,
970        Err(e) => {
971            return match e {
972                std::env::VarError::NotPresent => Ok(None),
973                std::env::VarError::NotUnicode(err) => Err(Error::InvalidEnvironmentVariable(
974                    InvalidEnvironmentVariable {
975                        name: name.to_string(),
976                        value: err.to_string_lossy().to_string(),
977                        err: "expected a valid UTF-8 string".to_string(),
978                    },
979                )),
980            };
981        }
982    };
983    if value.is_empty() {
984        return Ok(None);
985    }
986
987    match value.parse::<T>() {
988        Ok(v) => Ok(Some(v)),
989        Err(err) => Err(Error::InvalidEnvironmentVariable(
990            InvalidEnvironmentVariable {
991                name: name.to_string(),
992                value,
993                err: if let Some(help) = help {
994                    format!("{err}; {help}")
995                } else {
996                    err.to_string()
997                },
998            },
999        )),
1000    }
1001}
1002
1003fn parse_integer_environment_variable<T>(
1004    name: &'static str,
1005    help: Option<&str>,
1006) -> Result<Option<T>, Error>
1007where
1008    T: std::str::FromStr + Copy,
1009    <T as std::str::FromStr>::Err: std::fmt::Display,
1010{
1011    let value = match std::env::var(name) {
1012        Ok(v) => v,
1013        Err(e) => {
1014            return match e {
1015                std::env::VarError::NotPresent => Ok(None),
1016                std::env::VarError::NotUnicode(err) => Err(Error::InvalidEnvironmentVariable(
1017                    InvalidEnvironmentVariable {
1018                        name: name.to_string(),
1019                        value: err.to_string_lossy().to_string(),
1020                        err: "expected a valid UTF-8 string".to_string(),
1021                    },
1022                )),
1023            };
1024        }
1025    };
1026    if value.is_empty() {
1027        return Ok(None);
1028    }
1029
1030    match value.parse::<T>() {
1031        Ok(v) => Ok(Some(v)),
1032        Err(err) => Err(Error::InvalidEnvironmentVariable(
1033            InvalidEnvironmentVariable {
1034                name: name.to_string(),
1035                value,
1036                err: if let Some(help) = help {
1037                    format!("{err}; {help}")
1038                } else {
1039                    err.to_string()
1040                },
1041            },
1042        )),
1043    }
1044}
1045
1046/// Parse a path environment variable.
1047fn parse_path_environment_variable(name: &'static str) -> Option<PathBuf> {
1048    let value = std::env::var_os(name)?;
1049
1050    if value.is_empty() {
1051        return None;
1052    }
1053
1054    Some(PathBuf::from(value))
1055}
1056
1057/// Populate the [`EnvironmentFlags`] from the given [`EnvironmentOptions`].
1058impl From<&EnvironmentOptions> for EnvironmentFlags {
1059    fn from(options: &EnvironmentOptions) -> Self {
1060        let mut flags = Self::empty();
1061        if options.skip_wheel_filename_check == Some(true) {
1062            flags.insert(Self::SKIP_WHEEL_FILENAME_CHECK);
1063        }
1064        if options.hide_build_output == Some(true) {
1065            flags.insert(Self::HIDE_BUILD_OUTPUT);
1066        }
1067        flags
1068    }
1069}
uv_settings/lib.rs

uv_settings/
lib.rs
