setup.py 28.8 KB
Newer Older
Damien Naudet's avatar
Damien Naudet committed
1 2 3 4
#!/usr/bin/python
# coding: utf8
# /*##########################################################################
#
5
# Copyright (c) 2015-2019 European Synchrotron Radiation Facility
Damien Naudet's avatar
Damien Naudet committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/

Damien Naudet's avatar
Damien Naudet committed
27
__authors__ = ["Jérôme Kieffer", "Thomas Vincent"]
28
__date__ = "23/04/2018"
Damien Naudet's avatar
Damien Naudet committed
29 30
__license__ = "MIT"

Damien Naudet's avatar
Damien Naudet committed
31

Damien Naudet's avatar
Damien Naudet committed
32 33 34
import sys
import os
import platform
Damien Naudet's avatar
Damien Naudet committed
35 36 37
import shutil
import logging
import glob
38 39 40 41
# io import has to be here also to fix a bug on Debian 7 with python2.7
# Without this, the system io module is not loaded from numpy.distutils.
# The silx.io module seems to be loaded instead.
import io
Damien Naudet's avatar
Damien Naudet committed
42 43 44 45

logging.basicConfig(level=logging.INFO)

logger = logging.getLogger("xsocs.setup")
Damien Naudet's avatar
Damien Naudet committed
46 47


Damien Naudet's avatar
Damien Naudet committed
48 49
from distutils.command.clean import clean as Clean
from distutils.command.build import build as _build
Damien Naudet's avatar
Damien Naudet committed
50
try:
Damien Naudet's avatar
Damien Naudet committed
51
    from setuptools import Command
Damien Naudet's avatar
Damien Naudet committed
52 53 54
    from setuptools.command.build_py import build_py as _build_py
    from setuptools.command.build_ext import build_ext
    from setuptools.command.sdist import sdist
Damien Naudet's avatar
Damien Naudet committed
55
    logger.info("Use setuptools")
Damien Naudet's avatar
Damien Naudet committed
56
except ImportError:
Damien Naudet's avatar
Damien Naudet committed
57 58 59 60
    try:
        from numpy.distutils.core import Command
    except ImportError:
        from distutils.core import Command
Damien Naudet's avatar
Damien Naudet committed
61 62 63
    from distutils.command.build_py import build_py as _build_py
    from distutils.command.build_ext import build_ext
    from distutils.command.sdist import sdist
Damien Naudet's avatar
Damien Naudet committed
64
    logger.info("Use distutils")
Damien Naudet's avatar
Damien Naudet committed
65

Damien Naudet's avatar
Damien Naudet committed
66 67 68 69 70 71 72
try:
    import sphinx
    import sphinx.util.console
    sphinx.util.console.color_terminal = lambda: False
    from sphinx.setup_command import BuildDoc
except ImportError:
    sphinx = None
Damien Naudet's avatar
Damien Naudet committed
73 74


Damien Naudet's avatar
Damien Naudet committed
75 76 77 78 79 80 81 82
PROJECT = "xsocs"

if "LANG" not in os.environ and sys.platform == "darwin" and sys.version_info[0] > 2:
    print("""WARNING: the LANG environment variable is not defined,
an utf-8 LANG is mandatory to use setup.py, you may face unexpected UnicodeError.
export LANG=en_US.utf-8
export LC_ALL=en_US.utf-8
""")
Damien Naudet's avatar
Damien Naudet committed
83

84

Damien Naudet's avatar
Damien Naudet committed
85
def get_version():
Damien Naudet's avatar
Damien Naudet committed
86
    """Returns current version number from version.py file"""
Damien Naudet's avatar
Damien Naudet committed
87 88 89 90 91
    import version
    return version.strictversion


def get_readme():
Damien Naudet's avatar
Damien Naudet committed
92
    """Returns content of README.rst file"""
Damien Naudet's avatar
Damien Naudet committed
93
    dirname = os.path.dirname(os.path.abspath(__file__))
Damien Naudet's avatar
Damien Naudet committed
94 95
    filename = os.path.join(dirname, "README.rst")
    with io.open(filename, "r", encoding="utf-8") as fp:
