setup.py

"""
python-seabreeze
================

python module for OceanOptics spectrometers

Author: Andreas Poehlmann
Email: andreas@poehlmann.io

"""

import logging
import os
import platform
import sys

from setuptools import Extension
from setuptools import find_packages
from setuptools import setup
from setuptools.command.build_ext import build_ext

try:
    import Cython
except ImportError:
    WARN_NO_CYTHON = True
else:
    WARN_NO_CYTHON = False


def strtobool(val: str) -> int:
    """distutils.util.strtobool(val)
    Convert a string representation of truth to true (1) or false (0).

    True values are y, yes, t, true, on and 1;
    false values are n, no, f, false, off and 0.
    Raises ValueError if val is anything else.
    """
    val = val.lower()
    if val in ("y", "yes", "t", "true", "on", "1"):
        return 1
    elif val in ("n", "no", "f", "false", "off", "0"):
        return 0
    else:
        raise ValueError(f"invalid truth value {val!r}")


if "--without-cseabreeze" in sys.argv:
    # user requests to not install cython wrapper
    sys.argv.remove("--without-cseabreeze")  # this is a hack...
    # The correct way to do this, would be to:
    # - make cseabreeze it's own python module and make python-seabreeze depend on
    #   it as an extra dependency
    # - by default ship pyseabreeze but keep pyseabreeze as an extra so that installing
    #   pyusb is optional
    # - require users to decide which backend they want to install...
    extensions = []

else:
    compile_opts: dict

    # Platform specific libraries and source files
    if platform.system() == "Windows":
        ignore_subdirs = {"linux", "osx", "posix"}
        compile_opts = dict(
            define_macros=[("_WINDOWS", None)],
            include_dirs=[],
            libraries=["winusb", "ws2_32", "setupapi"],
            library_dirs=[],
        )

    elif platform.system() == "Darwin":
        ignore_subdirs = {"linux", "winusb", "windows"}
        compile_opts = dict(
            define_macros=[], include_dirs=[], libraries=[], library_dirs=[]
        )
        compile_opts["extra_link_args"] = [
            "-framework",
            "Carbon",
            "-framework",
            "CoreFoundation",
            "-framework",
            "IOKit",
        ]

    else:
        ignore_subdirs = {"osx", "winusb", "windows"}
        try:
            import pkgconfig
        except ImportError:
            compile_opts = dict(
                define_macros=[], include_dirs=[], libraries=["usb"], library_dirs=[]
            )
        else:
            compile_opts = pkgconfig.parse("libusb")

        if not strtobool(os.getenv("CSEABREEZE_DEBUG_INFO", "0")):
            # strip debug symbols
            compile_opts["extra_compile_args"] = ["-g0"]

    # Collect all source files for cseabreeze backend
    sources = ["src/seabreeze/cseabreeze/c_seabreeze_wrapper.pyx"]
    for root, subdirs, fns in os.walk("src/libseabreeze/src"):
        subdirs[:] = (d for d in subdirs if d not in ignore_subdirs)
        sources.extend(os.path.join(root, fn) for fn in fns)
    # Add seabreeze include dirs
    compile_opts["include_dirs"].append(os.path.relpath("src/libseabreeze/include"))

    if strtobool(os.getenv("CSEABREEZE_ABI3", "false")):
        # this will only work once more numpy support lands in the limited api
        compile_opts["py_limited_api"] = True
        compile_opts["define_macros"].extend(
            [("CYTHON_LIMITED_API", "1"), ("Py_LIMITED_API", 0x03070000)]
        )

    # define extension
    libseabreeze = Extension(
        "seabreeze.cseabreeze._wrapper",
        language="c++",
        sources=[os.path.relpath(s) for s in sources],
        **compile_opts,
    )

    building_sphinx_documentation = bool(
        strtobool(os.environ.get("READTHEDOCS", "false"))
    )
    libseabreeze.cython_directives = {
        "binding": building_sphinx_documentation,  # fix class method parameters for sphinx
        "embedsignature": not building_sphinx_documentation,  # add function signature to docstring for ipython
        "language_level": "3str",
    }
    extensions = [libseabreeze]


