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

uv_settings/
lib.rs