Damien Naudet's avatar
Damien Naudet committed
96 97 98 99
        long_description = fp.read()
    return long_description


Damien Naudet's avatar
Damien Naudet committed
100
classifiers = ["Development Status :: 4 - Beta",
Damien Naudet's avatar
Damien Naudet committed
101 102 103 104 105 106 107 108
               "Environment :: Console",
               "Environment :: MacOS X",
               "Environment :: Win32 (MS Windows)",
               "Environment :: X11 Applications :: Qt",
               "Intended Audience :: Education",
               "Intended Audience :: Science/Research",
               "License :: OSI Approved :: MIT License",
               "Natural Language :: English",
109
               "Operating System :: Microsoft :: Windows",
Damien Naudet's avatar
Damien Naudet committed
110 111 112 113 114
               "Operating System :: POSIX",
               "Programming Language :: Cython",
               "Programming Language :: Python :: 2.7",
               "Programming Language :: Python :: 3.4",
               "Programming Language :: Python :: 3.5",
115 116
               "Programming Language :: Python :: 3.6",
               "Programming Language :: Python :: 3.7",
Damien Naudet's avatar
Damien Naudet committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
               "Programming Language :: Python :: Implementation :: CPython",
               "Topic :: Scientific/Engineering :: Physics",
               "Topic :: Software Development :: Libraries :: Python Modules",
               ]


# ########## #
# version.py #
# ########## #

class build_py(_build_py):
    """
    Enhanced build_py which copies version.py to <PROJECT>._version.py
    """
    def find_package_modules(self, package, package_dir):
        modules = _build_py.find_package_modules(self, package, package_dir)
        if package == PROJECT:
            modules.append((PROJECT, '_version', 'version.py'))
        return modules


138 139 140 141 142
########
# Test #
########

class PyTest(Command):
143
    """Command to start tests running the script: run_tests.py"""
144 145
    user_options = []

146 147
    description = "Execute the unittests"

148 149 150 151 152 153 154 155
    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        import subprocess
156
        errno = subprocess.call([sys.executable, 'run_tests.py'])
157 158
        if errno != 0:
            raise SystemExit(errno)
Damien Naudet's avatar
Damien Naudet committed
159

160

Damien Naudet's avatar
Damien Naudet committed
161
# ################### #
Damien Naudet's avatar
Damien Naudet committed
162
# build_doc command   #
Damien Naudet's avatar
Damien Naudet committed
163 164
# ################### #

Damien Naudet's avatar
Damien Naudet committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
if sphinx is None:
    class SphinxExpectedCommand(Command):
        """Command to inform that sphinx is missing"""
        user_options = []

        def initialize_options(self):
            pass

        def finalize_options(self):
            pass

        def run(self):
            raise RuntimeError(
                'Sphinx is required to build or test the documentation.\n'
                'Please install Sphinx (http://www.sphinx-doc.org).')


if sphinx is not None:
    class BuildDocCommand(BuildDoc):
        """Command to build documentation using sphinx.

        Project should have already be built.
        """
Damien Naudet's avatar
Damien Naudet committed
188 189 190 191 192 193 194 195

        def run(self):
            # make sure the python path is pointing to the newly built
            # code so that the documentation is built on this and not a
            # previously installed version

            build = self.get_finalized_command('build')
            sys.path.insert(0, os.path.abspath(build.build_lib))
196

Damien Naudet's avatar
Damien Naudet committed
197 198 199 200 201 202 203 204 205 206 207
            # # Copy .ui files to the path:
            # dst = os.path.join(
            #     os.path.abspath(build.build_lib), "silx", "gui")
            # if not os.path.isdir(dst):
            #     os.makedirs(dst)
            # for i in os.listdir("gui"):
            #     if i.endswith(".ui"):
            #         src = os.path.join("gui", i)
            #         idst = os.path.join(dst, i)
            #         if not os.path.exists(idst):
            #             shutil.copy(src, idst)
208

