ENH: implement support for install_rpath

Revise tests to exercise support when executed with Meson > 1.6

Author: dnicolodi

mesonpy/__init__.py

@@ -125,6 +125,10 @@ def _compile_patterns(patterns: List[str]) -> Callable[[str], bool]:
 class _Entry(typing.NamedTuple):
     dst: pathlib.Path
     src: str
+    # Meson support only one install_rpath entry per target. Use a
+    # list to store install RPATH to be able to add append more
+    # entries when needed.
+    install_rpath: List[str] = []
 
 
 def _map_to_wheel(
@@ -183,7 +187,8 @@ def _map_to_wheel(
                         filedst = dst / relpath
                         wheel_files[path].append(_Entry(filedst, filesrc))
             else:
-                wheel_files[path].append(_Entry(dst, src))
+                install_rpath = target.get('install_rpath')
+                wheel_files[path].append(_Entry(dst, src, [install_rpath] if install_rpath else []))
 
     return wheel_files
 
@@ -449,13 +454,15 @@ def _stable_abi(self) -> Optional[str]:
             return 'abi3.abi3t' if abi3t else 'abi3'
         return None
 
-    def _install_path(self, wheel_file: mesonpy._wheelfile.WheelFile, origin: Path, destination: pathlib.Path) -> None:
+    def _install_path(self, wheel_file: mesonpy._wheelfile.WheelFile, origin: Path, destination: pathlib.Path,
+                      install_rpath: List[str]) -> None:
         """Add a file to the wheel."""
 
-        if self._has_internal_libs:
-            if _is_native(origin):
-                libspath = os.path.relpath(self._libs_dir, destination.parent)
-                mesonpy._rpath.fix_rpath(origin, libspath)
+        if self._has_internal_libs and _is_native(origin):
+            libspath = os.path.relpath(self._libs_dir, destination.parent)
+            mesonpy._rpath.fix_rpath(origin, install_rpath, libspath)
+        elif install_rpath:
+            mesonpy._rpath.fix_rpath(origin, install_rpath, None)
 
         try:
             wheel_file.write(origin, destination.as_posix())
@@ -499,7 +506,7 @@ def build(self, directory: Path) -> pathlib.Path:
                 root = 'purelib' if self._pure else 'platlib'
 
                 for path, entries in self._manifest.items():
-                    for dst, src in entries:
+                    for dst, src, rpath in entries:
                         counter.update(src)
 
                         if path == root:
@@ -510,7 +517,7 @@ def build(self, directory: Path) -> pathlib.Path:
                         else:
                             dst = pathlib.Path(self._data_dir, path, dst)
 
-                        self._install_path(whl, src, dst)
+                        self._install_path(whl, src, dst, rpath)
 
         return wheel_file
 

mesonpy/_rpath.py

@@ -11,7 +11,7 @@
 
 
 if typing.TYPE_CHECKING:
-    from typing import List, TypeVar, Union
+    from typing import List, Optional, TypeVar, Union
     Path = Union[str, os.PathLike[str]]
     T = TypeVar('T')
 
@@ -37,7 +37,7 @@ def set_rpath(filepath: Path, old: List[str], rpath: List[str]) -> None:
         raise NotImplementedError
 
     @classmethod
-    def fix_rpath(cls, filepath: Path, libs_relative_path: str) -> None:
+    def fix_rpath(cls, filepath: Path, install_rpath: List[str], libs_relative_path: Optional[str]) -> None:
         old_rpath = cls.get_rpath(filepath)
         new_rpath = old_rpath[:]
 
@@ -51,9 +51,12 @@ def fix_rpath(cls, filepath: Path, libs_relative_path: str) -> None:
         # library install location. This heuristic is not perfect: RPATH
         # entries relative to ``$ORIGIN`` can exist for other reasons.
         # However, this only results in harmless additional RPATH entries.
-        if any(path.startswith(cls.origin) for path in old_rpath):
+        if libs_relative_path and any(path.startswith(cls.origin) for path in old_rpath):
             new_rpath.append(os.path.join(cls.origin, libs_relative_path))
 
+        # Add install_rpath.
+        new_rpath += install_rpath
+
         new_rpath = unique(new_rpath)
         if new_rpath != old_rpath:
             cls.set_rpath(filepath, old_rpath, new_rpath)
@@ -62,7 +65,7 @@ def fix_rpath(cls, filepath: Path, libs_relative_path: str) -> None:
 class _Windows(RPATH):
 
     @classmethod
-    def fix_rpath(cls, filepath: Path, libs_relative_path: str) -> None:
+    def fix_rpath(cls, filepath: Path, install_rpath: List[str], libs_relative_path: str) -> None:
         pass
 
 

tests/packages/sharedlib-in-package/mypkg/meson.build

@@ -2,17 +2,19 @@
 #
 # SPDX-License-Identifier: MIT
 
+# install_rpath is not exposed in the Meson introspection data in
+# Meson versions prior to 1.6.0 and thus cannot be set by meson-python
+# when building the Python wheel. Use link_args to set the RPATH when
+# using older Meson.
+kwargs = meson.version().version_compare('< 1.6') ? {'link_args': f'-Wl,-rpath,@origin@'} : {'install_rpath': f'@origin@'}
+
 py.extension_module(
     '_example',
     '_examplemod.c',
     dependencies: lib_dep,
     install: true,
     subdir: 'mypkg',
-    # install_rpath is not exposed in the Meson introspection data in Meson
-    # versions prior to 1.6.0 and thus cannot be set by meson-python when
-    # building the Python wheel. Use link_args to set the RPATH.
-    # install_rpath: f'@origin@',
-    link_args: f'-Wl,-rpath,@origin@',
+    kwargs: kwargs,
 )
 
 py.install_sources(

tests/packages/sharedlib-in-package/src/meson.build

@@ -23,18 +23,20 @@ sublib_dep = declare_dependency(
     link_with: sublib,
 )
 
+# install_rpath is not exposed in the Meson introspection data in
+# Meson versions prior to 1.6.0 and thus cannot be set by meson-python
+# when building the Python wheel. Use link_args to set the RPATH when
+# using older Meson.
+kwargs = meson.version().version_compare('< 1.6') ? {'link_args': f'-Wl,-rpath,@origin@/sub'} : {'install_rpath': f'@origin@/sub'}
+
 lib = shared_library(
     'lib',
     'lib.c',
     dependencies: sublib_dep,
     c_args: export_dll_args,
     install: true,
     install_dir: py.get_install_dir() / 'mypkg',
-    # install_rpath is not exposed in the Meson introspection data in Meson
-    # versions prior to 1.6.0 and thus cannot be set by meson-python when
-    # building the Python wheel. Use link_args to set the RPATH.
-    # install_rpath: f'@origin@/sub',
-    link_args: f'-Wl,-rpath,@origin@/sub',
+    kwargs: kwargs,
 )
 
 lib_dep = declare_dependency(