generate console script for Exec extension #22

Author: fafhrd91

CHANGES.rst

@@ -4,6 +4,8 @@ CHANGES
 0.7.2 (2017-09-01)
 ------------------
 
+- Generate console-script for Binding.Exec #22
+
 - Remove extra python3 file extension for executables.
 
 

README.rst

@@ -88,6 +88,9 @@ You can define rust extension with `RustExtension` class:
                        `Binding.RustCPython` uses rust-cpython
                        `Binding.NoBinding` uses no binding.
 
+   :param bool script: Generate console script for executable
+                       if `Binding.Exec` is used.
+
    :param bool optional: if it is true, a build failure in the extension will not abort the build process,
                          but instead simply not install the failing extension.
 

setuptools_rust/build.py

@@ -188,6 +188,8 @@ def build_extension(self, ext):
             ext_path, _ = os.path.splitext(ext_path)
             # remove python3 extension (i.e. cpython-36m)
             ext_path, _ = os.path.splitext(ext_path)
+
+            ext.install_script(ext_path)
         else:
             ext_path = build_ext.get_ext_fullpath(target_fname)
 

setuptools_rust/extension.py

@@ -1,5 +1,6 @@
 from __future__ import print_function, absolute_import
 import os
+import os.path
 import sys
 from distutils.errors import DistutilsSetupError
 from .utils import Binding, Strip
@@ -41,22 +42,25 @@ class RustExtension:
         * Strip.No - do not strip symbols
         * Strip.Debug - strip debug symbols
         * Strip.All - strip all symbols
+      script : bool
+        Generate console script for executable if `Binding.Exec` is used.
       optional : bool
         if it is true, a build failure in the extension will not abort the
         build process, but instead simply not install the failing extension.
     """
 
     def __init__(self, name, path,
                  args=None, features=None, rust_version=None,
-                 quiet=False, debug=None, binding=Binding.PyO3, strip=Strip.No,
-                 optional=False):
+                 quiet=False, debug=None, binding=Binding.PyO3,
+                 strip=Strip.No, script=False, optional=False):
         self.name = name
         self.args = args
         self.binding = binding
         self.rust_version = rust_version
         self.quiet = quiet
         self.debug = debug
         self.strip = strip
+        self.script = script
         self.optional = optional
 
         if features is None:
@@ -84,3 +88,36 @@ def get_rust_version(self):
         except:
             raise DistutilsSetupError(
                 'Can not parse rust compiler version: %s', self.rust_version)
+
+    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)
+
+        return entry_points
+
+    def install_script(self, ext_path):
+        if self.script and self.binding == Binding.Exec:
+            dirname, name = os.path.split(ext_path)
+            file = os.path.join(dirname, '_gen_%s.py' % name)
+            with open(file, 'w') as f:
+                f.write(TMPL.format({'name': name}))
+
+
+TMPL = """from __future__ import absolute_import, print_function
+
+import os
+import sys
+
+
+def run():
+    path = os.path.split(__file__)[0]
+    file = os.path.join(path, "%(name)")
+    if os.path.isfile(file):
+        os.execv(file, sys.argv)
+    else:
+        print("Can not execute %(name)")
+
+"""

setuptools_rust/patch.py

@@ -44,6 +44,26 @@ def finalize_options(self):
         if self.distribution.rust_extensions:
             mods.extend(self.distribution.rust_extensions)
 
+            scripts = []
+            for ext in self.distribution.rust_extensions:
+                scripts.extend(ext.entry_points())
+
+            if scripts:
+                if not self.distribution.entry_points:
+                    self.distribution.entry_points = {
+                        'console_scripts': scripts,
+                    }
+                else:
+                    ep_scripts = self.distribution.entry_points.get(
+                        'console_scripts')
+                    if ep_scripts:
+                        ep_scripts.extend(scripts)
+                    else:
+                        ep_scripts = scripts
+
+                    self.distribution.entry_points[
+                        'console_scripts'] = ep_scripts
+
         self.distribution.ext_modules = mods
 
         self.orig_finalize_options()