setup.py

#
# BSD 3-Clause License
#
# Copyright (c) 2017-2018, plures
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
#    this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#


import sys, os

if "bdist_wheel" in sys.argv:
    from setuptools import setup, Extension
else:
    from distutils.core import setup, Extension

from distutils.sysconfig import get_python_lib
from glob import glob
import platform
import subprocess
import argparse
import shutil

try:
    import sphinx.cmd
    SPHINX_BUILD = "sphinx.cmd.build"
except:
    SPHINX_BUILD = "sphinx"


DESCRIPTION =  """\
Dynamic types for data description and in-memory computations.\
"""

LONG_DESCRIPTION = """
Overview
--------

The ``ndtypes`` module is the Python interface to the ``libndtypes`` library.
``libndtypes`` implements dynamic types relevant for scientific computing.

These types contain full memory layout information and are used both for type
checking and  accessing values in memory.

Types are specified using a close variant of the datashape language.

``ndtypes`` supports other container modules.  It displays types, performs
type checking, and the concrete type layout information is used to traverse
memory.

As an example, ``xnd`` is a container module that is based on ``ndtypes``.

Links
-----

* https://github.com/plures/
* http://ndtypes.readthedocs.io/en/latest/
* http://xnd.readthedocs.io/en/latest/
"""

# Pre-parse and remove the '-j' argument from sys.argv.
parser = argparse.ArgumentParser()
parser.add_argument('-j', default=None)
values, rest = parser.parse_known_args()
PARALLEL = values.j
sys.argv = sys.argv[:1] + rest


if sys.platform == "darwin":
    LIBNAME = "libndtypes.dylib"
    LIBSONAME = "libndtypes.0.dylib"
    LIBSHARED = "libndtypes.0.2.0dev3.dylib"
else:
    LIBNAME = "libndtypes.so"
    LIBSONAME = "libndtypes.so.0"
    LIBSHARED = "libndtypes.so.0.2.0dev3"

if "install" in sys.argv or "bdist_wheel" in sys.argv:
    LIBNDTYPESDIR = "%s/ndtypes" % get_python_lib()
    INSTALL_LIBS = True
else:
    LIBNDTYPESDIR = "../python/ndtypes"
    INSTALL_LIBS = False

PY_MAJOR = sys.version_info[0]
PY_MINOR = sys.version_info[1]
ARCH = platform.architecture()[0]
BUILD_ALL = \
    "build" in sys.argv or "install" in sys.argv or "bdist_wheel" in sys.argv
WITH_VALGRIND = False


if PY_MAJOR < 3:
    raise NotImplementedError(
        "python2 support is not implemented")


def get_module_path():
    pathlist = glob("build/lib.*/")
    if pathlist:
        return pathlist[0]
    raise RuntimeError("cannot find ndtypes module in build directory")

def copy_ext():
    if sys.platform == "win32":
        pathlist = glob("build/lib.*/ndtypes/_ndtypes.*.pyd")
    else:
        pathlist = glob("build/lib.*/ndtypes/_ndtypes.*.so")
    if pathlist:
        shutil.copy2(pathlist[0], "python/ndtypes")

def make_symlinks():
    os.chdir(LIBNDTYPESDIR)
    os.chmod(LIBSHARED, 0o755)
    os.system("ln -sf %s %s" % (LIBSHARED, LIBSONAME))
    os.system("ln -sf %s %s" % (LIBSHARED, LIBNAME))


if "--with-valgrind" in sys.argv:
    WITH_VALGRIND = True
    sys.argv.remove("--with-valgrind")


if len(sys.argv) == 3 and sys.argv[1] == "install" and \
    sys.argv[2].startswith("--local"):
    localdir = sys.argv[2].split("=")[1]
    sys.argv = sys.argv[:2] + [
        "--install-base=" + localdir,
        "--install-purelib=" + localdir,
        "--install-platlib=" + localdir,
        "--install-scripts=" + localdir,
        "--install-data=" + localdir,
        "--install-headers=" + localdir]

    LIBNDTYPESDIR = "%s/ndtypes" % localdir

    if sys.platform == "darwin": # homebrew bug
        sys.argv.append("--prefix=")

