Merge pull request #101 from isuruf/setup

In-place and out-of-tree builds using setup.py

Author: isuruf

README.md

@@ -35,12 +35,13 @@ Python wrappers can be installed by,
 
 Additional options to setup.py are
 
-    python setup.py install build
+    python setup.py install build_ext
         --symengine-dir=/path/to/symengine/install/dir          # Path to SymEngine install directory or build directory
         --compiler=mingw32|msvc|cygwin                          # Select the compiler for Windows
         --generator=cmake-generator                             # CMake Generator
         --build-type=Release|Debug                              # Set build-type for multi-configuration generators like MSVC
         --define="var1=value1;var2=value2"                      # Give options to CMake
+        --inplace                                               # Build the extension in source tree
 
 Standard options to setup.py like `--user`, `--prefix` can be used to configure install location
 

appveyor.yml

@@ -83,9 +83,9 @@ install:
 
 build_script:
 
-- if [%COMPILER%]==[MSVC15] python setup.py install build --compiler=msvc --build-type=%BUILD_TYPE%
-- if [%COMPILER%]==[MinGW] python setup.py install build --compiler=mingw
-- if [%COMPILER%]==[MinGW-w64] python setup.py install build --compiler=mingw
+- if [%COMPILER%]==[MSVC15] python setup.py install build_ext --compiler=msvc --build-type=%BUILD_TYPE%
+- if [%COMPILER%]==[MinGW] python setup.py install build_ext --compiler=mingw --inplace
+- if [%COMPILER%]==[MinGW-w64] python setup.py install build_ext --compiler=mingw --inplace
 
 test_script:
 - if not [%COMPILER%]==[MSVC15] nosetests

bin/test_travis.sh

@@ -5,8 +5,8 @@ set -e
 # Echo each command
 set -x
 
-# Build and install python wrappers
-python setup.py install --symengine-dir=$our_install_dir
+# Build inplace so that nosetests can be run inside source directory
+python setup.py install build_ext --inplace --symengine-dir=$our_install_dir
 
 # Test python wrappers
 if [[ "${WITH_SAGE}" != "yes" ]]; then

setup.py

@@ -1,5 +1,6 @@
 from __future__ import print_function
-from os import getenv, path
+from os import getenv, path, makedirs
+import os
 import subprocess
 import sys
 
@@ -20,6 +21,7 @@
         print("Value {} for USE_DISTUTILS treated as False".\
               format(use_distutils))
 
+from distutils.command.build_ext import build_ext as _build_ext
 from distutils.command.build import build as _build
 
 if use_setuptools:
@@ -40,26 +42,37 @@
 def process_opts(opts):
     return ['-D'+'='.join(o) for o in opts]
 
+def get_build_dir(dist):
+    source_dir = path.dirname(path.realpath(__file__))
+    build = dist.get_command_obj('build')
+    build_ext = dist.get_command_obj('build_ext')
+    return source_dir if build_ext.inplace else build.build_platlib
+
+global_user_options = [
+    ('symengine-dir=', None, 'path to symengine installation or build directory'),
+    ('generator=', None, 'cmake build generator'),
+    ('build-type=', None, 'build type: Release or Debug'),
+    ('define=', 'D',
+     'options to cmake <var>:<type>=<value>'),
+]
+
 class BuildWithCmake(_build):
-    _build_opts = _build.user_options
-    user_options = [
-        ('symengine-dir=', None, 'path to symengine installation or build directory'),
-        ('generator=', None, 'cmake build generator'),
-        ('build-type=', None, 'build type: Release or Debug'),
-        ('define=', 'D',
-         'options to cmake <var>:<type>=<value>')
-    ]
+    sub_commands = [('build_ext', None)]
+
+class BuildExtWithCmake(_build_ext):
+    _build_opts = _build_ext.user_options
+    user_options = list(global_user_options)
     user_options.extend(_build_opts)
 
     def initialize_options(self):
-        _build.initialize_options(self)
+        _build_ext.initialize_options(self)
         self.define = None
         self.symengine_dir = None
         self.generator = None
         self.build_type = "Release"
 
     def finalize_options(self):
-        _build.finalize_options(self)
+        _build_ext.finalize_options(self)
         # The argument parsing will result in self.define being a string, but
         # it has to be a list of 2-tuples.
         # Multiple symbols can be separated with semi-colons.
