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

uv_settings/
lib.rs
