Eliminate dependencies on directores and dirs-sys (#8048)

Migrate all directory related logic to `etcetera`, eliminated two dependecies.
astral-sh · Oct 21, 2024 · 1b77055 · 1b77055
1 parent 32c54c5
commit 1b77055
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 56 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -90,8 +90,6 @@ csv = { version = "1.3.0" }
 ctrlc = { version = "3.4.5" }
 dashmap = { version = "6.1.0" }
 data-encoding = { version = "2.6.0" }
-directories = { version = "5.0.1" }
-dirs-sys = { version = "0.4.1" }
 dunce = { version = "1.0.5" }
 either = { version = "1.13.0" }
 encoding_rs_io = { version = "0.1.7" }

diff --git a/crates/uv-cache/Cargo.toml b/crates/uv-cache/Cargo.toml
@@ -26,7 +26,6 @@ uv-pypi-types = { workspace = true }
 uv-static = { workspace = true }
 
 clap = { workspace = true, features = ["derive", "env"], optional = true }
-directories = { workspace = true }
 etcetera = { workspace = true }
 fs-err = { workspace = true, features = ["tokio"] }
 nanoid = { workspace = true }

diff --git a/crates/uv-cache/src/cli.rs b/crates/uv-cache/src/cli.rs
@@ -4,7 +4,6 @@ use uv_static::EnvVars;
 
 use crate::Cache;
 use clap::Parser;
-use directories::ProjectDirs;
 use etcetera::BaseStrategy;
 use tracing::{debug, warn};
 
@@ -31,6 +30,19 @@ pub struct CacheArgs {
     pub cache_dir: Option<PathBuf>,
 }
 
+fn legacy_cache_dir() -> Option<PathBuf> {
+    etcetera::base_strategy::choose_native_strategy()
+        .ok()
+        .map(|dirs| dirs.cache_dir().join("uv"))
+        .map(|dir| {
+            if cfg!(windows) {
+                dir.join("cache")
+            } else {
+                dir
+            }
+        })
+}
+
 impl Cache {
     /// Prefer, in order:
     ///
@@ -45,10 +57,7 @@ impl Cache {
             Self::temp()
         } else if let Some(cache_dir) = cache_dir {
             Ok(Self::from_path(cache_dir))
-        } else if let Some(cache_dir) = ProjectDirs::from("", "", "uv")
-            .map(|dirs| dirs.cache_dir().to_path_buf())
-            .filter(|dir| dir.exists())
-        {
+        } else if let Some(cache_dir) = legacy_cache_dir().filter(|dir| dir.exists()) {
             // If the user has an existing directory at (e.g.) `/Users/user/Library/Caches/uv`,
             // respect it for backwards compatibility. Otherwise, prefer the XDG strategy, even on
             // macOS.

diff --git a/crates/uv-settings/Cargo.toml b/crates/uv-settings/Cargo.toml
@@ -32,7 +32,7 @@ uv-static = { workspace = true }
 uv-warnings = { workspace = true }
 
 clap = { workspace = true }
-dirs-sys = { workspace = true }
+etcetera = { workspace = true }
 fs-err = { workspace = true }
 schemars = { workspace = true, optional = true }
 serde = { workspace = true }

diff --git a/crates/uv-settings/src/lib.rs b/crates/uv-settings/src/lib.rs
@@ -2,6 +2,7 @@ use std::env;
 use std::ops::Deref;
 use std::path::{Path, PathBuf};
 
+use etcetera::BaseStrategy;
 use tracing::debug;
 
 use uv_fs::Simplified;
@@ -176,23 +177,12 @@ impl From<Options> for FilesystemOptions {
 
 /// Returns the path to the user configuration directory.
 ///
-/// This is similar to the `config_dir()` returned by the `dirs` crate, but it uses the
-/// `XDG_CONFIG_HOME` environment variable on both Linux _and_ macOS, rather than the
-/// `Application Support` directory on macOS.
+/// On Windows, use, e.g., C:\Users\Alice\AppData\Roaming
+/// On Linux and macOS, use `XDG_CONFIG_HOME` or $HOME/.config, e.g., /home/alice/.config.
 fn user_config_dir() -> Option<PathBuf> {
-    // On Windows, use, e.g., `C:\Users\Alice\AppData\Roaming`.
-    #[cfg(windows)]
-    {
-        dirs_sys::known_folder_roaming_app_data()
-    }
-
-    // On Linux and macOS, use, e.g., `/home/alice/.config`.
-    #[cfg(not(windows))]
-    {
-        env::var_os(EnvVars::XDG_CONFIG_HOME)
-            .and_then(dirs_sys::is_absolute_path)
-            .or_else(|| dirs_sys::home_dir().map(|path| path.join(".config")))
-    }
+    etcetera::choose_base_strategy()
+        .map(|dirs| dirs.config_dir())
+        .ok()
 }
 
 #[cfg(not(windows))]

diff --git a/crates/uv-state/Cargo.toml b/crates/uv-state/Cargo.toml
@@ -16,7 +16,6 @@ doctest = false
 workspace = true
 
 [dependencies]
-directories = { workspace = true }
 etcetera = { workspace = true }
 tempfile = { workspace = true }
 fs-err = { workspace = true }
diff --git a/crates/uv-state/src/lib.rs b/crates/uv-state/src/lib.rs
@@ -4,7 +4,6 @@ use std::{
     sync::Arc,
 };
 
-use directories::ProjectDirs;
 use etcetera::BaseStrategy;
 use fs_err as fs;
 use tempfile::{tempdir, TempDir};
@@ -85,10 +84,7 @@ impl StateStore {
     pub fn from_settings(state_dir: Option<PathBuf>) -> Result<Self, io::Error> {
         if let Some(state_dir) = state_dir {
             StateStore::from_path(state_dir)
-        } else if let Some(data_dir) = ProjectDirs::from("", "", "uv")
-            .map(|dirs| dirs.data_dir().to_path_buf())
-            .filter(|dir| dir.exists())
-        {
+        } else if let Some(data_dir) = legacy_data_dir().filter(|dir| dir.exists()) {
             // If the user has an existing directory at (e.g.) `/Users/user/Library/Application Support/uv`,
             // respect it for backwards compatibility. Otherwise, prefer the XDG strategy, even on
             // macOS.
@@ -104,6 +100,13 @@ impl StateStore {
     }
 }
 
+fn legacy_data_dir() -> Option<PathBuf> {
+    etcetera::base_strategy::choose_native_strategy()
+        .ok()
+        .map(|dirs| dirs.data_dir().join("uv"))
+        .map(|dir| if cfg!(windows) { dir.join("data") } else { dir })
+}
+
 /// The different kinds of data in the state store are stored in different bucket, which in our case
 /// are subdirectories of the state store root.
 #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]

diff --git a/crates/uv-tool/Cargo.toml b/crates/uv-tool/Cargo.toml
@@ -29,7 +29,7 @@ uv-state = { workspace = true }
 uv-static = { workspace = true }
 uv-virtualenv = { workspace = true }
 
-dirs-sys = { workspace = true }
+etcetera = { workspace = true }
 fs-err = { workspace = true }
 pathdiff = { workspace = true }
 serde = { workspace = true }

diff --git a/crates/uv-tool/src/lib.rs b/crates/uv-tool/src/lib.rs
@@ -1,6 +1,6 @@
 use core::fmt;
-
 use fs_err as fs;
+use std::ffi::OsString;
 
 use uv_pep440::Version;
 use uv_pep508::{InvalidNameError, PackageName};
@@ -354,6 +354,15 @@ impl fmt::Display for InstalledTool {
     }
 }
 
+fn is_absolute_path(path: OsString) -> Option<PathBuf> {
+    let path = PathBuf::from(path);
+    if path.is_absolute() {
+        Some(path)
+    } else {
+        None
+    }
+}
+
 /// Find a directory to place executables in.
 ///
 /// This follows, in order:
@@ -368,20 +377,16 @@ impl fmt::Display for InstalledTool {
 /// Errors if a directory cannot be found.
 pub fn find_executable_directory() -> Result<PathBuf, Error> {
     std::env::var_os(EnvVars::UV_TOOL_BIN_DIR)
-        .and_then(dirs_sys::is_absolute_path)
-        .or_else(|| std::env::var_os(EnvVars::XDG_BIN_HOME).and_then(dirs_sys::is_absolute_path))
+        .and_then(is_absolute_path)
+        .or_else(|| std::env::var_os(EnvVars::XDG_BIN_HOME).and_then(is_absolute_path))
         .or_else(|| {
             std::env::var_os(EnvVars::XDG_DATA_HOME)
-                .and_then(dirs_sys::is_absolute_path)
+                .and_then(is_absolute_path)
                 .map(|path| path.join("../bin"))
         })
         .or_else(|| {
-            // See https://github.com/dirs-dev/dirs-rs/blob/50b50f31f3363b7656e5e63b3fa1060217cbc844/src/win.rs#L5C58-L5C78
-            #[cfg(windows)]
-            let home_dir = dirs_sys::known_folder_profile();
-            #[cfg(not(windows))]
-            let home_dir = dirs_sys::home_dir();
-            home_dir.map(|path| path.join(".local").join("bin"))
+            let home_dir = etcetera::home_dir();
+            home_dir.map(|path| path.join(".local").join("bin")).ok()
         })
         .ok_or(Error::NoExecutableDirectory)
 }