setup.py 32.8 KB
Newer Older
1
#!/usr/bin/env python3
Damien Naudet's avatar
Damien Naudet committed
2 3 4
# coding: utf8
# /*##########################################################################
#
5
# Copyright (c) 2015-2020 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__ = "11/06/2020"
Damien Naudet's avatar
Damien Naudet committed
29 30 31 32 33
__license__ = "MIT"

import sys
import os
import platform
Damien Naudet's avatar
Damien Naudet committed
34 35 36
import shutil
import logging
import glob
37 38 39 40
# 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
41 42 43 44

logging.basicConfig(level=logging.INFO)

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

Damien Naudet's avatar
Damien Naudet committed
46 47
from distutils.command.clean import clean as Clean
from distutils.command.build import build as _build
Damien Naudet's avatar
Damien Naudet committed
48
try:
Damien Naudet's avatar
Damien Naudet committed
49
    from setuptools import Command
Damien Naudet's avatar
Damien Naudet committed
50 51
    from setuptools.command.build_py import build_py as _build_py
    from setuptools.command.sdist import sdist
52 53 54 55 56 57
    try:
        from Cython.Build import build_ext
        logger.info("Use setuptools with cython")
    except ImportError:
        from setuptools.command.build_ext import build_ext
        logger.info("Use setuptools, cython is missing")
Damien Naudet's avatar
Damien Naudet committed
58
except ImportError:
Damien Naudet's avatar
Damien Naudet committed
59 60 61 62
    try:
        from numpy.distutils.core import Command
    except ImportError:
        from distutils.core import Command
Damien Naudet's avatar
Damien Naudet committed
63 64
    from distutils.command.build_py import build_py as _build_py
    from distutils.command.sdist import sdist
65 66 67 68 69 70
    try:
        from Cython.Build import build_ext
        logger.info("Use distutils with cython")
    except ImportError:
        from distutils.command.build_ext import build_ext
        logger.info("Use distutils, cython is missing")
Damien Naudet's avatar
Damien Naudet committed
71 72 73 74 75 76 77
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
78

Damien Naudet's avatar
Damien Naudet committed
79
PROJECT = "xsocs"
80 81
if sys.version_info.major < 3:
    logger.error(PROJECT + " no longer supports Python2")
Damien Naudet's avatar
Damien Naudet committed
82 83 84 85 86 87 88

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
89

90

Damien Naudet's avatar
Damien Naudet committed
91
def get_version():
Damien Naudet's avatar
Damien Naudet committed
92
    """Returns current version number from version.py file"""
93 94
    dirname = os.path.dirname(os.path.abspath(__file__))
    sys.path.insert(0, dirname)
Damien Naudet's avatar
Damien Naudet committed
95
    import version
96
    sys.path = sys.path[1:]
Damien Naudet's avatar
Damien Naudet committed
97 98 99 100
    return version.strictversion


def get_readme():
Damien Naudet's avatar
Damien Naudet committed
101
    """Returns content of README.rst file"""
Damien Naudet's avatar
Damien Naudet committed
102
    dirname = os.path.dirname(os.path.abspath(__file__))
Damien Naudet's avatar
Damien Naudet committed
103 104
    filename = os.path.join(dirname, "README.rst")
    with io.open(filename, "r", encoding="utf-8") as fp:
Damien Naudet's avatar
Damien Naudet committed
105 106 107 108
        long_description = fp.read()
    return long_description


Damien Naudet's avatar
Damien Naudet committed
109
classifiers = ["Development Status :: 4 - Beta",
Damien Naudet's avatar
Damien Naudet committed
110 111 112 113 114 115 116 117
               "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",
118
               "Operating System :: MacOS",
119
               "Operating System :: Microsoft :: Windows",
Damien Naudet's avatar
Damien Naudet committed
120 121 122
               "Operating System :: POSIX",
               "Programming Language :: Cython",
               "Programming Language :: Python :: 2.7",
123
               "Programming Language :: Python :: 3",
Damien Naudet's avatar
Damien Naudet committed
124 125 126 127 128 129 130 131 132
               "Programming Language :: Python :: Implementation :: CPython",
               "Topic :: Scientific/Engineering :: Physics",
               "Topic :: Software Development :: Libraries :: Python Modules",
               ]

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