Damien Naudet's avatar
Damien Naudet committed
209
            # Build the Users Guide in HTML and TeX format
Damien Naudet's avatar
Damien Naudet committed
210
            for builder in ['html', 'latex']:
Damien Naudet's avatar
Damien Naudet committed
211 212 213 214 215
                self.builder = builder
                self.builder_target_dir = os.path.join(self.build_dir, builder)
                self.mkpath(self.builder_target_dir)
                BuildDoc.run(self)
            sys.path.pop(0)
Damien Naudet's avatar
Damien Naudet committed
216 217
else:
    BuildDocCommand = SphinxExpectedCommand
Damien Naudet's avatar
Damien Naudet committed
218 219


Damien Naudet's avatar
Damien Naudet committed
220 221 222
# ################### #
# test_doc command    #
# ################### #
Damien Naudet's avatar
Damien Naudet committed
223

Damien Naudet's avatar
Damien Naudet committed
224 225 226
if sphinx is not None:
    class TestDocCommand(BuildDoc):
        """Command to test the documentation using sphynx doctest.
Damien Naudet's avatar
Damien Naudet committed
227

Damien Naudet's avatar
Damien Naudet committed
228 229 230 231 232 233
        http://www.sphinx-doc.org/en/1.4.8/ext/doctest.html
        """
        def run(self):
            # make sure the python path is pointing to the newly built
            # code so that the documentation is built on this and not a
            # previously installed version
Damien Naudet's avatar
Damien Naudet committed
234

Damien Naudet's avatar
Damien Naudet committed
235 236
            build = self.get_finalized_command('build')
            sys.path.insert(0, os.path.abspath(build.build_lib))
Damien Naudet's avatar
Damien Naudet committed
237

Damien Naudet's avatar
Damien Naudet committed
238 239 240 241 242 243 244
            # Build the Users Guide in HTML and TeX format
            for builder in ['doctest']:
                self.builder = builder
                self.builder_target_dir = os.path.join(self.build_dir, builder)
                self.mkpath(self.builder_target_dir)
                BuildDoc.run(self)
            sys.path.pop(0)
Damien Naudet's avatar
Damien Naudet committed
245

Damien Naudet's avatar
Damien Naudet committed
246 247
else:
    TestDocCommand = SphinxExpectedCommand
Damien Naudet's avatar
Damien Naudet committed
248

249

250 251 252 253 254 255 256 257
# ############################# #
# numpy.distutils Configuration #
# ############################# #

def configuration(parent_package='', top_path=None):
    """Recursive construction of package info to be used in setup().

    See http://docs.scipy.org/doc/numpy/reference/distutils.html#numpy.distutils.misc_util.Configuration
Damien Naudet's avatar
Damien Naudet committed
258 259 260 261 262 263 264
    """
    try:
        from numpy.distutils.misc_util import Configuration
    except ImportError:
        raise ImportError(
            "To install this package, you must install numpy first\n"
            "(See https://pypi.python.org/pypi/numpy)")
265 266 267 268 269 270 271 272 273 274 275 276 277 278
    config = Configuration(None, parent_package, top_path)
    config.set_options(
        ignore_setup_xxx_py=True,
        assume_default_configuration=True,
        delegate_options_to_subpackages=True,
        quiet=True)
    config.add_subpackage(PROJECT)
    return config

# ############## #
# Compiler flags #
# ############## #


