Add src to default cache keys

Author: charliermarsh

crates/uv-cache-info/src/cache_info.rs

@@ -30,6 +30,9 @@ pub struct CacheInfo {
     commit: Option<Commit>,
     /// The Git tags present at the time of the build.
     tags: Option<Tags>,
+    /// The timestamp or inode of any directories that should be considered in the cache key.
+    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
+    directories: BTreeMap<String, DirectoryTimestamp>,
     /// Environment variables to include in the cache key.
     #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
     env: BTreeMap<String, Option<String>>,
@@ -59,6 +62,7 @@ impl CacheInfo {
         let mut commit = None;
         let mut tags = None;
         let mut timestamp = None;
+        let mut directories = BTreeMap::new();
         let mut env = BTreeMap::new();
 
         // Read the cache keys.
@@ -82,6 +86,9 @@ impl CacheInfo {
                 CacheKey::Path("pyproject.toml".to_string()),
                 CacheKey::Path("setup.py".to_string()),
                 CacheKey::Path("setup.cfg".to_string()),
+                CacheKey::Directory {
+                    dir: "src".to_string(),
+                },
             ]
         });
 
@@ -117,6 +124,47 @@ impl CacheInfo {
                     }
                     timestamp = max(timestamp, Some(Timestamp::from_metadata(&metadata)));
                 }
+                CacheKey::Directory { dir } => {
+                    // Treat the path as a directory.
+                    let path = directory.join(&dir);
+                    let metadata = match path.metadata() {
+                        Ok(metadata) => metadata,
+                        Err(err) if err.kind() == std::io::ErrorKind::NotFound => {
+                            continue;
+                        }
+                        Err(err) => {
+                            warn!("Failed to read metadata for directory: {err}");
+                            continue;
+                        }
+                    };
+                    if !metadata.is_dir() {
+                        warn!(
+                            "Expected directory for cache key, but found file: `{}`",
+                            path.display()
+                        );
+                        continue;
+                    }
+
+                    if let Ok(created) = metadata.created() {
+                        // Prefer the creation time.
+                        directories
+                            .insert(dir, DirectoryTimestamp::Timestamp(Timestamp::from(created)));
+                    } else {
+                        // Fall back to the inode.
+                        #[cfg(unix)]
+                        {
+                            use std::os::unix::fs::MetadataExt;
+                            directories.insert(dir, DirectoryTimestamp::Inode(metadata.ino()));
+                        }
+                        #[cfg(not(unix))]
+                        {
+                            warn!(
+                                "Failed to read creation time for directory: `{}`",
+                                path.display()
+                            );
+                        }
+                    }
+                }
                 CacheKey::Git {
                     git: GitPattern::Bool(true),
                 } => match Commit::from_repository(directory) {
@@ -190,6 +238,7 @@ impl CacheInfo {
             timestamp,
             commit,
             tags,
+            directories,
             env,
         })
     }
@@ -241,6 +290,8 @@ pub enum CacheKey {
     Path(String),
     /// Ex) `{ file = "Cargo.lock" }` or `{ file = "**/*.toml" }`
     File { file: String },
+    /// Ex) `{ dir = "src" }`
+    Directory { dir: String },
     /// Ex) `{ git = true }` or `{ git = { commit = true, tags = false } }`
     Git { git: GitPattern },
     /// Ex) `{ env = "UV_CACHE_INFO" }`
@@ -267,3 +318,10 @@ pub enum FilePattern {
     Glob(String),
     Path(PathBuf),
 }
+
+/// A timestamp used to measure changes to a directory.
+#[derive(Debug, Clone, Hash, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
+enum DirectoryTimestamp {
+    Timestamp(Timestamp),
+    Inode(u64),
+}

crates/uv-cache-info/src/timestamp.rs

@@ -44,3 +44,9 @@ impl Timestamp {
         Self(std::time::SystemTime::now())
     }
 }
+
+impl From<std::time::SystemTime> for Timestamp {
+    fn from(system_time: std::time::SystemTime) -> Self {
+        Self(system_time)
+    }
+}

crates/uv-settings/src/settings.rs