133

Damien Naudet's avatar
Damien Naudet committed
134 135 136 137
class build_py(_build_py):
    """
    Enhanced build_py which copies version.py to <PROJECT>._version.py
    """
138

Damien Naudet's avatar
Damien Naudet committed
139 140 141 142 143 144
    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

145 146 147 148
########
# Test #
########

149

150
class PyTest(Command):
151
    """Command to start tests running the script: run_tests.py"""
152 153
    user_options = []

154 155
    description = "Execute the unittests"

156 157 158 159 160 161 162 163
    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        import subprocess
164
        errno = subprocess.call([sys.executable, 'run_tests.py'])
165 166
        if errno != 0:
            raise SystemExit(errno)
Damien Naudet's avatar
Damien Naudet committed
167

Damien Naudet's avatar
Damien Naudet committed
168
# ################### #
Damien Naudet's avatar
Damien Naudet committed
169
# build_doc command   #
Damien Naudet's avatar
Damien Naudet committed
170 171
# ################### #

172

Damien Naudet's avatar
Damien Naudet committed
173
if sphinx is None:
174

Damien Naudet's avatar
Damien Naudet committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    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).')


191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 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
class BuildMan(Command):
    """Command to build man pages"""

    description = "Build man pages of the provided entry points"

    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def entry_points_iterator(self):
        """Iterate other entry points available on the project."""
        entry_points = self.distribution.entry_points
        console_scripts = entry_points.get('console_scripts', [])
        gui_scripts = entry_points.get('gui_scripts', [])
        scripts = []
        scripts.extend(console_scripts)
        scripts.extend(gui_scripts)
        for script in scripts:
            # Remove ending extra dependencies
            script = script.split("[")[0]
            elements = script.split("=")
            target_name = elements[0].strip()
            elements = elements[1].split(":")
            module_name = elements[0].strip()
            function_name = elements[1].strip()
            yield target_name, module_name, function_name

    def run_targeted_script(self, target_name, script_name, env, log_output=False):
        """Execute targeted script using --help and --version to help checking
        errors. help2man is not very helpful to do it for us.

        :return: True is both return code are equal to 0
        :rtype: bool
        """
        import subprocess

        if log_output:
            extra_args = {}
        else:
            try:
                # Python 3
                from subprocess import DEVNULL
            except ImportError:
                # Python 2
                import os
                DEVNULL = open(os.devnull, 'wb')
            extra_args = {'stdout': DEVNULL, 'stderr': DEVNULL}

        succeeded = True
        command_line = [sys.executable, script_name, "--help"]
        if log_output:
            logger.info("See the following execution of: %s", " ".join(command_line))
        p = subprocess.Popen(command_line, env=env, **extra_args)
        status = p.wait()
        if log_output:
            logger.info("Return code: %s", status)
        succeeded = succeeded and status == 0
        command_line = [sys.executable, script_name, "--version"]
        if log_output:
            logger.info("See the following execution of: %s", " ".join(command_line))
        p = subprocess.Popen(command_line, env=env, **extra_args)
        status = p.wait()
        if log_output:
            logger.info("Return code: %s", status)
        succeeded = succeeded and status == 0
        return succeeded

    @staticmethod
    def _write_script(target_name, lst_lines=None):
        """Write a script to a temporary file and return its name
        :paran target_name: base of the script name
        :param lst_lines: list of lines to be written in the script
        :return: the actual filename of the script (for execution or removal)
        """
        import tempfile
        import stat
        script_fid, script_name = tempfile.mkstemp(prefix="%s_" % target_name, text=True)
        with os.fdopen(script_fid, 'wt') as script:
            for line in lst_lines:
                if not line.endswith("\n"):
                    line += "\n"
                script.write(line)
        # make it executable
        mode = os.stat(script_name).st_mode
        os.chmod(script_name, mode + stat.S_IEXEC)
        return script_name

    def get_synopsis(self, module_name, env, log_output=False):
        """Execute a script to retrieve the synopsis for help2man
        :return: synopsis
        :rtype: single line string
        """
        import subprocess
        script_name = None
        synopsis = None
        script = ["#!%s\n" % sys.executable,
                  "import logging",
                  "logging.basicConfig(level=logging.ERROR)",
                  "import %s as app" % module_name,
                  "print(app.__doc__)"]
        try:
            script_name = self._write_script(module_name, script)
            command_line = [sys.executable, script_name]
            p = subprocess.Popen(command_line, env=env, stdout=subprocess.PIPE)
            status = p.wait()
            if status != 0:
                logger.warning("Error while getting synopsis for module '%s'.", module_name)
            synopsis = p.stdout.read().decode("utf-8").strip()
            if synopsis == 'None':
                synopsis = None
        finally:
            # clean up the script
            if script_name is not None:
                os.remove(script_name)
        return synopsis

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

        env = dict((str(k), str(v)) for k, v in os.environ.items())
        env["PYTHONPATH"] = os.pathsep.join(path)
        if not os.path.isdir("build/man"):
            os.makedirs("build/man")
        import subprocess
        import tempfile
        import stat
        script_name = None
        workdir = tempfile.mkdtemp()

        entry_points = self.entry_points_iterator()
        for target_name, module_name, function_name in entry_points:
            logger.info("Build man for entry-point target '%s'" % target_name)
            # help2man expect a single executable file to extract the help
            # we create it, execute it, and delete it at the end

            py3 = sys.version_info >= (3, 0)
            try:
                # create a launcher using the right python interpreter
                script_name = os.path.join(workdir, target_name)
                with open(script_name, "wt") as script:
                    script.write("#!%s\n" % sys.executable)
                    script.write("import %s as app\n" % module_name)
                    script.write("app.%s()\n" % function_name)
                # make it executable
                mode = os.stat(script_name).st_mode
                os.chmod(script_name, mode + stat.S_IEXEC)

                # execute help2man
                man_file = "build/man/%s.1" % target_name
                command_line = ["help2man", "-N", script_name, "-o", man_file]

                synopsis = self.get_synopsis(module_name, env)
                if synopsis:
                    command_line += ["-n", synopsis]
                if not py3:
                    # Before Python 3.4, ArgParser --version was using
                    # stderr to print the version
                    command_line.append("--no-discard-stderr")
                    # Then we dont know if the documentation will contains
                    # durtty things
                    succeeded = self.run_targeted_script(target_name, script_name, env, False)
                    if not succeeded:
                        logger.info("Error while generating man file for target '%s'.", target_name)
                        self.run_targeted_script(target_name, script_name, env, True)
                        raise RuntimeError("Fail to generate '%s' man documentation" % target_name)

                p = subprocess.Popen(command_line, env=env)
                status = p.wait()
                if status != 0:
                    logger.info("Error while generating man file for target '%s'.", target_name)
                    self.run_targeted_script(target_name, script_name, env, True)
                    raise RuntimeError("Fail to generate '%s' man documentation" % target_name)
            finally:
                # clean up the script
                if script_name is not None:
                    os.remove(script_name)
        os.rmdir(workdir)


