Enable debug builds for inplace builds, otherwise build release; simplify monkey patch

Author: fafhrd91

CHANGES.rst

@@ -1,6 +1,16 @@
 CHANGES
 =======
 
+0.4 (2017-03-xx)
+----------------
+
+- Use absolute path to cargo manifest
+
+- Enable debug builds for inplace builds, otherwise build release
+
+- Simplify monkey patches
+
+
 0.3.1 (2017-03-09)
 ------------------
 

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup
 
-version = '0.3.1'
+version = '0.4'
 
 
 setup(
@@ -33,6 +33,7 @@
     ],
     entry_points="""
     [distutils.commands]
+    build_ext=setuptools_rust:build_ext
     build_rust=setuptools_rust:build_rust
     """
 )

setuptools_rust/__init__.py

@@ -12,8 +12,11 @@
 import semantic_version
 
 from . import patch  # noqa
+from .build_ext import build_ext
 
-__all__ = ('RustExtension', 'build_rust')
+__all__ = ('RustExtension', 'build_ext', 'build_rust')
+
+patch.monkey_patch_dist(build_ext)
 
 
 class RustExtension:
@@ -35,14 +38,15 @@ class RustExtension:
       quiet : bool
         If True, doesn't echo cargo's output.
       debug : bool
-        Controls whether --debug or --release is passed to cargo.
+        Controls whether --debug or --release is passed to cargo. If set to
+        None then build type is auto-detect. Inplace build is debug build
+        otherwise release. Default: None
     """
 
     def __init__(self, name, path,
                  args=None, features=None, rust_version=None,
-                 quiet=False, debug=False):
+                 quiet=False, debug=None):
         self.name = name
-        self.path = path
         self.args = args
         self.rust_version = rust_version
         self.quiet = quiet
@@ -53,6 +57,17 @@ def __init__(self, name, path,
 
         self.features = [s.strip() for s in features]
 
+        # get absolute path to Cargo manifest file
+        file = sys._getframe(1).f_globals.get('__file__')
+        if file:
+            dirname = os.path.dirname(file)
+            cwd = os.getcwd()
+            os.chdir(dirname)
+            path = os.path.abspath(path)
+            os.chdir(cwd)
+
+        self.path = path
+
     def get_rust_version(self):
         if self.rust_version is None:
             return None
@@ -79,6 +94,8 @@ def get_rust_version():
 class build_rust(Command):
     """ Command for building rust crates via cargo. """
 
+    description = "build Rust extensions (compile/link to build directory)"
+
     user_options = [
         ('inplace', 'i',
          "ignore build-lib and put compiled extensions into the source " +
@@ -124,11 +141,16 @@ def build_extension(self, ext):
         features = set(ext.features)
         features.update(self._cpython_feature())
 
+        if ext.debug is None:
+            debug_build = self.inplace
+        else:
+            debug_build = ext.debug
+
         # build cargo command
         args = (["cargo", "rustc", "--lib", "--manifest-path", ext.path,
                  "--features", " ".join(features)]
                 + list(ext.args or []))
-        if not ext.debug:
+        if not debug_build:
             args.append("--release")
 
         args.extend(["--", '--crate-type', 'cdylib'])
@@ -159,7 +181,7 @@ def build_extension(self, ext):
 
         # Find the shared library that cargo hopefully produced and copy
         # it into the build directory as if it were produced by build_ext.
-        if ext.debug:
+        if debug_build:
             suffix = "debug"
         else:
             suffix = "release"
@@ -186,10 +208,10 @@ def build_extension(self, ext):
         build_ext.inplace = self.inplace
         target_fname = ext.name
         if target_fname is None:
-            target_fname = os.path.splitext(
-                os.path.basename(dylib_path)[3:])[0]
+            target_fname = os.path.basename(os.path.splitext(
+                os.path.basename(dylib_path)[3:])[0])
 
-        ext_path = build_ext.get_ext_fullpath(os.path.basename(target_fname))
+        ext_path = build_ext.get_ext_fullpath(target_fname)
         try:
             os.makedirs(os.path.dirname(ext_path))
         except OSError:

setuptools_rust/build_ext.py

@@ -0,0 +1,26 @@
+from distutils import log
+from setuptools.command.build_ext import build_ext as _build_ext
+
+
+class build_ext(_build_ext):
+
+    def __init__(self, *args):
+        _build_ext.__init__(self, *args)
+
+    def has_rust_extensions(self):
+        return (self.distribution.rust_extensions and
+                len(self.distribution.rust_extensions) > 0)
+
+    def check_extensions_list(self, extensions):
+        if extensions:
+            _build_ext.check_extensions_list(extensions)
+
+    def run(self):
+        """Run build_rust sub command """
+        if self.has_rust_extensions():
+            log.info("running build_rust")
+            build_rust = self.get_finalized_command('build_rust')
+            build_rust.inplace = self.inplace
+            build_rust.run()
+
+        _build_ext.run(self)

setuptools_rust/patch.py

@@ -1,92 +1,27 @@
-from distutils.dist import Distribution
-from distutils.command.build import build as Build
-from setuptools.command import develop
+from setuptools.dist import Distribution
 
-try:
-    from setuptools.command.py36compat import sdist_add_defaults
-    has_py36compat = True
-except ImportError:
-    has_py36compat = False
 
+def monkey_patch_dist(build_ext):
+    # allow to use 'rust_extensions' parameter for setup() call
+    Distribution.rust_extensions = ()
 
-# allow to use 'rust_extensions' parameter for setup() call
-Distribution.rust_extensions = ()
+    # replace setuptools build_ext
+    Distribution.orig_get_command_class = Distribution.get_command_class
 
+    def get_command_class(self, command):
+        if command == 'build_ext':
+            if command not in self.cmdclass:
+                self.cmdclass[command] = build_ext
 
-orig_has_ext_modules = Distribution.has_ext_modules
+        return self.orig_get_command_class(command)
 
-def has_ext_modules(self):
-    return (self.ext_modules and len(self.ext_modules) > 0 or
-            self.rust_extensions and len(self.rust_extensions) > 0)
+    Distribution.get_command_class = get_command_class
 
+    # use custom has_ext_modules
+    Distribution.orig_has_ext_modules = Distribution.has_ext_modules
 
-Distribution.has_ext_modules = has_ext_modules
+    def has_ext_modules(self):
+        return (self.ext_modules and len(self.ext_modules) > 0 or
+                self.rust_extensions and len(self.rust_extensions) > 0)
 
-
-# add support for build_rust sub-command
-def has_rust_extensions(self):
-    return (self.distribution.rust_extensions and
-            len(self.distribution.rust_extensions) > 0)
-
-
-Build.has_rust_extensions = has_rust_extensions
-Build.sub_commands.append(('build_rust', Build.has_rust_extensions))
-
-# monkey patch "develop" command
-orig_run_command = develop.develop.run_command
-
-
-def monkey_run_command(self, cmd):
-    orig_run_command(self, cmd)
-
-    if cmd == 'build_ext':
-        self.reinitialize_command('build_rust', inplace=1)
-        orig_run_command(self, 'build_rust')
-
-
-develop.develop.run_command = monkey_run_command
-
-
-if has_py36compat:
-    # monkey patch "sdist_add_defaults"
-
-    def _add_defaults_ext(self):
-        if (self.distribution.ext_modules and
-                len(self.distribution.ext_modules) > 0):
-            build_ext = self.get_finalized_command('build_ext')
-            self.filelist.extend(build_ext.get_source_files())
-
-    sdist_add_defaults._add_defaults_ext = _add_defaults_ext
-else:
-    from distutils.command.build_ext import build_ext
-    from setuptools.command.bdist_egg import bdist_egg
-
-    orig_get_source_files = build_ext.get_source_files
-
-    def get_source_files(self):
-        if self.extensions:
-            return orig_get_source_files(self)
-        else:
-            return []
-
-    build_ext.get_source_files = get_source_files
-
-    orig_get_ext_outputs = bdist_egg.get_ext_outputs
-
-    def get_ext_outputs(self):
-        Distribution.has_ext_modules = orig_has_ext_modules
-        try:
-            return orig_get_ext_outputs(self)
-        finally:
-            Distribution.has_ext_modules = has_ext_modules
-
-
-    bdist_egg.get_ext_outputs = get_ext_outputs
-
-    orig_run = bdist_egg.run
-
-    def run(self):
-        self.run_command("build_rust")
-        orig_run(self)
-
-    bdist_egg.run = run
+    Distribution.has_ext_modules = has_ext_modules