elif len(sys.argv) == 2:
    if sys.argv[1] == 'module':
       sys.argv[1] = 'build'
    if sys.argv[1] == 'module_install':
       sys.argv[1] = 'install'
    if sys.argv[1] == 'test':
        module_path = get_module_path()
        python_path = os.getenv('PYTHONPATH')
        path = module_path + ':' + python_path if python_path else module_path
        env = os.environ.copy()
        env['PYTHONPATH'] = path
        ret = subprocess.call([sys.executable, "python/test_ndtypes.py", "--long"], env=env)
        sys.exit(ret)
    elif sys.argv[1] == 'doctest':
        os.chdir("doc")
        module_path = '../python'
        python_path = os.getenv('PYTHONPATH')
        path = module_path + ':' + python_path if python_path else module_path
        env = os.environ.copy()
        env['PYTHONPATH'] = path
        cmd = [sys.executable, "-m", SPHINX_BUILD,
               "-b", "doctest", "-d", "build/doctrees", ".", "build/html"]
        ret = subprocess.call(cmd, env=env)
        sys.exit(ret)
    elif sys.argv[1] == 'clean':
        shutil.rmtree("build", ignore_errors=True)
        os.chdir("python/ndtypes")
        shutil.rmtree("__pycache__", ignore_errors=True)
        for f in glob("_ndtypes*.so"):
            os.remove(f)
        sys.exit(0)
    elif sys.argv[1] == 'distclean':
        if sys.platform == "win32":
            os.chdir("vcbuild")
            os.system("vcdistclean.bat")
        else:
            os.system("make distclean")
        sys.exit(0)
    else:
        pass


def ndtypes_ext():
    include_dirs = ["libndtypes"]
    library_dirs = ["libndtypes"]
    depends = ["libndtypes/ndtypes.h", "python/ndtypes/pyndtypes.h"]
    sources = ["python/ndtypes/_ndtypes.c"]

    if sys.platform == "win32":
        libraries = ["libndtypes-0.2.0dev3.dll"]
        extra_compile_args = ["/DNDT_IMPORT"]
        extra_link_args = []
        runtime_library_dirs = []

        if BUILD_ALL:
            from distutils.msvc9compiler import MSVCCompiler
            MSVCCompiler().initialize()
            os.chdir("vcbuild")
            if ARCH == "64bit":
                  os.system("vcbuild64.bat")
            else:
                  os.system("vcbuild32.bat")
            os.chdir("..")

    else:
        libraries = [":%s" % LIBSHARED]
        extra_compile_args = ["-Wextra", "-Wno-missing-field-initializers", "-std=c11"]
        if sys.platform == "darwin":
            libraries = ["ndtypes"]
            extra_link_args = ["-Wl,-rpath,@loader_path"]
            runtime_library_dirs = []
        else:
            libraries = [":%s" % LIBSHARED]
            extra_link_args = []
            runtime_library_dirs = ["$ORIGIN"]

        if BUILD_ALL:
            make = "make -j%d" % int(PARALLEL) if PARALLEL else "make"
            if WITH_VALGRIND:
                os.system("./configure --with-valgrind && %s" % make)
            else:
                os.system("./configure && %s" % make)

    return Extension (
      "ndtypes._ndtypes",
      include_dirs = include_dirs,
      library_dirs = library_dirs,
      depends = depends,
      sources = sources,
      libraries = libraries,
      extra_compile_args = extra_compile_args,
      extra_link_args = extra_link_args,
      runtime_library_dirs = runtime_library_dirs
    )

setup (
    name = "ndtypes",
    version = "0.2.0dev3",
    description = DESCRIPTION,
    long_description = LONG_DESCRIPTION,
    url = "https://github.com/plures/ndtypes",
    author = 'Stefan Krah',
    author_email = 'skrah@bytereef.org',
    license = "BSD License",
    keywords = ["ndtypes", "array computing", "data description"],
    platforms = ["Many"],
    classifiers = [
        "Development Status :: 4 - Beta",
        "Intended Audience :: Developers",
        "Intended Audience :: Education",
        "Intended Audience :: End Users/Desktop",
        "Intended Audience :: Financial and Insurance Industry",
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: BSD License",
        "Programming Language :: C",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.6",
        "Programming Language :: Python :: 3.7",
        "Operating System :: OS Independent",
        "Topic :: Scientific/Engineering :: Mathematics",
        "Topic :: Software Development"
    ],
    package_dir = {"": "python"},
    packages = ["ndtypes"],
    package_data = {"ndtypes": ["libndtypes*", "ndtypes.h", "pyndtypes.h"]
                               if INSTALL_LIBS
                               else ["pyndtypes.h"]},
    ext_modules = [ndtypes_ext()],
)

copy_ext()

if INSTALL_LIBS and sys.platform != "win32" and not "bdist_wheel" in sys.argv:
    make_symlinks()