Damien Naudet's avatar
Damien Naudet committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
class Build(_build):
    """Command to support more user options for the build."""

    user_options = [
        ('no-openmp', None,
         "do not use OpenMP for compiled extension modules"),
        ('openmp', None,
         "use OpenMP for the compiled extension modules"),
        ('no-cython', None,
         "do not compile Cython extension modules (use default compiled c-files)"),
        ('force-cython', None,
         "recompile all Cython extension modules"),
    ]
    user_options.extend(_build.user_options)

    boolean_options = ['no-openmp', 'openmp', 'no-cython', 'force-cython']
    boolean_options.extend(_build.boolean_options)

    def initialize_options(self):
        _build.initialize_options(self)
        self.no_openmp = None
        self.openmp = None
        self.no_cython = None
        self.force_cython = None

    def finalize_options(self):
        _build.finalize_options(self)
        self.finalize_cython_options(min_version='0.21.1')
        self.finalize_openmp_options()

    def _parse_env_as_bool(self, key):
        content = os.environ.get(key, "")
        value = content.lower()
        if value in ["1", "true", "yes", "y"]:
            return True
        if value in ["0", "false", "no", "n"]:
            return False
        if value in ["none", ""]:
            return None
        msg = "Env variable '%s' contains '%s'. But a boolean or an empty \
            string was expected. Variable ignored."
        logger.warning(msg, key, content)
        return None

    def finalize_openmp_options(self):
        """Check if extensions must be compiled with OpenMP.

        The result is stored into the object.
        """
        if self.openmp:
            use_openmp = True
        elif self.no_openmp:
            use_openmp = False
        else:
            env_force_cython = self._parse_env_as_bool("WITH_OPENMP")
            if env_force_cython is not None:
                use_openmp = env_force_cython
            else:
                # Use it by default
                use_openmp = True

        if use_openmp:
            if platform.system() == "Darwin":
                # By default Xcode5 & XCode6 do not support OpenMP, Xcode4 is OK.
                osx = tuple([int(i) for i in platform.mac_ver()[0].split(".")])
                if osx >= (10, 8):
                    logger.warning("OpenMP support ignored. Your platform do not support it")
                    use_openmp = False

        # Remove attributes used by distutils parsing
        # use 'use_openmp' instead
        del self.no_openmp
        del self.openmp
        self.use_openmp = use_openmp

    def finalize_cython_options(self, min_version=None):
        """
        Check if cythonization must be used for the extensions.

        The result is stored into the object.
        """

        if self.force_cython:
            use_cython = "force"
        elif self.no_cython:
            use_cython = "no"
        else:
            env_force_cython = self._parse_env_as_bool("FORCE_CYTHON")
            env_with_cython = self._parse_env_as_bool("WITH_CYTHON")
            if env_force_cython is True:
                use_cython = "force"
            elif env_with_cython is True:
                use_cython = "yes"
            elif env_with_cython is False:
                use_cython = "no"
            else:
                # Use it by default
                use_cython = "yes"

        if use_cython in ["force", "yes"]:
            try:
                import Cython.Compiler.Version
                if min_version and Cython.Compiler.Version.version < min_version:
                    msg = "Cython version is too old. At least version is %s \
                        expected. Cythonization is skipped."
                    logger.warning(msg, str(min_version))
                    use_cython = "no"
            except ImportError:
                msg = "Cython is not available. Cythonization is skipped."
                logger.warning(msg)
                use_cython = "no"

        # Remove attribute used by distutils parsing
        # use 'use_cython' and 'force_cython' instead
        del self.no_cython
        self.force_cython = use_cython == "force"
        self.use_cython = use_cython in ["force", "yes"]


class BuildExt(build_ext):
    """Handle extension compilation.

    Command-line argument and environment can custom:

    - The use of cython to cythonize files, else a default version is used
    - Build extension with support of OpenMP (by default it is enabled)
    - If building with MSVC, compiler flags are converted from gcc flags.
406 407 408 409
    """

    COMPILE_ARGS_CONVERTER = {'-fopenmp': '/openmp'}

410
    LINK_ARGS_CONVERTER = {'-fopenmp': ''}
411

