Patch embedded install path for Python dylib on macOS during python install (#10629)

## Summary Fixes #10598 ## Test Plan Looking for input here @zanieb. How/where would you include tests for this? More broadly: do we want a failure to perform the rename to be a hard error? Or should it start out as a warning? --------- Co-authored-by: Zanie Blue <contact@zanie.dev>
2025-01-15 21:11:54 +01:00
parent 04fc36f066
commit 1af02ce8f2
6 changed files with 141 additions and 2 deletions
@@ -0,0 +1,63 @@
+use std::{io::ErrorKind, path::PathBuf};
+
+use uv_fs::Simplified as _;
+use uv_warnings::warn_user;
+
+use crate::managed::ManagedPythonInstallation;
+
+pub fn patch_dylib_install_name(dylib: PathBuf) -> Result<(), Error> {
+    let output = match std::process::Command::new("install_name_tool")
+        .arg("-id")
+        .arg(&dylib)
+        .arg(&dylib)
+        .output()
+    {
+        Ok(output) => output,
+        Err(e) => {
+            let e = if e.kind() == ErrorKind::NotFound {
+                Error::MissingInstallNameTool
+            } else {
+                e.into()
+            };
+            return Err(e);
+        }
+    };
+
+    if !output.status.success() {
+        let stderr = String::from_utf8_lossy(&output.stderr).into_owned();
+        return Err(Error::RenameError { dylib, stderr });
+    }
+
+    Ok(())
+}
+
+#[derive(thiserror::Error, Debug)]
+pub enum Error {
+    #[error(transparent)]
+    Io(#[from] std::io::Error),
+    #[error("`install_name_tool` is not available on this system.
+This utility is part of macOS Developer Tools. Please ensure that the Xcode Command Line Tools are installed by running:
+
+    xcode-select --install
+
+For more information, see: https://developer.apple.com/xcode/")]
+    MissingInstallNameTool,
+    #[error("Failed to update the install name of the Python dynamic library located at `{}`", dylib.user_display())]
+    RenameError { dylib: PathBuf, stderr: String },
+}
+
+impl Error {
+    /// Emit a user-friendly warning about the patching failure.
+    pub fn warn_user(&self, installation: &ManagedPythonInstallation) {
+        let error = if tracing::enabled!(tracing::Level::DEBUG) {
+            format!("\nUnderlying error: {self}")
+        } else {
+            String::new()
+        };
+        warn_user!(
+            "Failed to patch the install name of the dynamic library for {}. This may cause issues when building Python native extensions.{}",
+            installation.executable().simplified_display(),
+            error
+        );
+    }
+}