PBR

custom build of extension module

Bug #1737664 reported by Philip Miller
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Confirmed
Wishlist
Unassigned

Bug Description

I am trying to use pbr for a python package that has an extension module that use pybind11 and its cmake-based build. The example repo setup.py, https://github.com/pybind/cmake_example/blob/master/setup.py, shows how to do this. How can I incorporate this custom extension module build into a pbr-based setup.py setup.cfg? In particular, how do I use the custom extension classes, CMakeBuild and CMakeExtension, from setup.cfg? See complete example setup.py below.
Thanks!

For completeleness, the contents of setup.py from the link above is here:

import os
import re
import sys
import platform
import subprocess

from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext
from distutils.version import LooseVersion

class CMakeExtension(Extension):
    def __init__(self, name, sourcedir=''):
        Extension.__init__(self, name, sources=[])
        self.sourcedir = os.path.abspath(sourcedir)

class CMakeBuild(build_ext):
    def run(self):
        try:
            out = subprocess.check_output(['cmake', '--version'])
        except OSError:
            raise RuntimeError("CMake must be installed to build the following extensions: " +
                               ", ".join(e.name for e in self.extensions))

        if platform.system() == "Windows":
            cmake_version = LooseVersion(re.search(r'version\s*([\d.]+)', out.decode()).group(1))
            if cmake_version < '3.1.0':
                raise RuntimeError("CMake >= 3.1.0 is required on Windows")

        for ext in self.extensions:
            self.build_extension(ext)

    def build_extension(self, ext):
        extdir = os.path.abspath(os.path.dirname(self.get_ext_fullpath(ext.name)))
        cmake_args = ['-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=' + extdir,
                      '-DPYTHON_EXECUTABLE=' + sys.executable]

        cfg = 'Debug' if self.debug else 'Release'
        build_args = ['--config', cfg]

        if platform.system() == "Windows":
            cmake_args += ['-DCMAKE_LIBRARY_OUTPUT_DIRECTORY_{}={}'.format(cfg.upper(), extdir)]
            if sys.maxsize > 2**32:
                cmake_args += ['-A', 'x64']
            build_args += ['--', '/m']
        else:
            cmake_args += ['-DCMAKE_BUILD_TYPE=' + cfg]
            build_args += ['--', '-j2']

        env = os.environ.copy()
        env['CXXFLAGS'] = '{} -DVERSION_INFO=\\"{}\\"'.format(env.get('CXXFLAGS', ''),
                                                              self.distribution.get_version())
        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, env=env)
        subprocess.check_call(['cmake', '--build', '.'] + build_args, cwd=self.build_temp)

setup(
    name='cmake_example',
    version='0.0.1',
    author='Dean Moldovan',
    <email address hidden>',
    description='A test project using pybind11 and CMake',
    long_description='',
    ext_modules=[CMakeExtension('cmake_example')],
    cmdclass=dict(build_ext=CMakeBuild),
    zip_safe=False,
)

Revision history for this message
Ben Nemec (bnemec) wrote :

A few thoughts on this:

pbr supports all of the parameters except ext_modules: https://github.com/openstack-dev/pbr/blob/master/pbr/util.py#L96

However, even if that were implemented I'm not sure the CMake classes could live in setup.py. setup() in pbr would be called from a different module that wouldn't have local access to those classes. I'm not sure if there's a way to reference custom classes from pbr. I would think there's some way to do it, but it would require some experimentation.

Changed in pbr:
status: New → Confirmed
importance: Undecided → Wishlist
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.