Remove unknown and make kind optional when kind is unknown (#92)

Author: DonJayamanne

crates/pet-conda/src/environments.rs

@@ -57,7 +57,7 @@ impl CondaEnvironment {
             }
         }
         // This is a root env.
-        let builder = PythonEnvironmentBuilder::new(PythonEnvironmentKind::Conda)
+        let builder = PythonEnvironmentBuilder::new(Some(PythonEnvironmentKind::Conda))
             .executable(self.executable.clone())
             .version(self.version.clone())
             .prefix(Some(self.prefix.clone()))

crates/pet-conda/tests/ci_test.rs

@@ -54,7 +54,7 @@ fn detect_conda_root() {
         .unwrap();
     assert_eq!(env.prefix, conda_dir.clone().into());
     assert_eq!(env.name, Some("base".into()));
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, Some(conda_dir.join("bin").join("python")));
     assert_eq!(env.version, Some(get_version(&info.python_version)));
 
@@ -93,7 +93,7 @@ fn detect_conda_root_from_path() {
 
     assert_eq!(env.prefix, conda_dir.clone().into());
     assert_eq!(env.name, Some("base".into()));
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, Some(conda_dir.join("bin").join("python")));
     assert_eq!(env.version, Some(get_version(&info.python_version)));
 }
@@ -144,7 +144,7 @@ fn detect_new_conda_env() {
     let prefix = conda_dir.clone().join("envs").join(env_name);
     assert_eq!(env.prefix, prefix.clone().into());
     assert_eq!(env.name, Some(env_name.into()));
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, prefix.join("bin").join("python").into());
     assert!(
         env.version.clone().unwrap_or_default().starts_with("3.10"),
@@ -193,7 +193,7 @@ fn detect_conda_env_from_path() {
 
     assert_eq!(env.prefix, prefix.clone().into());
     assert_eq!(env.name, Some(env_name.into()));
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, exe.clone().into());
     assert!(
         env.version.clone().unwrap_or_default().starts_with("3.10"),
@@ -245,7 +245,7 @@ fn detect_new_conda_env_without_python() {
     let prefix = conda_dir.clone().join("envs").join(env_name);
     assert_eq!(env.prefix, prefix.clone().into());
     assert_eq!(env.name, Some(env_name.into()));
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable.is_none(), true);
     assert_eq!(env.version.is_none(), true);
 
@@ -293,7 +293,7 @@ fn detect_new_conda_env_created_with_p_flag_without_python() {
 
     assert_eq!(env.prefix, prefix.clone().into());
     assert_eq!(env.name, None);
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable.is_none(), true);
     assert_eq!(env.version.is_none(), true);
 
@@ -345,7 +345,7 @@ fn detect_new_conda_env_created_with_p_flag_with_python() {
 
     assert_eq!(env.prefix, prefix.clone().into());
     assert_eq!(env.name, None);
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, exe.into());
     assert!(
         env.version.clone().unwrap_or_default().starts_with("3.10"),

crates/pet-conda/tests/lib_test.rs

@@ -26,7 +26,7 @@ fn find_conda_env_without_manager() {
 
     assert_eq!(env.prefix, path.clone().into());
     assert_eq!(env.arch, Architecture::X64.into());
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, path.join("bin").join("python").into());
     assert_eq!(env.version, "3.12.2".to_string().into());
     assert_eq!(env.manager, None);
@@ -75,7 +75,7 @@ fn find_conda_env_without_manager_but_detect_manager_from_history() {
 
     assert_eq!(env.prefix, path.clone().into());
     assert_eq!(env.arch, Architecture::X64.into());
-    assert_eq!(env.kind, PythonEnvironmentKind::Conda);
+    assert_eq!(env.kind, Some(PythonEnvironmentKind::Conda));
     assert_eq!(env.executable, path.join("bin").join("python").into());
     assert_eq!(env.version, "3.12.2".to_string().into());
     assert_eq!(

crates/pet-core/src/python_environment.rs

@@ -41,7 +41,7 @@ impl PartialOrd for PythonEnvironmentKind {
 
 #[derive(Serialize, Deserialize, Clone, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
-#[derive(Debug)]
+#[derive(Debug, Default)]
 // Python environment.
 // Any item that has information is known to be accurate, if an item is missing it is unknown.
 pub struct PythonEnvironment {
@@ -51,7 +51,7 @@ pub struct PythonEnvironment {
     pub name: Option<String>,
     // Python executable, can be empty in the case of conda envs that do not have Python installed in them.
     pub executable: Option<PathBuf>,
-    pub kind: PythonEnvironmentKind,
+    pub kind: Option<PythonEnvironmentKind>,
     pub version: Option<String>,
     // SysPrefix for the environment.
     pub prefix: Option<PathBuf>,
@@ -93,31 +93,10 @@ impl PartialOrd for PythonEnvironment {
     }
 }
 
-impl Default for PythonEnvironment {
-    fn default() -> Self {
-        Self {
-            display_name: None,
-            name: None,
-            executable: None,
-            // Sometimes we might not know the env type.
-            // Lets never default these to System/Global or others as thats not true.
-            // Not knowing does not mean it is a system env.
-            kind: PythonEnvironmentKind::Unknown,
-            version: None,
-            prefix: None,
-            manager: None,
-            project: None,
-            arch: None,
-            symlinks: None,
-            search_path: None,
-        }
-    }
-}
-
 impl PythonEnvironment {
     pub fn new(
         executable: Option<PathBuf>,
-        kind: PythonEnvironmentKind,
+        kind: Option<PythonEnvironmentKind>,
         prefix: Option<PathBuf>,
         manager: Option<EnvManager>,
         version: Option<String>,
@@ -205,7 +184,7 @@ pub struct PythonEnvironmentBuilder {
     display_name: Option<String>,
     name: Option<String>,
     executable: Option<PathBuf>,
-    kind: PythonEnvironmentKind,
+    kind: Option<PythonEnvironmentKind>,
     version: Option<String>,
     prefix: Option<PathBuf>,
     manager: Option<EnvManager>,
@@ -216,7 +195,7 @@ pub struct PythonEnvironmentBuilder {
 }
 
 impl PythonEnvironmentBuilder {
-    pub fn new(kind: PythonEnvironmentKind) -> Self {
+    pub fn new(kind: Option<PythonEnvironmentKind>) -> Self {
         Self {
             kind,
             display_name: None,
@@ -359,11 +338,11 @@ impl PythonEnvironmentBuilder {
 // Given a list of executables, return the one with the shortest path.
 // The shortest path is the most likely to be most user friendly.
 fn get_shortest_executable(
-    kind: &PythonEnvironmentKind,
+    kind: &Option<PythonEnvironmentKind>,
     exes: &Option<Vec<PathBuf>>,
 ) -> Option<PathBuf> {
     // For windows store, the exe should always be the one in the WindowsApps folder.
-    if *kind == PythonEnvironmentKind::WindowsStore {
+    if *kind == Some(PythonEnvironmentKind::WindowsStore) {
         if let Some(exes) = exes {
             if let Some(exe) = exes.iter().find(|e| {
                 e.to_string_lossy().contains("AppData")
@@ -398,7 +377,7 @@ pub fn get_environment_key(env: &PythonEnvironment) -> Option<PathBuf> {
         Some(exe.clone())
     } else if let Some(prefix) = &env.prefix {
         // If this is a conda env without Python, then the exe will be prefix/bin/python
-        if env.kind == PythonEnvironmentKind::Conda {
+        if env.kind == Some(PythonEnvironmentKind::Conda) {
             Some(prefix.join("bin").join(if cfg!(windows) {
                 "python.exe"
             } else {

crates/pet-core/src/telemetry/inaccurate_python_info.rs

@@ -8,7 +8,7 @@ use crate::python_environment::PythonEnvironmentKind;
 /// And we will not report that as an inaccuracy.
 pub struct InaccuratePythonEnvironmentInfo {
     /// Python Env kind
-    pub kind: PythonEnvironmentKind,
+    pub kind: Option<PythonEnvironmentKind>,
     /// Whether the actual exe is not what we expected.
     pub invalid_executable: Option<bool>,
     /// Whether the actual exe was not even in the list of symlinks that we expected.

crates/pet-homebrew/src/environments.rs

@@ -48,7 +48,7 @@ pub fn get_python_info(
     symlinks.sort();
     symlinks.dedup();
 
-    let env = PythonEnvironmentBuilder::new(PythonEnvironmentKind::Homebrew)
+    let env = PythonEnvironmentBuilder::new(Some(PythonEnvironmentKind::Homebrew))
         .executable(Some(python_exe_from_bin_dir.to_path_buf()))
         .version(version)
         .prefix(get_prefix(resolved_exe))

crates/pet-linux-global-python/src/lib.rs

@@ -209,7 +209,7 @@ fn get_python_in_bin(env: &PythonEnv, is_64bit: bool) -> Option<PythonEnvironmen
     symlinks.dedup();
 
     Some(
-        PythonEnvironmentBuilder::new(PythonEnvironmentKind::LinuxGlobal)
+        PythonEnvironmentBuilder::new(Some(PythonEnvironmentKind::LinuxGlobal))
             .executable(Some(executable))
             .version(env.version.clone())
             .arch(if is_64bit {

crates/pet-mac-commandlinetools/src/lib.rs

@@ -171,7 +171,7 @@ impl Locator for MacCmdLineTools {
         }
 
         Some(
-            PythonEnvironmentBuilder::new(PythonEnvironmentKind::MacCommandLineTools)
+            PythonEnvironmentBuilder::new(Some(PythonEnvironmentKind::MacCommandLineTools))
                 .executable(Some(env.executable.clone()))
                 .version(version)
                 .prefix(prefix)

crates/pet-mac-python-org/src/lib.rs

@@ -129,7 +129,7 @@ impl Locator for MacPythonOrg {
         symlinks.dedup();
 
         Some(
-            PythonEnvironmentBuilder::new(PythonEnvironmentKind::MacPythonOrg)
+            PythonEnvironmentBuilder::new(Some(PythonEnvironmentKind::MacPythonOrg))
                 .executable(Some(executable.clone()))
                 .version(Some(version))
                 .prefix(Some(prefix.to_path_buf()))

crates/pet-mac-xcode/src/lib.rs

@@ -158,7 +158,7 @@ impl Locator for MacXCode {
         }
 
         Some(
-            PythonEnvironmentBuilder::new(PythonEnvironmentKind::MacXCode)
+            PythonEnvironmentBuilder::new(Some(PythonEnvironmentKind::MacXCode))
                 .executable(Some(env.executable.clone()))
                 .version(version)
                 .prefix(prefix)