@@ -59,10 +59,11 @@ pub struct Options {
     ///
     /// Cache keys enable you to specify the files or directories that should trigger a rebuild when
     /// modified. By default, uv will rebuild a project whenever the `pyproject.toml`, `setup.py`,
-    /// or `setup.cfg` files in the project directory are modified, i.e.:
+    /// or `setup.cfg` files in the project directory are modified, or if a `src` directory is
+    /// added or removed, i.e.:
     ///
     /// ```toml
-    /// cache-keys = [{ file = "pyproject.toml" }, { file = "setup.py" }, { file = "setup.cfg" }]
+    /// cache-keys = [{ file = "pyproject.toml" }, { file = "setup.py" }, { file = "setup.cfg" }, { dir = "src" }]
     /// ```
     ///
     /// As an example: if a project uses dynamic metadata to read its dependencies from a

crates/uv/src/commands/pip/operations.rs

@@ -261,6 +261,8 @@ pub(crate) async fn resolve<InstalledPackages: InstalledPackagesProvider>(
     let overrides = Overrides::from_requirements(overrides);
     let preferences = Preferences::from_iter(preferences, &resolver_env);
 
+    // Treat any source paths provided on the CLI as requiring `--reinstall`.
+
     // Determine any lookahead requirements.
     let lookaheads = match options.dependency_mode {
         DependencyMode::Transitive => {

crates/uv/tests/it/lock.rs

@@ -10607,7 +10607,7 @@ fn lock_mixed_extras() -> Result<()> {
         [tool.uv.workspace]
         members = ["packages/*"]
     "#})?;
-    workspace1.child("src/__init__.py").touch()?;
+    workspace1.child("src/workspace1/__init__.py").touch()?;
 
     let leaf1 = workspace1.child("packages").child("leaf1");
     leaf1.child("pyproject.toml").write_str(indoc! {r#"
@@ -10621,10 +10621,10 @@ fn lock_mixed_extras() -> Result<()> {
         async = ["iniconfig>=2"]
 
         [build-system]
-        requires = ["setuptools>=42"]
-        build-backend = "setuptools.build_meta"
+        requires = ["hatchling"]
+        build-backend = "hatchling.build"
     "#})?;
-    leaf1.child("src/__init__.py").touch()?;
+    leaf1.child("src/leaf1/__init__.py").touch()?;
 
     // Create a second workspace (`workspace2`) with an extra of the same name.
     let workspace2 = context.temp_dir.child("workspace2");
@@ -10636,16 +10636,16 @@ fn lock_mixed_extras() -> Result<()> {
         dependencies = ["leaf2"]
 
         [build-system]
-        requires = ["setuptools>=42"]
-        build-backend = "setuptools.build_meta"
+        requires = ["hatchling"]
+        build-backend = "hatchling.build"
 
         [tool.uv.sources]
         leaf2 = { workspace = true }
 
         [tool.uv.workspace]
         members = ["packages/*"]
     "#})?;
-    workspace2.child("src/__init__.py").touch()?;
+    workspace2.child("src/workspace2/__init__.py").touch()?;
 
     let leaf2 = workspace2.child("packages").child("leaf2");
     leaf2.child("pyproject.toml").write_str(indoc! {r#"
@@ -10659,10 +10659,10 @@ fn lock_mixed_extras() -> Result<()> {
         async = ["packaging>=24"]
 
         [build-system]
-        requires = ["setuptools>=42"]
-        build-backend = "setuptools.build_meta"
+        requires = ["hatchling"]
+        build-backend = "hatchling.build"
     "#})?;
-    leaf2.child("src/__init__.py").touch()?;
+    leaf2.child("src/leaf2/__init__.py").touch()?;
 
     // Lock the first workspace.
     uv_snapshot!(context.filters(), context.lock().current_dir(&workspace1), @r###"
@@ -10842,7 +10842,7 @@ fn lock_transitive_extra() -> Result<()> {
         [tool.uv.workspace]
         members = ["packages/*"]
     "#})?;
-    workspace.child("src/__init__.py").touch()?;
+    workspace.child("src/workspace/__init__.py").touch()?;
 
     let leaf = workspace.child("packages").child("leaf");
     leaf.child("pyproject.toml").write_str(indoc! {r#"
@@ -10856,10 +10856,10 @@ fn lock_transitive_extra() -> Result<()> {
         async = ["iniconfig>=2"]
 
         [build-system]
-        requires = ["setuptools>=42"]
-        build-backend = "setuptools.build_meta"
+        requires = ["hatchling"]
+        build-backend = "hatchling.build"
     "#})?;
-    leaf.child("src/__init__.py").touch()?;
+    leaf.child("src/leaf/__init__.py").touch()?;
 
     // Lock the workspace.
     uv_snapshot!(context.filters(), context.lock().current_dir(&workspace), @r###"

crates/uv/tests/it/pip_install.rs

@@ -9183,3 +9183,94 @@ fn unsupported_git_scheme() {
     "###
     );
 }
+
+/// Modify a project to use a `src` layout.
+#[test]
+fn change_layout() -> Result<()> {
+    let context = TestContext::new("3.12");
+
+    let pyproject_toml = context.temp_dir.child("pyproject.toml");
+    pyproject_toml.write_str(
+        r#"
+        [project]
+        name = "project"
+        version = "0.1.0"
+        requires-python = ">=3.12"
+        dependencies = ["iniconfig"]
+
+        [build-system]
+        requires = ["hatchling"]
+        build-backend = "hatchling.build"
+        "#,
+    )?;
+
+    context
+        .temp_dir
+        .child("src")
+        .child("project")
+        .child("__init__.py")
+        .touch()?;
+
+    // Installing should build the package.
+    uv_snapshot!(context.filters(), context.pip_install().arg("-e").arg("."), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+
+    ----- stderr -----
+    Resolved 2 packages in [TIME]
+    Prepared 2 packages in [TIME]
+    Installed 2 packages in [TIME]
+     + iniconfig==2.0.0
+     + project==0.1.0 (from file://[TEMP_DIR]/)
+    "###
+    );
+
+    // Reinstalling should have no effect.
+    uv_snapshot!(context.filters(), context.pip_install().arg("-e").arg("."), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+
+    ----- stderr -----
+    Audited 1 package in [TIME]
+    "###
+    );
+
+    // Replace the `src` layout with a flat layout.
+    fs_err::remove_dir_all(context.temp_dir.child("src").path())?;
+
+    context
+        .temp_dir
+        .child("project")
+        .child("__init__.py")
+        .touch()?;
+
+    // Installing should rebuild the package.
+    uv_snapshot!(context.filters(), context.pip_install().arg("-e").arg("."), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+
+    ----- stderr -----
+    Resolved 2 packages in [TIME]
+    Prepared 1 package in [TIME]
+    Uninstalled 1 package in [TIME]
+    Installed 1 package in [TIME]
+     ~ project==0.1.0 (from file://[TEMP_DIR]/)
+    "###
+    );
+
+    // Reinstalling should have no effect.
+    uv_snapshot!(context.filters(), context.pip_install().arg("-e").arg("."), @r###"
+    success: true
+    exit_code: 0
+    ----- stdout -----
+
+    ----- stderr -----
+    Audited 1 package in [TIME]
+    "###
+    );
+
+    Ok(())
+}