@@ -78,15 +91,22 @@ def finalize_options(self):
         cmake_build_type[0] = self.build_type
 
     def cmake_build(self):
-        dir = path.dirname(path.realpath(__file__))
-        cmake_cmd = ["cmake", dir, "-DCMAKE_BUILD_TYPE=" + cmake_build_type[0]]
+        source_dir = path.dirname(path.realpath(__file__))
+        build_dir = get_build_dir(self.distribution)
+        if not path.exists(build_dir):
+            makedirs(build_dir)
+        if build_dir != source_dir and path.exists("CMakeCache.txt"):
+            os.remove("CMakeCache.txt")
+
+        cmake_cmd = ["cmake", source_dir, "-DCMAKE_BUILD_TYPE=" + cmake_build_type[0]]
         cmake_cmd.extend(process_opts(cmake_opts))
-        if not path.exists("CMakeCache.txt"):
+        if not path.exists(path.join(build_dir, "CMakeCache.txt")):
             cmake_cmd.extend(self.get_generator())
-        if subprocess.call(cmake_cmd) != 0:
+        if subprocess.call(cmake_cmd, cwd=build_dir) != 0:
             raise EnvironmentError("error calling cmake")
 
-        if subprocess.call(["cmake", "--build", ".", "--config", cmake_build_type[0]]) != 0:
+        if subprocess.call(["cmake", "--build", ".", "--config", cmake_build_type[0]],
+                cwd=build_dir) != 0:
             raise EnvironmentError("error building project")
 
     def get_generator(self):
@@ -108,25 +128,17 @@ def get_generator(self):
 
     def run(self):
         self.cmake_build()
-        # can't use super() here because _build is an old style class in 2.7
-        _build.run(self)
+        # can't use super() here because _build_ext is an old style class in 2.7
+        _build_ext.run(self)
 
 class InstallWithCmake(_install):
     _install_opts = _install.user_options
-    user_options = [
-        ('symengine-dir=', None, 'path to symengine installation or build directory'),
-        ('generator=', None, 'cmake build generator'),
-        ('build-type=', None, 'build type: Release or Debug'),
-        ('define=', 'D',
-         'options to cmake <var>:<type>=<value>')
-    ]
+    user_options = list(global_user_options)
     user_options.extend(_install_opts)
 
     def initialize_options(self):
         _install.initialize_options(self)
         self.define = None
-        self.symengine_dir = None
-        self.generator = None
         self.build_type = "Release"
 
     def finalize_options(self):
@@ -140,27 +152,24 @@ def finalize_options(self):
                            tuple(ss.strip() for ss in s.split('='))
                            for s in defines]
             cmake_opts.extend(self.define)
-        if self.symengine_dir:
-            cmake_opts.extend([('SymEngine_DIR', self.symengine_dir)])
-
-        if self.generator:
-            cmake_generator[0] = self.generator
 
         cmake_build_type[0] = self.build_type
         cmake_opts.extend([('PYTHON_INSTALL_PATH', self.install_platlib)])
         cmake_opts.extend([('PYTHON_INSTALL_HEADER_PATH', self.install_headers)])
 
     def cmake_install(self):
-        dir = path.dirname(path.realpath(__file__))
-        cmake_cmd = ["cmake", dir]
+        source_dir = path.dirname(path.realpath(__file__))
+        build_dir = get_build_dir(self.distribution)
+        cmake_cmd = ["cmake", source_dir]
         cmake_cmd.extend(process_opts(cmake_opts))
 
         # CMake has to be called here to update PYTHON_INSTALL_PATH
         # if build and install were called separately by the user
-        if subprocess.call(cmake_cmd) != 0:
+        if subprocess.call(cmake_cmd, cwd=build_dir) != 0:
             raise EnvironmentError("error calling cmake")
 
-        if subprocess.call(["cmake", "--build", ".", "--config", cmake_build_type[0], "--target", "install"]) != 0:
+        if subprocess.call(["cmake", "--build", ".", "--config", cmake_build_type[0], "--target", "install"],
+                cwd=build_dir) != 0:
             raise EnvironmentError("error installing")
 
         import compileall
@@ -187,6 +196,7 @@ def run(self):
       url = "https://github.com/symengine/symengine.py",
       cmdclass={
           'build' : BuildWithCmake,
+          'build_ext' : BuildExtWithCmake,
           'install' : InstallWithCmake,
           },
       classifiers=[