Damien Naudet's avatar
Damien Naudet committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
    description = 'Build xsocs extensions'

    def finalize_options(self):
        build_ext.finalize_options(self)
        build_obj = self.distribution.get_command_obj("build")
        self.use_openmp = build_obj.use_openmp
        self.use_cython = build_obj.use_cython
        self.force_cython = build_obj.force_cython

    def patch_with_default_cythonized_files(self, ext):
        """Replace cython files by .c or .cpp files in extension's sources.

        It replaces the *.pyx and *.py source files of the extensions
        to either *.cpp or *.c source files.
        No compilation is performed.

        :param Extension ext: An extension to patch.
        """
        new_sources = []
        for source in ext.sources:
            base, file_ext = os.path.splitext(source)
            if file_ext in ('.pyx', '.py'):
                if ext.language == 'c++':
                    cythonized = base + '.cpp'
                else:
                    cythonized = base + '.c'
                if not os.path.isfile(cythonized):
                    raise RuntimeError("Source file not found: %s. Cython is needed" % cythonized)
                print("Use default cythonized file for %s" % source)
                new_sources.append(cythonized)
            else:
                new_sources.append(source)
        ext.sources = new_sources

    def patch_extension(self, ext):
        """
        Patch an extension according to requested Cython and OpenMP usage.

        :param Extension ext: An extension
        """
        # Cytonize
        if not self.use_cython:
            self.patch_with_default_cythonized_files(ext)
        else:
            from Cython.Build import cythonize
            patched_exts = cythonize(
                [ext],
459 460
                compiler_directives={'embedsignature': True,
                                     'language_level': 3},
461
                force=self.force_cython
Damien Naudet's avatar
Damien Naudet committed
462 463 464
            )
            ext.sources = patched_exts[0].sources

465
        # Remove OpenMP flags if OpenMP is disabled
Damien Naudet's avatar
Damien Naudet committed
466 467 468 469 470
        if not self.use_openmp:
            ext.extra_compile_args = [
                f for f in ext.extra_compile_args if f != '-fopenmp']
            ext.extra_link_args = [
                f for f in ext.extra_link_args if f != '-fopenmp']
471 472 473

        # Convert flags from gcc to MSVC if required
        if self.compiler.compiler_type == 'msvc':
474 475 476 477 478 479 480 481 482
            extra_compile_args = [self.COMPILE_ARGS_CONVERTER.get(f, f)
                                  for f in ext.extra_compile_args]
            # Avoid empty arg
            ext.extra_compile_args = [arg for arg in extra_compile_args if arg]

            extra_link_args = [self.LINK_ARGS_CONVERTER.get(f, f)
                               for f in ext.extra_link_args]
            # Avoid empty arg
            ext.extra_link_args = [arg for arg in extra_link_args if arg]
Damien Naudet's avatar
Damien Naudet committed
483

484 485 486 487 488 489
        elif self.compiler.compiler_type == 'unix':
            # Avoids runtime symbol collision for manylinux1 platform
            # See issue #1070
            extern = 'extern "C" ' if ext.language == 'c++' else ''
            return_type = 'void' if sys.version_info[0] <= 2 else 'PyObject*'

490 491 492 493 494 495 496 497 498 499 500
            ext.extra_compile_args.append('-fvisibility=hidden')

            import numpy
            numpy_version = [int(i) for i in numpy.version.short_version.split(".", 2)[:2]]
            if numpy_version < [1,16]:
                ext.extra_compile_args.append(
                    '''-D'PyMODINIT_FUNC=%s__attribute__((visibility("default"))) %s ' ''' % (extern, return_type))
            else:
                ext.define_macros.append(
                    ('PyMODINIT_FUNC',
                     '%s__attribute__((visibility("default"))) %s ' % (extern, return_type)))
501

Damien Naudet's avatar
Damien Naudet committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
    def is_debug_interpreter(self):
        """
        Returns true if the script is executed with a debug interpreter.

        It looks to be a non-standard code. It is not working for Windows and
        Mac. But it have to work at least for Debian interpreters.

        :rtype: bool
        """
        if sys.version_info >= (3, 0):
            # It is normalized on Python 3
            # But it is not available on Windows CPython
            if hasattr(sys, "abiflags"):
                return "d" in sys.abiflags
        else:
            # It's a Python 2 interpreter
            # pydebug is not available on Windows/Mac OS interpreters
            if hasattr(sys, "pydebug"):
                return sys.pydebug

        # We can't know if we uses debug interpreter
        return False

    def patch_compiler(self):
        """
        Patch the compiler to:
        - always compile extensions with debug symboles (-g)
        - only compile asserts in debug mode (-DNDEBUG)

        Plus numpy.distutils/setuptools/distutils inject a lot of duplicated
        flags. This function tries to clean up default debug options.
        """
        build_obj = self.distribution.get_command_obj("build")
        if build_obj.debug:
            debug_mode = build_obj.debug
        else:
            # Force debug_mode also when it uses python-dbg
            # It is needed for Debian packaging
            debug_mode = self.is_debug_interpreter()

        if self.compiler.compiler_type == "unix":
            args = list(self.compiler.compiler_so)
            # clean up debug flags -g is included later in another way
            must_be_cleaned = ["-DNDEBUG", "-g"]
            args = filter(lambda x: x not in must_be_cleaned, args)
            args = list(args)

            # always insert symbols
            args.append("-g")
            # only strip asserts in release mode
            if not debug_mode:
                args.append('-DNDEBUG')
            # patch options
            self.compiler.compiler_so = list(args)