Damien Naudet's avatar
Damien Naudet committed
376
if sphinx is not None:
377

Damien Naudet's avatar
Damien Naudet committed
378 379 380 381 382
    class BuildDocCommand(BuildDoc):
        """Command to build documentation using sphinx.

        Project should have already be built.
        """
Damien Naudet's avatar
Damien Naudet committed
383 384 385 386 387 388 389 390

        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))
391

Damien Naudet's avatar
Damien Naudet committed
392 393 394 395 396 397 398 399 400 401 402
            # # 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)
403

Damien Naudet's avatar
Damien Naudet committed
404
            # Build the Users Guide in HTML and TeX format
Damien Naudet's avatar
Damien Naudet committed
405
            for builder in ['html', 'latex']:
Damien Naudet's avatar
Damien Naudet committed
406 407 408 409 410
                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
411 412
else:
    BuildDocCommand = SphinxExpectedCommand
Damien Naudet's avatar
Damien Naudet committed
413 414


Damien Naudet's avatar
Damien Naudet committed
415 416 417
# ################### #
# test_doc command    #
# ################### #
Damien Naudet's avatar
Damien Naudet committed
418

Damien Naudet's avatar
Damien Naudet committed
419
if sphinx is not None:
420

Damien Naudet's avatar
Damien Naudet committed
421 422
    class TestDocCommand(BuildDoc):
        """Command to test the documentation using sphynx doctest.
Damien Naudet's avatar
Damien Naudet committed
423

Damien Naudet's avatar
Damien Naudet committed
424 425
        http://www.sphinx-doc.org/en/1.4.8/ext/doctest.html
        """
