support multiple binaries #24

Author: fafhrd91

CHANGES.rst

@@ -1,6 +1,12 @@
 CHANGES
 =======
 
+0.8.0 (2017-09-05)
+------------------
+
+- Support multiple rust binaries #24
+
+
 0.7.2 (2017-09-01)
 ------------------
 

README.rst

@@ -70,7 +70,11 @@ You can define rust extension with `RustExtension` class:
    The class for creating rust extensions.
 
    :param str name: the full name of the extension, including any packages -- ie.
-                    *not* a filename or pathname, but Python dotted name
+      *not* a filename or pathname, but Python dotted name.
+      It is possible to specify multiple binaries, if extension uses
+      `Binsing.Exec` binding mode. In that case first argument has to be dictionary.
+      Keys of the dictionary corresponds to compiled rust binaries and values are
+      full name of the executable inside python package.
 
    :param str path: path to the Cargo.toml manifest file
 
@@ -91,6 +95,12 @@ You can define rust extension with `RustExtension` class:
                        `Binding.PyO3` uses PyO3
                        `Binding.RustCPython` uses rust-cpython
                        `Binding.NoBinding` uses no binding.
+                       `Binding.Exec` build executable.
+
+   :param int strip: Strip symbols from final file. Does nothing for debug build.
+                     `Strip.No` - do not strip symbols (default)
+                     `Strip.Debug` - strip debug symbols
+                     `Strip.All` - strip all symbols
 
    :param bool script: Generate console script for executable
                        if `Binding.Exec` is used.

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup
 