556

Damien Naudet's avatar
Damien Naudet committed
557 558 559 560
    def build_extensions(self):
        self.patch_compiler()
        for ext in self.extensions:
            self.patch_extension(ext)
561 562
        build_ext.build_extensions(self)

Damien Naudet's avatar
Damien Naudet committed
563 564 565
################################################################################
# Clean command
################################################################################
566 567


Damien Naudet's avatar
Damien Naudet committed
568 569
class CleanCommand(Clean):
    description = "Remove build artifacts from the source tree"
Damien Naudet's avatar
Damien Naudet committed
570

Damien Naudet's avatar
Damien Naudet committed
571 572
    def expand(self, path_list):
        """Expand a list of path using glob magic.
Damien Naudet's avatar
Damien Naudet committed
573

Damien Naudet's avatar
Damien Naudet committed
574 575 576 577 578 579 580 581 582 583 584 585
        :param list[str] path_list: A list of path which may contains magic
        :rtype: list[str]
        :returns: A list of path without magic
        """
        path_list2 = []
        for path in path_list:
            if glob.has_magic(path):
                iterator = glob.iglob(path)
                path_list2.extend(iterator)
            else:
                path_list2.append(path)
        return path_list2
Damien Naudet's avatar
Damien Naudet committed
586

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
    def find(self, path_list):
        """Find a file pattern if directories.

        Could be done using "**/*.c" but it is only supported in Python 3.5.

        :param list[str] path_list: A list of path which may contains magic
        :rtype: list[str]
        :returns: A list of path without magic
        """
        import fnmatch
        path_list2 = []
        for pattern in path_list:
            for root, _, filenames in os.walk('.'):
                for filename in fnmatch.filter(filenames, pattern):
                    path_list2.append(os.path.join(root, filename))
        return path_list2

Damien Naudet's avatar
Damien Naudet committed
604 605
    def run(self):
        Clean.run(self)
606 607 608 609 610

        cython_files = self.find(["*.pyx"])
        cythonized_files = [path.replace(".pyx", ".c") for path in cython_files]
        cythonized_files += [path.replace(".pyx", ".cpp") for path in cython_files]

Damien Naudet's avatar
Damien Naudet committed
611 612 613 614
        # really remove the directories
        # and not only if they are empty
        to_remove = [self.build_base]
        to_remove = self.expand(to_remove)
615
        to_remove += cythonized_files
Damien Naudet's avatar
Damien Naudet committed
616 617 618 619 620 621 622 623 624 625 626

        if not self.dry_run:
            for path in to_remove:
                try:
                    if os.path.isdir(path):
                        shutil.rmtree(path)
                    else:
                        os.remove(path)
                    logger.info("removing '%s'", path)
                except OSError:
                    pass
Damien Naudet's avatar
Damien Naudet committed
627

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
################################################################################
# Source tree
################################################################################