426

Damien Naudet's avatar
Damien Naudet committed
427 428 429 430
        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
431

Damien Naudet's avatar
Damien Naudet committed
432 433
            build = self.get_finalized_command('build')
            sys.path.insert(0, os.path.abspath(build.build_lib))
Damien Naudet's avatar
Damien Naudet committed
434

Damien Naudet's avatar
Damien Naudet committed
435 436 437 438 439 440 441
            # 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
442

Damien Naudet's avatar
Damien Naudet committed
443 444
else:
    TestDocCommand = SphinxExpectedCommand
Damien Naudet's avatar
Damien Naudet committed
445

446 447 448 449
# ############################# #
# numpy.distutils Configuration #
# ############################# #

450

451 452 453 454
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
455 456 457 458 459 460 461
    """
    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)")
462 463 464 465 466 467 468 469 470 471 472 473 474 475
    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
476 477 478 479 480 481 482 483 484 485 486 487 488
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"),
        ('force-cython', None,
         "recompile all Cython extension modules"),
    ]
    user_options.extend(_build.user_options)

489
    boolean_options = ['no-openmp', 'openmp', 'force-cython']
Damien Naudet's avatar
Damien Naudet committed
490 491 492 493 494 495 496 497 498 499
    boolean_options.extend(_build.boolean_options)

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

    def finalize_options(self):
        _build.finalize_options(self)
500 501
        if not self.force_cython:
            self.force_cython = self._parse_env_as_bool("FORCE_CYTHON") is True
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
        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:
528 529 530
            env_with_openmp = self._parse_env_as_bool("WITH_OPENMP")
            if env_with_openmp is not None:
                use_openmp = env_with_openmp
Damien Naudet's avatar
Damien Naudet committed
531 532 533 534 535 536 537 538 539
            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):
540
                    logger.warning("OpenMP support ignored. Your platform does not support it.")
Damien Naudet's avatar
Damien Naudet committed
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
                    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


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.
558 559 560 561
    """

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

562
    LINK_ARGS_CONVERTER = {'-fopenmp': ''}
563

564
    description = 'Build extensions'
Damien Naudet's avatar
Damien Naudet committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578

    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.force_cython = build_obj.force_cython

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

        :param Extension ext: An extension
        """
        # Cytonize
579 580 581 582 583 584 585 586
        from Cython.Build import cythonize
        patched_exts = cythonize(
                                 [ext],
                                 compiler_directives={'embedsignature': True,
                                 'language_level': 3},
                                 force=self.force_cython
        )
        ext.sources = patched_exts[0].sources
Damien Naudet's avatar
Damien Naudet committed
587

588
        # Remove OpenMP flags if OpenMP is disabled
Damien Naudet's avatar
Damien Naudet committed
589 590 591 592 593
        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']
594 595 596

        # Convert flags from gcc to MSVC if required
        if self.compiler.compiler_type == 'msvc':
597 598 599 600 601 602 603 604 605
            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
606

607 608 609 610 611 612
        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*'

613 614 615 616
            ext.extra_compile_args.append('-fvisibility=hidden')

            import numpy
            numpy_version = [int(i) for i in numpy.version.short_version.split(".", 2)[:2]]
617
            if numpy_version < [1, 16]:
618 619 620 621 622 623
                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)))
624

Damien Naudet's avatar
Damien Naudet committed
625 626 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 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    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)
679

Damien Naudet's avatar
Damien Naudet committed
680 681 682 683
    def build_extensions(self):
        self.patch_compiler()
        for ext in self.extensions:
            self.patch_extension(ext)
684 685
        build_ext.build_extensions(self)

Damien Naudet's avatar
Damien Naudet committed
686 687 688
################################################################################
# Clean command
################################################################################
689 690


Damien Naudet's avatar
Damien Naudet committed
691 692
class CleanCommand(Clean):
    description = "Remove build artifacts from the source tree"
Damien Naudet's avatar
Damien Naudet committed
693

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

Damien Naudet's avatar
Damien Naudet committed
697 698 699 700 701 702 703 704 705 706 707 708
        :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
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
    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
727 728
    def run(self):
        Clean.run(self)
729 730 731 732 733

        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
734 735 736 737
        # really remove the directories
        # and not only if they are empty
        to_remove = [self.build_base]
        to_remove = self.expand(to_remove)
738
        to_remove += cythonized_files
Damien Naudet's avatar
Damien Naudet committed
739 740 741 742 743 744 745 746 747 748 749

        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
750 751 752 753 754 755 756 757 758 759 760

################################################################################
# Debian source tree
################################################################################


class sdist_debian(sdist):
    """
    Tailor made sdist for debian
    * remove auto-generated doc
    * remove cython generated .c files
