Add native homebrew locator on mac (#23363)

Author: DonJayamanne

native_locator/src/homebrew.rs

@@ -0,0 +1,63 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+use std::{collections::HashSet, fs::DirEntry, io::Error, path::PathBuf};
+
+use crate::{known::Environment, messaging::MessageDispatcher};
+use regex::Regex;
+
+fn is_symlinked_python_executable(path: Result<DirEntry, Error>) -> Option<PathBuf> {
+    let path = path.ok()?.path();
+    let name = path.file_name()?.to_string_lossy();
+    if !name.starts_with("python") || name.ends_with("-config") {
+        return None;
+    }
+    let metadata = std::fs::symlink_metadata(&path).ok()?;
+    if metadata.is_file() || !metadata.file_type().is_symlink() {
+        return None;
+    }
+    Some(std::fs::canonicalize(path).ok()?)
+}
+
+pub fn find_and_report(
+    dispatcher: &mut impl MessageDispatcher,
+    environment: &impl Environment,
+) -> Option<()> {
+    // https://docs.brew.sh/Homebrew-and-Python#brewed-python-modules
+    // Executable Python scripts will be in $(brew --prefix)/bin.
+    // They are always symlinks, hence we will only look for symlinks.
+
+    let homebrew_prefix = environment.get_env_var("HOMEBREW_PREFIX".to_string())?;
+    let homebrew_prefix_bin = PathBuf::from(homebrew_prefix).join("bin");
+    let mut reported: HashSet<String> = HashSet::new();
+    for file in std::fs::read_dir(homebrew_prefix_bin).ok()? {
+        if let Some(exe) = is_symlinked_python_executable(file) {
+            let python_regex = Regex::new(r"/(\d+\.\d+\.\d+)/").unwrap();
+            let python_version = exe.to_string_lossy().to_string();
+            let version = match python_regex.captures(&python_version) {
+                Some(captures) => match captures.get(1) {
+                    Some(version) => Some(version.as_str().to_string()),
+                    None => None,
+                },
+                None => None,
+            };
+            if reported.contains(&exe.to_string_lossy().to_string()) {
+                continue;
+            }
+            reported.insert(exe.to_string_lossy().to_string());
+
+            let env = crate::messaging::PythonEnvironment::new(
+                "Python".to_string(),
+                vec![exe.to_string_lossy().to_string()],
+                crate::messaging::PythonEnvironmentCategory::Homebrew,
+                version,
+                None,
+                None,
+                None,
+            );
+            dispatcher.report_environment(env);
+        }
+    }
+
+    None
+}

native_locator/src/main.rs

@@ -8,12 +8,13 @@ use messaging::{create_dispatcher, MessageDispatcher};
 
 mod common_python;
 mod conda;
+mod homebrew;
 mod known;
 mod logging;
 mod messaging;
+mod pyenv;
 mod utils;
 mod windows_python;
-mod pyenv;
 
 fn main() {
     let mut dispatcher = create_dispatcher();
@@ -34,6 +35,8 @@ fn main() {
 
     pyenv::find_and_report(&mut dispatcher, &environment);
 
+    homebrew::find_and_report(&mut dispatcher, &environment);
+
     match now.elapsed() {
         Ok(elapsed) => {
             dispatcher.log_info(&format!(

native_locator/src/messaging.rs

@@ -52,6 +52,7 @@ impl EnvManagerMessage {
 #[serde(rename_all = "camelCase")]
 pub enum PythonEnvironmentCategory {
     System,
+    Homebrew,
     Conda,
     Pyenv,
     WindowsStore,

src/client/pythonEnvironments/base/locators/lowLevel/nativeLocator.ts

@@ -39,6 +39,7 @@ function categoryToKind(category: string): PythonEnvKind {
         case 'conda':
             return PythonEnvKind.Conda;
         case 'system':
+        case 'homebrew':
             return PythonEnvKind.System;
         case 'pyenv':
             return PythonEnvKind.Pyenv;