setup.py

# -*- coding: utf-8 -*-

# This file was adapted from the "official" pybind11 example at
# https://github.com/pybind/cmake_example

# See also https://www.benjack.io/2018/02/02/python-cpp-revisited.html

import os
import sys
import subprocess
from shutil import copyfile, copymode # for doctest unitTests
from setuptools import setup, find_packages, Extension
from setuptools.command.build_ext import build_ext

# Convert distutils Windows platform specifiers to CMake -A arguments
PLAT_TO_CMAKE = {
    "win32": "Win32",
    "win-amd64": "x64",
    "win-arm32": "ARM",
    "win-arm64": "ARM64",
}


# A CMakeExtension needs a sourcedir instead of a file list.
# The name must be the _single_ output extension from the CMake build.
# If you need multiple extensions, see scikit-build.
class CMakeExtension(Extension):
    def __init__(self, name, sourcedir=""):
        Extension.__init__(self, name, sources=[])
        self.sourcedir = os.path.abspath(sourcedir)


class CMakeBuild(build_ext):
    def build_extension(self, ext):
        extdir = os.path.abspath(os.path.dirname(self.get_ext_fullpath(ext.name)))

        # required for auto-detection of auxiliary "native" libs
        if not extdir.endswith(os.path.sep):
            extdir += os.path.sep

        cfg = "Debug" if self.debug else "Release"

        # CMake lets you override the generator - we need to check this.
        # Can be set with Conda-Build, for example.
        cmake_generator = os.environ.get("CMAKE_GENERATOR", "")

        # Set Python_EXECUTABLE instead if you use PYBIND11_FINDPYTHON.
        # Note the version number is passed to C++ here using -DBOOZ_XFORM_VERSION.
        cmake_args = [
            "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={}".format(extdir),
            "-DPYTHON_EXECUTABLE={}".format(sys.executable),
            "-DBOOZ_XFORM_VERSION={}".format(self.distribution.get_version()),
            "-DCMAKE_BUILD_TYPE={}".format(cfg),  # not used on MSVC, but no harm
        ]
        build_args = []

        if self.compiler.compiler_type != "msvc":
            # Using Ninja-build since it a) is available as a wheel and b)
            # multithreads automatically. MSVC would require all variables be
            # exported for Ninja to pick it up, which is a little tricky to do.
            # Users can override the generator with CMAKE_GENERATOR in CMake
            # 3.15+.
            if not cmake_generator:
                cmake_args += ["-GNinja"]

        else:

            # Single config generators are handled "normally"
            single_config = any(x in cmake_generator for x in {"NMake", "Ninja"})

            # CMake allows an arch-in-generator style for backward compatibility
            contains_arch = any(x in cmake_generator for x in {"ARM", "Win64"})

            # Specify the arch if using MSVC generator, but only if it doesn't
            # contain a backward-compatibility arch spec already in the
            # generator name.
            if not single_config and not contains_arch:
                cmake_args += ["-A", PLAT_TO_CMAKE[self.plat_name]]

            # Multi-config generators have a different way to specify configs
            if not single_config:
                cmake_args += [
                    "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY_{}={}".format(cfg.upper(), extdir)
                ]
                build_args += ["--config", cfg]

        # Set CMAKE_BUILD_PARALLEL_LEVEL to control the parallel build level
        # across all generators.
        if "CMAKE_BUILD_PARALLEL_LEVEL" not in os.environ:
            # self.parallel is a Python 3 only way to set parallel jobs by hand
            # using -j in the build_ext call, not supported by pip or PyPA-build.
            if hasattr(self, "parallel") and self.parallel:
                # CMake 3.12+ only.
                build_args += ["-j{}".format(self.parallel)]

        if not os.path.exists(self.build_temp):
            os.makedirs(self.build_temp)

        subprocess.check_call(
            ["cmake", ext.sourcedir] + cmake_args, cwd=self.build_temp
        )
        subprocess.check_call(
            ["cmake", "--build", "."] + build_args, cwd=self.build_temp
        )

        # Copy unit tests to the repository
        #src_file = os.path.join(self.build_temp, 'unitTests')
        #dest_dir = os.path.join(os.path.dirname(
        #    os.path.abspath(__file__)), 'tests')

        # Copy standalone executable so it can be installed:
        src_file = os.path.join(self.build_temp, 'xbooz_xform')
        dest_dir = os.path.join(os.path.dirname(
            os.path.abspath(__file__)))
        dest_file = os.path.join(dest_dir, os.path.basename(src_file))
        print("copying {} -> {}".format(src_file, dest_file))
        copyfile(src_file, dest_file)
        copymode(src_file, dest_file)

with open("README.md", "r") as fh:
    long_description = fh.read()

# The information here can also be placed in setup.cfg - better separation of
# logic and declaration, and simpler if you include description/version in a file.
setup(
    name="booz_xform",
    version="0.0.8",
    author="Matt Landreman",
    author_email="matt.landreman@gmail.com",
    description="Transformation to Boozer coordinates",
    long_description=long_description,
    packages=['booz_xform'],
    # tell setuptools to look for any packages under 'src'
    #packages=find_packages('src'),
    # Tell setuptools that all packages will be under the 'src' directory
    # and nowhere else
    package_dir={'':'src'},
    ext_modules=[CMakeExtension("booz_xform._booz_xform")],
    cmdclass={"build_ext": CMakeBuild},
    install_requires=['numpy'],
    # The next line makes the executable available:
    data_files = [('bin', ['xbooz_xform'])],
    test_suite='tests',
    zip_safe=False,
)

# For guidance about packages involving both pure python and a pybind11 extension, see
# https://stackoverflow.com/questions/47599162/pybind11-how-to-package-c-and-python-code-into-a-single-package