761
    * remove cython generated .cpp files
Damien Naudet's avatar
Damien Naudet committed
762 763
    * remove .bat files
    * include .l man files
Damien Naudet's avatar
Damien Naudet committed
764
    """
765 766 767

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

Damien Naudet's avatar
Damien Naudet committed
768 769 770 771 772 773
    @staticmethod
    def get_debian_name():
        import version
        name = "%s_%s" % (PROJECT, version.debianversion)
        return name

Damien Naudet's avatar
Damien Naudet committed
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
    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
791 792 793
        # do not include third_party/_local files
        self.filelist.exclude_pattern(pattern="*", prefix="xsocs/third_party/_local")

Damien Naudet's avatar
Damien Naudet committed
794 795 796 797 798 799 800 801
    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)
802 803 804 805
        # if ext:
        #     dest = "".join((base, ext))
        # else:
        #     dest = base
Damien Naudet's avatar
Damien Naudet committed
806 807 808 809
        # 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
810 811 812 813 814 815 816 817
        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 #
# ##### #

818

Damien Naudet's avatar
Damien Naudet committed
819 820
def get_project_configuration(dry_run):
    """Returns project arguments for setup"""
821 822 823 824 825 826
    # 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
827
        numpy_requested_version = ">=%s" % numpy_version
828 829
        logger.info("Install requires: numpy %s", numpy_requested_version)

Damien Naudet's avatar
Damien Naudet committed
830 831
    install_requires = [
        # for most of the computation
832
        "numpy%s" % numpy_requested_version,
Thomas Vincent's avatar
Thomas Vincent committed
833
        "h5py",
Thomas Vincent's avatar
Thomas Vincent committed
834
        "fabio",
835
        "silx>=0.9.0",
Thomas Vincent's avatar
Thomas Vincent committed
836 837
        "xrayutilities",
        "scipy",
Damien Naudet's avatar
Damien Naudet committed
838 839 840
        # for the script launcher
        "setuptools"]

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

Thomas Vincent's avatar
Thomas Vincent committed
843
    extras_require = {
Thomas Vincent's avatar
Thomas Vincent committed
844
        "gui": ["PyOpenGL", "matplotlib", "PyQt5"]
Thomas Vincent's avatar
Thomas Vincent committed
845 846
    }

Damien Naudet's avatar
Damien Naudet committed
847 848 849 850 851 852 853 854 855 856
    package_data = {
        'xsocs.resources': [
            # Add here all resources files
            'gui/icons/*.png',
            'gui/icons/*.svg',
            'gui/icons/*.mng',
            'gui/icons/*.gif']
    }

    entry_points = {
Thomas Vincent's avatar
Thomas Vincent committed
857
        'console_scripts': ['xsocs = xsocs.__main__:main [gui]'],
Damien Naudet's avatar
Damien Naudet committed
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
    }

    cmdclass = dict(
        build=Build,
        build_py=build_py,
        test=PyTest,
        build_doc=BuildDocCommand,
        test_doc=TestDocCommand,
        build_ext=BuildExt,
        clean=CleanCommand,
        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
892
                        extras_require=extras_require,
Damien Naudet's avatar
Damien Naudet committed
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
                        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:
915
        # DRY_RUN implies actions which do not require dependencies, like NumPy
Damien Naudet's avatar
Damien Naudet committed
916 917 918 919 920 921 922 923 924 925 926
        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
927
            logger.info("Use numpy.distutils.setup")
Damien Naudet's avatar
Damien Naudet committed
928 929 930 931 932 933 934

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


if __name__ == "__main__":
    setup_package()