Avoid displaying warning about bad Python intepreter links for empty …

…project virtual environment directories
astral-sh · Sep 19, 2024 · c2e1214 · c2e1214
1 parent 725019d
commit c2e1214
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 8 deletions.
diff --git a/crates/uv-python/src/environment.rs b/crates/uv-python/src/environment.rs
@@ -34,6 +34,12 @@ pub struct EnvironmentNotFound {
     preference: EnvironmentPreference,
 }
 
+#[derive(Clone, Debug, Error)]
+pub struct InvalidEnvironment {
+    path: PathBuf,
+    reason: String,
+}
+
 impl From<PythonNotFound> for EnvironmentNotFound {
     fn from(value: PythonNotFound) -> Self {
         Self {
@@ -98,6 +104,17 @@ impl fmt::Display for EnvironmentNotFound {
     }
 }
 
+impl std::fmt::Display for InvalidEnvironment {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        write!(
+            f,
+            "Invalid environment at `{}`: {}",
+            self.path.user_display(),
+            self.reason
+        )
+    }
+}
+
 impl PythonEnvironment {
     /// Find a [`PythonEnvironment`] matching the given request and preference.
     ///
@@ -133,6 +150,23 @@ impl PythonEnvironment {
             }
             Err(err) => return Err(Error::Discovery(err.into())),
         };
+
+        if venv.is_file() {
+            return Err(InvalidEnvironment {
+                path: venv,
+                reason: "expected directory but found a file".to_string(),
+            }
+            .into());
+        }
+
+        if !venv.join("pyvenv.cfg").is_file() {
+            return Err(InvalidEnvironment {
+                path: venv,
+                reason: "missing a `pyvenv.cfg` marker".to_string(),
+            }
+            .into());
+        }
+
         let executable = virtualenv_python_executable(venv);
         let interpreter = Interpreter::query(executable, cache)?;
 

diff --git a/crates/uv-python/src/lib.rs b/crates/uv-python/src/lib.rs
@@ -78,6 +78,9 @@ pub enum Error {
 
     #[error(transparent)]
     MissingEnvironment(#[from] environment::EnvironmentNotFound),
+
+    #[error(transparent)]
+    InvalidEnvironment(#[from] environment::InvalidEnvironment),
 }
 
 // The mock interpreters are not valid on Windows so we don't have unit test coverage there

diff --git a/crates/uv/src/commands/project/mod.rs b/crates/uv/src/commands/project/mod.rs
@@ -120,7 +120,7 @@ pub(crate) enum ProjectError {
     #[error("Environment marker is empty")]
     EmptyEnvironment,
 
-    #[error("Project virtual environment directory `{0}` cannot be used because it has existing, non-virtual environment content")]
+    #[error("Project virtual environment directory `{0}` cannot be used because it is not a virtual environment and is non-empty")]
     InvalidProjectEnvironmentDir(PathBuf),
 
     #[error("Failed to parse `pyproject.toml`")]
@@ -399,7 +399,8 @@ impl FoundInterpreter {
                     }
                 }
             }
-            Err(uv_python::Error::MissingEnvironment(_)) => {}
+            Err(uv_python::Error::MissingEnvironment(_))
+            | Err(uv_python::Error::InvalidEnvironment(_)) => {}
             Err(uv_python::Error::Query(uv_python::InterpreterError::NotFound(path))) => {
                 warn_user!(
                     "Ignoring existing virtual environment linked to non-existent Python interpreter: {}",
@@ -493,10 +494,15 @@ pub(crate) async fn get_or_init_environment(
 
             // Before deleting the target directory, we confirm that it is either (1) a virtual
             // environment or (2) an empty directory.
-            if PythonEnvironment::from_root(&venv, cache).is_err()
-                && fs_err::read_dir(&venv).is_ok_and(|mut dir| dir.next().is_some())
-            {
-                return Err(ProjectError::InvalidProjectEnvironmentDir(venv));
+            match PythonEnvironment::from_root(&venv, cache) {
+                Ok(_) => {}
+                Err(uv_python::Error::InvalidEnvironment(_)) => {
+                    // An invalid environment with _some_ extraneous content is an error
+                    if fs_err::read_dir(&venv).is_ok_and(|mut dir| dir.next().is_some()) {
+                        return Err(ProjectError::InvalidProjectEnvironmentDir(venv));
+                    }
+                }
+                Err(_) => {}
             }
 
             // Remove the existing virtual environment if it doesn't meet the requirements.

diff --git a/crates/uv/tests/sync.rs b/crates/uv/tests/sync.rs
@@ -1747,9 +1747,8 @@ fn sync_custom_environment_path() -> Result<()> {
     ----- stdout -----
 
     ----- stderr -----
-    warning: Ignoring existing virtual environment linked to non-existent Python interpreter: foo/[BIN]/python
     Using Python 3.12.[X] interpreter at: [PYTHON-3.12]
-    error: Project virtual environment directory `[TEMP_DIR]/foo` cannot be used because it has existing, non-virtual environment content
+    error: Project virtual environment directory `[TEMP_DIR]/foo` cannot be used because it is not a virtual environment and is non-empty
     "###);
 
     // But if it's just an incompatible virtual environment...