如何在执行setup.py install时向build_ext传递--debug参数？

我来给你梳理几种可行的办法，完全适配你用的pybind cmake示例场景：

方法1：命令行直接链式传参（最简单省心） #

不用修改任何代码，直接在执行install或develop命令时，把build_ext --debug追加在后面就行：

python setup.py install build_ext --debug
# 换成develop命令也一样
python setup.py develop build_ext --debug

setuptools会按顺序执行命令，当install/develop触发build_ext步骤时，会自动带上你指定的--debug参数，效果和直接跑python setup.py build_ext --debug完全一致。

方法2：修改setup.py，强制默认开启debug模式 #

如果希望每次执行install/develop都自动用debug模式，不用每次手动加参数，可以自定义build_ext类，强制把debug属性设为1。结合你的cmake示例，修改后的代码大概是这样：

import sys
from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext

class CMakeBuild(build_ext):
    def initialize_options(self):
        # 先调用父类的初始化逻辑
        super().initialize_options()
        # 强制开启debug模式
        self.debug = 1

    def run(self):
        # 保留原有cmake构建逻辑，同时加上debug对应的cmake配置
        try:
            import cmake
        except ImportError:
            raise RuntimeError("CMake must be installed to build the following extensions: " +
                               ", ".join(e.name for e in self.extensions))

        # 原有配置...
        cmake_args = [
            f'-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={self.build_lib}',
            f'-DPYTHON_EXECUTABLE={sys.executable}',
        ]
        build_args = []

        # 因为self.debug已经设为1，这里会自动添加Debug构建配置
        if self.debug:
            cmake_args += ['-DCMAKE_BUILD_TYPE=Debug']
            build_args += ['--config', 'Debug']

        # 继续原有执行cmake和编译的代码...

setup(
    name='cmake_example',
    version='0.0.1',
    ext_modules=[Extension('cmake_example', ['src/main.cpp'])],
    cmdclass={'build_ext': CMakeBuild},
    zip_safe=False,
)

这样每次跑python setup.py install时，build_ext就会自动以debug模式编译，cmake也会生成Debug版本的构建文件。

方法3：添加自定义命令行参数，灵活控制debug模式 #

如果不想强制默认开启，而是希望用户可以自主选择是否用debug模式，可以自定义install命令类，添加一个--debug参数，根据参数切换build_ext的模式：

import sys
from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext
from setuptools.command.install import install

class CustomInstall(install):
    # 给install命令添加自定义的--debug参数
    user_options = install.user_options + [
        ('debug', None, 'Enable debug build for the C++ extension')
    ]

    def initialize_options(self):
        super().initialize_options()
        # 默认不开启debug
        self.debug = None

    def run(self):
        # 如果用户指定了--debug，就替换build_ext为debug版本的类
        if self.debug is not None:
            self.distribution.cmdclass['build_ext'] = DebugCMakeBuild
        super().run()

class DebugCMakeBuild(build_ext):
    def initialize_options(self):
        super().initialize_options()
        self.debug = 1

    def run(self):
        # 和方法2里的CMakeBuild逻辑一致，处理debug模式的cmake配置
        try:
            import cmake
        except ImportError:
            raise RuntimeError("CMake must be installed to build the following extensions: " +
                               ", ".join(e.name for e in self.extensions))

        cmake_args = [
            f'-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={self.build_lib}',
            f'-DPYTHON_EXECUTABLE={sys.executable}',
        ]
        build_args = []

        if self.debug:
            cmake_args += ['-DCMAKE_BUILD_TYPE=Debug']
            build_args += ['--config', 'Debug']

        # 继续原有执行cmake和编译的代码...

class ReleaseCMakeBuild(build_ext):
    def run(self):
        # 正常release模式的构建逻辑
        try:
            import cmake
        except ImportError:
            raise RuntimeError("CMake must be installed to build the following extensions: " +
                               ", ".join(e.name for e in self.extensions))

        cmake_args = [
            f'-DCMAKE_LIBRARY_OUTPUT_DIRECTORY={self.build_lib}',
            f'-DPYTHON_EXECUTABLE={sys.executable}',
            '-DCMAKE_BUILD_TYPE=Release'
        ]
        build_args = []

        # 继续原有执行cmake和编译的代码...

setup(
    name='cmake_example',
    version='0.0.1',
    ext_modules=[Extension('cmake_example', ['src/main.cpp'])],
    cmdclass={'install': CustomInstall, 'build_ext': ReleaseCMakeBuild},
    zip_safe=False,
)

现在用户可以灵活选择：

• 正常release版本安装：python setup.py install
• debug版本安装：python setup.py install --debug

内容的提问来源于stack exchange，提问作者Gill Bates