class SourceDistWithCython(sdist):
    """
    Force cythonization of the extensions before generating the source
    distribution.

    To provide the widest compatibility the cythonized files are provided
    without suppport of OpenMP.
    """

    description = "Create a source distribution including cythonozed files (tarball, zip file, etc.)"

    def finalize_options(self):
        sdist.finalize_options(self)
        self.extensions = self.distribution.ext_modules

    def run(self):
        self.cythonize_extensions()
        sdist.run(self)

    def cythonize_extensions(self):
        from Cython.Build import cythonize
        cythonize(
            self.extensions,
655 656
            compiler_directives={'embedsignature': True,
                                 'language_level': 3},
657 658 659
            force=True
        )

Damien Naudet's avatar
Damien Naudet committed
660 661 662 663 664 665 666 667 668 669
################################################################################
# Debian source tree
################################################################################


class sdist_debian(sdist):
    """
    Tailor made sdist for debian
    * remove auto-generated doc
    * remove cython generated .c files
670
    * remove cython generated .cpp files
Damien Naudet's avatar
Damien Naudet committed
671 672
    * remove .bat files
    * include .l man files
Damien Naudet's avatar
Damien Naudet committed
673
    """
674 675 676

    description = "Create a source distribution for Debian (tarball, zip file, etc.)"

Damien Naudet's avatar
Damien Naudet committed
677 678 679 680 681 682
    @staticmethod
    def get_debian_name():
        import version
        name = "%s_%s" % (PROJECT, version.debianversion)
        return name

Damien Naudet's avatar
Damien Naudet committed
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
    def prune_file_list(self):
        sdist.prune_file_list(self)
        to_remove = ["doc/build", "doc/pdf", "doc/html", "pylint", "epydoc"]
        print("Removing files for debian")
        for rm in to_remove:
            self.filelist.exclude_pattern(pattern="*", anchor=False, prefix=rm)

        # this is for Cython files specifically: remove C & html files
        search_root = os.path.dirname(os.path.abspath(__file__))
        for root, _, files in os.walk(search_root):
            for afile in files:
                if os.path.splitext(afile)[1].lower() == ".pyx":
                    base_file = os.path.join(root, afile)[len(search_root) + 1:-4]
                    self.filelist.exclude_pattern(pattern=base_file + ".c")
                    self.filelist.exclude_pattern(pattern=base_file + ".cpp")
                    self.filelist.exclude_pattern(pattern=base_file + ".html")

Damien Naudet's avatar
Damien Naudet committed
700 701 702
        # do not include third_party/_local files
        self.filelist.exclude_pattern(pattern="*", prefix="xsocs/third_party/_local")

Damien Naudet's avatar
Damien Naudet committed
703 704 705 706 707 708 709 710
    def make_distribution(self):
        self.prune_file_list()
        sdist.make_distribution(self)
        dest = self.archive_files[0]
        dirname, basename = os.path.split(dest)
        base, ext = os.path.splitext(basename)
        while ext in [".zip", ".tar", ".bz2", ".gz", ".Z", ".lz", ".orig"]:
            base, ext = os.path.splitext(base)
711 712 713 714
        # if ext:
        #     dest = "".join((base, ext))
        # else:
        #     dest = base
Damien Naudet's avatar
Damien Naudet committed
715 716 717 718
        # sp = dest.split("-")
        # base = sp[:-1]
        # nr = sp[-1]
        debian_arch = os.path.join(dirname, self.get_debian_name() + ".orig.tar.gz")
Damien Naudet's avatar
Damien Naudet committed
719 720 721 722 723 724 725 726 727
        os.rename(self.archive_files[0], debian_arch)
        self.archive_files = [debian_arch]
        print("Building debian .orig.tar.gz in %s" % self.archive_files[0])


# ##### #
# setup #
# ##### #

Damien Naudet's avatar
Damien Naudet committed
728 729
def get_project_configuration(dry_run):
    """Returns project arguments for setup"""
730 731 732 733 734 735
    # Use installed numpy version as minimal required version
    # This is useful for wheels to advertise the numpy version they were built with
    if dry_run:
        numpy_requested_version = ""
    else:
        from numpy.version import version as numpy_version
736
        numpy_requested_version = ">=%s" % numpy_version
737 738
        logger.info("Install requires: numpy %s", numpy_requested_version)