-version = '0.7.2'
+version = '0.8.0'
 
 
 setup(

setuptools_rust/build.py

@@ -141,19 +141,32 @@ def build_extension(self, ext):
             target_dir = os.path.join(
                 os.path.dirname(ext.path), "target/", suffix)
 
+        dylib_paths = []
+
         if executable:
-            # search executable
-            dylib_path = None
-            for name in os.listdir(target_dir):
-                path = os.path.join(target_dir, name)
-                if name.startswith(".") or not os.path.isfile(path):
-                    continue
-
-                if os.access(path, os.X_OK):
-                    dylib_path = path
-                    break
-
-            if dylib_path is None:
+            for name, dest in ext.target.items():
+                if name:
+                    path = os.path.join(target_dir, name)
+                    if os.access(path, os.X_OK):
+                        dylib_paths.append((dest, path))
+                        continue
+                    else:
+                        raise DistutilsExecError(
+                            'rust build failed; '
+                            'unable to find executable "%s" in %s' % (
+                                name, target_dir))
+                else:
+                    # search executable
+                    for name in os.listdir(target_dir):
+                        path = os.path.join(target_dir, name)
+                        if name.startswith(".") or not os.path.isfile(path):
+                            continue
+
+                        if os.access(path, os.X_OK):
+                            dylib_paths.append((ext.name, path))
+                            break
+
+            if not dylib_paths:
                 raise DistutilsExecError(
                     "rust build failed; unable to find executable in %s" %
                     target_dir)
@@ -166,8 +179,9 @@ def build_extension(self, ext):
                 wildcard_so = "*.so"
 
             try:
-                dylib_path = glob.glob(
-                    os.path.join(target_dir, wildcard_so))[0]
+                dylib_paths.append(
+                    (ext.name, glob.glob(
+                        os.path.join(target_dir, wildcard_so))[0]))
             except IndexError:
                 raise DistutilsExecError(
                     "rust build failed; unable to find any %s in %s" %
@@ -177,47 +191,49 @@ def build_extension(self, ext):
         # then copy it there.
         build_ext = self.get_finalized_command('build_ext')
         build_ext.inplace = self.inplace
-        target_fname = ext.name
-        if target_fname is None:
-            target_fname = os.path.basename(os.path.splitext(
-                os.path.basename(dylib_path)[3:])[0])
 
-        if executable:
-            ext_path = build_ext.get_ext_fullpath(target_fname)
-            # remove .so extension
-            ext_path, _ = os.path.splitext(ext_path)
-            # remove python3 extension (i.e. cpython-36m)
-            ext_path, _ = os.path.splitext(ext_path)
+        for target_fname, dylib_path in dylib_paths:
+            if not target_fname:
+                target_fname = os.path.basename(os.path.splitext(
+                    os.path.basename(dylib_path)[3:])[0])
 
-            ext.install_script(ext_path)
-        else:
-            ext_path = build_ext.get_ext_fullpath(target_fname)
+            if executable:
+                ext_path = build_ext.get_ext_fullpath(target_fname)
+                # remove .so extension
+                ext_path, _ = os.path.splitext(ext_path)
+                # remove python3 extension (i.e. cpython-36m)
+                ext_path, _ = os.path.splitext(ext_path)
 
-        try:
-            os.makedirs(os.path.dirname(ext_path))
-        except OSError:
-            pass
-        shutil.copyfile(dylib_path, ext_path)
-
-        if not debug_build:
-            args = []
-            if ext.strip == Strip.All:
-                args.append('-x')
-            elif ext.strip == Strip.Debug:
-                args.append('-S')
-
-            if args:
-                args.insert(0, 'strip')
-                args.append(ext_path)
-                try:
-                    output = subprocess.check_output(args, env=env)
-                except subprocess.CalledProcessError as e:
-                    pass
+                ext.install_script(ext_path)
+            else:
+                ext_path = build_ext.get_ext_fullpath(target_fname)
 
-        if executable:
-            mode = os.stat(ext_path).st_mode
-            mode |= (mode & 0o444) >> 2    # copy R bits to X
-            os.chmod(ext_path, mode)
+            try:
+                os.makedirs(os.path.dirname(ext_path))
+            except OSError:
+                pass
+
+            shutil.copyfile(dylib_path, ext_path)
+
+            if not debug_build:
+                args = []
+                if ext.strip == Strip.All:
+                    args.append('-x')
+                elif ext.strip == Strip.Debug:
+                    args.append('-S')
+
+                if args:
+                    args.insert(0, 'strip')
+                    args.append(ext_path)
+                    try:
+                        output = subprocess.check_output(args, env=env)
+                    except subprocess.CalledProcessError as e:
+                        pass
+
+            if executable:
+                mode = os.stat(ext_path).st_mode
+                mode |= (mode & 0o444) >> 2    # copy R bits to X
+                os.chmod(ext_path, mode)
 
     def run(self):
         if not self.extensions:

setuptools_rust/extension.py

@@ -37,7 +37,7 @@ class RustExtension:
         Binding.RustCPython uses Rust CPython.
         Binding.NoBinding uses no binding.
         Binding.Exec build executable.
-      strip : setuptools_rust.Binding
+      strip : setuptools_rust.Strip
         Strip symbols from final file. Does nothing for debug build.
         * Strip.No - do not strip symbols
         * Strip.Debug - strip debug symbols
@@ -49,11 +49,19 @@ class RustExtension:
         build process, but instead simply not install the failing extension.
     """
 
-    def __init__(self, name, path,
+    def __init__(self, target, path,
                  args=None, features=None, rust_version=None,
                  quiet=False, debug=None, binding=Binding.PyO3,
                  strip=Strip.No, script=False, optional=False):
+        if isinstance(target, dict):
+            name = '; '.join('%s=%s' % (key, val)
+                             for key, val in target.items())
+        else:
+            name = target
+            target = {'': target}
+
         self.name = name
+        self.target = target
         self.args = args
         self.binding = binding
         self.rust_version = rust_version
@@ -92,9 +100,10 @@ def get_rust_version(self):
     def entry_points(self):
         entry_points = []
         if self.script and self.binding == Binding.Exec:
-            base_mod, name = self.name.rsplit('.')
-            script = '%s=%s.%s:run' % (name, base_mod, '_gen_%s' % name)
-            entry_points.append(script)
+            for name, mod in self.target.items():
+                base_mod, name = mod.rsplit('.')
+                script = '%s=%s.%s:run' % (name, base_mod, '_gen_%s' % name)
+                entry_points.append(script)
 
         return entry_points