setup.py

#!/usr/bin/env python
#  Copyright (C) 2015, 2018-2019, 2021 Rocky Bernstein <rocky@gnu.org>
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""
distutils setup (setup.py) for pycdio.

This gets a bit of package info from __pkginfo__.py file
"""

# Get the required package information
from __pkginfo__ import (
    modname,
    VERSION,
    license,
    short_desc,
    web,
    author,
    author_email,
    classifiers,
)

from setuptools import setup
from distutils.core import Extension
from distutils.command.build import build
from subprocess import *

import os
import shutil
import sys

OVER_PYTHON_25 = sys.version_info[0:1] >= (2, 5)

top_dir = os.path.dirname(os.path.abspath(__file__))
README = os.path.join(top_dir, "README.rst")
pkg_config = os.getenv("PKG_CONFIG") or "pkg-config"


def rm_file(*paths):
    global top_dir
    toast = os.path.join(top_dir, *paths)
    try:
        os.remove(toast)
    except:
        pass
    return


# Description in package will come from the README file.
long_description = open(README).read() + "\n\n"

# We store swig sources in ./swig, but we want the generated python
# module not to appear in that directory, but instead in the top-level
# directory where we have the other modules. I'd move *all* of the modules
# to their own directory if I knew how to do that in distutils.
swig_opts = ["-outdir", top_dir]


class custom_build(build):
    # Reorder build commands such that swig generated files are also copied.
    sub_commands = [
        ("build_ext", build.has_ext_modules),
        ("build_py", build.has_pure_modules),
        ("build_clib", build.has_c_libraries),
        ("build_scripts", build.has_scripts),
    ]

    def run(self):
        # Account for API change after 0.83
        ge_2 = call([pkg_config, "--atleast-version=2.0.0", "libcdio"])
        assert ge_2 == 0, "Need at least libcdio 2.0.0 to use this"
        print("libcdio version >= 2.0.0")
        build.run(self)


# Find runtime library directories for libcdio and libiso9660 using
# pkg-config. Then create the right Extension object lists which later
# get fed into setup()'s list of ext_modules.
modules = []
for lib_name in ("libcdio", "libiso9660"):
    short_libname = lib_name[3:]  # Strip off "lib" from name

    # FIXME: DRY this code.
    try:
        p = Popen([pkg_config, "--libs-only-L", lib_name], stdout=PIPE)
    except:
        print("** Error trying to run pkg-config. Is it installed?")
        print("** If not, see http://pkg-config.freedesktop.org")
        raise
        pass

    if p.returncode is None:
        # Strip off blanks and initial '-L'
        L_flag = "-L"
        if OVER_PYTHON_25: L_flag = bytes(L_flag, "utf-8")
        dirs = p.communicate()[0].split(L_flag)[1:]
        runtime_lib_dirs = [d.strip() for d in dirs]
    else:
        print(
            (
                "** Didn't the normal return code running pkg-config,"
                + "on %s. got:\n\t%s" % [lib_name, p.returncode]
            )
        )
        print("** Will try to add %s anyway." % short_libname)
        runtime_lib_dirs = None
    library_dirs = runtime_lib_dirs
    p = Popen([pkg_config, "--cflags-only-I", lib_name], stdout=PIPE)
    if p.returncode is None:
        # String starts '-I' so the first entry is ''; Discard that,
        # the others we want.
        I_flag = "-I"
        if OVER_PYTHON_25: I_flag = bytes(I_flag, "utf-8")
        dirs = p.communicate()[0].split(I_flag)[1:]
        include_dirs = [d.strip() for d in dirs]
    p = Popen([pkg_config, "--libs-only-l", lib_name], stdout=PIPE)
    if p.returncode is None:
        # String starts '-l' so the first entry is ''; Discard that,
        # the others we want.
        l_flag = "-l"
        if OVER_PYTHON_25: l_flag = bytes(l_flag, "utf-8")
        dirs = p.communicate()[0].split(l_flag)[1:]
        libraries = [d.strip().decode("utf-8") for d in dirs]
        pass
    py_shortname = "py" + short_libname
    modules.append(
        Extension(
            "_" + py_shortname,
            libraries=libraries,
            swig_opts=swig_opts,
            include_dirs=[dir.decode("utf-8") for dir in include_dirs],
            library_dirs=[d.decode("utf-8") for d in library_dirs],
            runtime_library_dirs=[d.decode("utf-8") for d in runtime_lib_dirs],
            sources=["swig/%s.i" % py_shortname],
        )
    )

setup(
    author=author,
    author_email=author_email,
    classifiers=classifiers,
    cmdclass={"build": custom_build},
    description=short_desc,
    ext_modules=modules,
    license=license,
    long_description=long_description,
    name=modname,
    py_modules=["cdio", "iso9660", "pycdio", "pyiso9660"],
    test_suite="nose.collector",
    url=web,
    version=VERSION,
)