Damien Naudet's avatar
Damien Naudet committed
739 740
    install_requires = [
        # for most of the computation
741
        "numpy%s" % numpy_requested_version,
Thomas Vincent's avatar
Thomas Vincent committed
742
        "h5py",
743
        "fabio",
744
        "silx>=0.9.0",
Thomas Vincent's avatar
Thomas Vincent committed
745 746
        "xrayutilities",
        "scipy",
Damien Naudet's avatar
Damien Naudet committed
747 748 749
        # for the script launcher
        "setuptools"]

750
    setup_requires = ["setuptools", "numpy", "Cython>=0.21.1"]
Damien Naudet's avatar
Damien Naudet committed
751

Thomas Vincent's avatar
Thomas Vincent committed
752
    extras_require = {
753
        "gui": ["PyOpenGL", "matplotlib", "PyQt5"]
Thomas Vincent's avatar
Thomas Vincent committed
754 755
    }

Damien Naudet's avatar
Damien Naudet committed
756 757 758 759 760 761 762 763 764 765
    package_data = {
        'xsocs.resources': [
            # Add here all resources files
            'gui/icons/*.png',
            'gui/icons/*.svg',
            'gui/icons/*.mng',
            'gui/icons/*.gif']
    }

    entry_points = {
766
        'console_scripts': ['xsocs = xsocs.__main__:main [gui]'],
Damien Naudet's avatar
Damien Naudet committed
767 768 769 770 771 772 773 774 775 776
    }

    cmdclass = dict(
        build=Build,
        build_py=build_py,
        test=PyTest,
        build_doc=BuildDocCommand,
        test_doc=TestDocCommand,
        build_ext=BuildExt,
        clean=CleanCommand,
777
        sdist=SourceDistWithCython,
Damien Naudet's avatar
Damien Naudet committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
        debian_src=sdist_debian)

    if dry_run:
        # DRY_RUN implies actions which do not require NumPy
        #
        # And they are required to succeed without Numpy for example when
        # pip is used to install xsocs when Numpy is not yet present in
        # the system.
        setup_kwargs = {}
    else:
        config = configuration()
        setup_kwargs = config.todict()

    setup_kwargs.update(name=PROJECT,
                        version=get_version(),
                        url="https://gitlab.esrf.fr/kmap/xsocs",
                        author="data analysis unit",
                        author_email="silx@esrf.fr",
                        classifiers=classifiers,
                        description="Xray Strain Orientation "
                                    "Calculation Software",
                        long_description=get_readme(),
                        install_requires=install_requires,
                        setup_requires=setup_requires,
Thomas Vincent's avatar
Thomas Vincent committed
802
                        extras_require=extras_require,
Damien Naudet's avatar
Damien Naudet committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
                        cmdclass=cmdclass,
                        package_data=package_data,
                        zip_safe=False,
                        entry_points=entry_points,
                        )
    return setup_kwargs


def setup_package():
    """Run setup(**kwargs)

    Depending on the command, it either runs the complete setup which depends on numpy,
    or a *dry run* setup with no dependency on numpy.
    """

    # Check if action requires build/install
    dry_run = len(sys.argv) == 1 or (len(sys.argv) >= 2 and (
        '--help' in sys.argv[1:] or
        sys.argv[1] in ('--help-commands', 'egg_info', '--version',
                        'clean', '--name')))

    if dry_run:
825
        # DRY_RUN implies actions which do not require dependencies, like NumPy
Damien Naudet's avatar
Damien Naudet committed
826 827 828 829 830 831 832 833 834 835 836
        try:
            from setuptools import setup
            logger.info("Use setuptools.setup")
        except ImportError:
            from distutils.core import setup
            logger.info("Use distutils.core.setup")
    else:
        try:
            from setuptools import setup
        except ImportError:
            from numpy.distutils.core import setup
837
            logger.info("Use numpy.distutils.setup")
Damien Naudet's avatar
Damien Naudet committed
838 839 840 841 842 843 844

    setup_kwargs = get_project_configuration(dry_run)
    setup(**setup_kwargs)


if __name__ == "__main__":
    setup_package()