# noinspection PyPep8Naming
class sb_build_ext(build_ext):
    def build_extensions(self):
        # Deal with windows command line limit
        if os.name == "nt":
            org_spawn = self.compiler.spawn

            def win_spawn(_, cmd, *args, **kwargs):
                # the windows shell can't handle all the object files provided to link.exe
                from subprocess import list2cmdline

                if cmd[0].endswith("link.exe"):
                    with open("ihatewindowssomuch.rsp", "w") as f:
                        f.write(list2cmdline(cmd[1:]) + "\n\r")
                    new_cmd = cmd[:1] + [f"@{os.path.abspath(f.name)}"]
                    return org_spawn(new_cmd, *args, **kwargs)
                else:
                    return org_spawn(cmd, *args, **kwargs)

            # noinspection PyArgumentList
            self.compiler.spawn = win_spawn.__get__(self.compiler)

        # prevent cpp compiler warning
        # - see: https://stackoverflow.com/a/36293331
        # - see: https://github.com/python/cpython/pull/7476/files
        try:
            self.compiler.compiler_so.remove("-Wstrict-prototypes")
        except (AttributeError, ValueError):
            pass

        # see: https://github.com/matplotlib/matplotlib/pull/18322
        if self.compiler.compiler_type == "msvc" and strtobool(
            os.environ.get("SEABREEZE_DISABLE_FH4", "0")
        ):
            # Disable FH4 Exception Handling implementation so that we don't
            # require VCRUNTIME140_1.dll. For more details, see:
            # https://devblogs.microsoft.com/cppblog/making-cpp-exception-handling-smaller-x64/
            # https://github.com/joerick/cibuildwheel/issues/423#issuecomment-677763904
            for ext in self.extensions:
                ext.extra_compile_args.append("/d2FH4-")

        return super().build_extensions()


if WARN_NO_CYTHON and extensions:
    logging.basicConfig(stream=sys.stderr, level=logging.INFO)
    log = logging.getLogger("setup")
    log.info(
        "if error `unknown file type '.pyx'` occurs try `pip install cython` and rerun"
    )

setup(
    name="seabreeze",
    author="Andreas Poehlmann",
    author_email="andreas@poehlmann.io",
    url="https://github.com/ap--/python-seabreeze",
    license="MIT",
    use_scm_version={
        "write_to": "src/seabreeze/_version.py",
        "write_to_template": '__version__ = "{version}"',
        "tag_regex": r"^(?P<pkg>python-seabreeze-)?(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$",
        "version_scheme": "post-release",
    },
    setup_requires=[
        "setuptools>=64",
        "setuptools_scm>=8",
        "cython>=3",
        "wheel>=0.38",
        "pkgconfig",
    ],
    install_requires=[
        "numpy>=1.21",
    ],
    extras_require={
        "cseabreeze": [],
        "pyseabreeze": ["pyusb >=1.0"],
        "docs": [
            "sphinx",
            "sphinx-rtd-theme",
        ],
        "tests": [
            "pytest; python_version<='3.9'",
            "pytest>=6.2.4; python_version>'3.9'",
        ],
    },
    python_requires=">=3.9",
    cmdclass={"build_ext": sb_build_ext},
    ext_modules=extensions,
    packages=find_packages(where="src"),
    package_data={"seabreeze": ["py.typed"]},
    package_dir={"": "src"},
    entry_points={"console_scripts": ["seabreeze_os_setup=seabreeze.os_setup:main"]},
    description=(
        "Python interface module for Ocean Optics spectrometers. "
        "This software is not associated with Ocean Optics. "
        "Use it at your own risk."
    ),
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    classifiers=[
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.9",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: 3.13",
    ],
)