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 shutil
import argparse
import warnings

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


DESCRIPTION = """\
General container that maps a wide range of Python values directly to memory.\
"""

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

The ``xnd`` module implements a container type that maps most Python values
relevant for scientific computing directly to typed memory.

Whenever possible, a single, pointer-free memory block is used.

``xnd`` supports ragged arrays, categorical types, indexing, slicing, aligned
memory blocks and type inference.

Operations like indexing and slicing return zero-copy typed views on the data.

Importing PEP-3118 buffers is supported.

Links
-----

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

"""

warnings.simplefilter("ignore", UserWarning)


# 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 = "libxnd.dylib"
    LIBSONAME = "libxnd.0.dylib"
    LIBSHARED = "libxnd.0.2.0dev3.dylib"
else:
    LIBNAME = "libxnd.so"
    LIBSONAME = "libxnd.so.0"
    LIBSHARED = "libxnd.so.0.2.0dev3"
    LIBNDTYPES = "libndtypes.so.0.2.0dev3"

if "install" in sys.argv or "bdist_wheel" in sys.argv:
    CONFIGURE_INCLUDES = "%s/ndtypes" % get_python_lib()
    CONFIGURE_LIBS = CONFIGURE_INCLUDES
    INCLUDES = LIBS = [CONFIGURE_INCLUDES]
    LIBXNDDIR = "%s/xnd" % get_python_lib()
    INSTALL_LIBS = True
elif "conda_install" in sys.argv:
    site = "%s/ndtypes" % get_python_lib()
    sys_includes = os.path.join(os.environ['PREFIX'], "include")
    libdir = "Library/bin" if sys.platform == "win32" else "lib"
    sys_libs = os.path.join(os.environ['PREFIX'], libdir)
    CONFIGURE_INCLUDES = INCLUDES = [sys_includes, site]
    LIBS = [sys_libs, site]
    LIBXNDDIR = "%s/xnd" % get_python_lib()
    INSTALL_LIBS = False
else:
    CONFIGURE_INCLUDES = "../python/ndtypes"
    CONFIGURE_LIBS = CONFIGURE_INCLUDES
    INCLUDES = LIBS = [CONFIGURE_INCLUDES]
    LIBXNDDIR = "../python/xnd"
    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


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 xnd module in build directory")

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

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


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
    CONFIGURE_INCLUDES = "%s/ndtypes" % localdir
    CONFIGURE_LIBS = CONFIGURE_INCLUDES
    INCLUDES = LIBS = [CONFIGURE_INCLUDES]
    LIBXNDDIR = "%s/xnd" % localdir
    INSTALL_LIBS = True

    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' or sys.argv[1] == 'conda_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_xnd.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/xnd")
        shutil.rmtree("__pycache__", ignore_errors=True)
        for f in glob("_xnd*.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 configure(configure_includes, configure_libs):
    os.chmod("./configure", 0x1ed) # pip removes execute permissions.
    make = "make -j%d" % int(PARALLEL) if PARALLEL else "make"
    os.system("./configure --with-includes='%s' --with-libs='%s' && %s" %
              (configure_includes, configure_libs, make))

def get_config_vars():
    f = open("config.h")
    config_vars = {}
    for line in f:
        if line.startswith("#define"):
            l = line.split()
            try:
                config_vars[l[1]] = int(l[2])
            except ValueError:
                pass
        elif line.startswith("/* #undef"):
            l = line.split()
            config_vars[l[2]] = 0
    f.close()
    return config_vars

def xnd_ext():
    include_dirs = ["libxnd", "ndtypes/python/ndtypes"] + INCLUDES
    library_dirs = ["libxnd", "ndtypes/libndtypes"] + LIBS
    depends = ["libxnd/xnd.h", "python/xnd/util.h", "python/xnd/pyxnd.h"]
    sources = ["python/xnd/_xnd.c"]

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

        if BUILD_ALL:
            from distutils.msvc9compiler import MSVCCompiler
            MSVCCompiler().initialize()
            os.chdir("vcbuild")
            os.environ['LIBNDTYPESINCLUDE'] = os.path.normpath(CONFIGURE_INCLUDES)
            os.environ['LIBNDTYPESDIR'] = os.path.normpath(CONFIGURE_LIBS)
            if ARCH == "64bit":
                  os.system("vcbuild64.bat")
            else:
                  os.system("vcbuild32.bat")
            os.chdir("..")

    else:
        if BUILD_ALL:
            configure(CONFIGURE_INCLUDES, CONFIGURE_LIBS)

        config_vars = get_config_vars()

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

        if config_vars["HAVE_CUDA"]:
            libraries += ["cudart"]

            for d in [
                "/usr/cuda/lib",
                "/usr/cuda/lib64",
                "/usr/local/cuda/lib/",
                "/usr/local/cuda/lib64"]:
                if os.path.isdir(d):
                    library_dirs.append(d)

    return Extension (
      "xnd._xnd",
      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 = "xnd",
    version = "0.2.0dev3",
    description = DESCRIPTION,
    long_description = LONG_DESCRIPTION,
    url = "https://github.com/plures/xnd",
    author = 'Stefan Krah',
    author_email = 'skrah@bytereef.org',
    license = "BSD License",
    keywords = ["xnd", "array computing", "container", "memory blocks"],
    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"
    ],
    install_requires = ["ndtypes == v0.2.0dev3"],
    package_dir = {"": "python"},
    packages = ["xnd"],
    package_data = {"xnd": ["libxnd*", "xnd.h", "pyxnd.h", "contrib/*"]
                           if INSTALL_LIBS else ["pyxnd.h", "contrib/*"]},
    ext_modules = [xnd_ext()],
)

copy_ext()

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