如何在 setup.py 中使用 CMake 简化 Python 扩展构建？

使用 CMake 子类化构建扩展

简介：

使用 C 代码扩展 Python 需要在编译和链接步骤之间进行仔细编排。为了简化此过程，CMake 提供了一种便捷的方法来配置和构建此类扩展。然而，将 CMake 与 setup.py 集成给开发人员带来了挑战。本文旨在通过深入研究扩展 setuptools 以在 setup.py 构建中无缝使用 CMake 来解决这些挑战。

集成的需求：

传统上，Python 扩展是在运行 setup.py 之前编译和链接，创建一个繁琐的两步过程。通过利用 CMake，开发人员可以获得对复杂构建序列的细粒度控制。此外，CMake 的 Python 扩展支持允许直接从 setup.py 轻松编译，无需中间步骤。

自定义构建扩展：

将 CMake 集成到 setup 中.py，需要自定义扩展类。此子类 CMakeExtension 会覆盖默认构建行为以调用 CMake 命令。

示例集成：

考虑一个包含 C 扩展 (foo) 的简单项目结构和一个 Python 模块 (spam.eggs)。 CMakeLists.txt 和 setup.py 文件在构建过程中起着至关重要的作用：

# CMakeLists.txt
project(spam)
set(src "spam")
set(foo_src "spam/foo.c")
add_library(foo SHARED ${foo_src})

# setup.py
from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext_orig

class CMakeExtension(Extension):
    def __init__(self, name):
        super().__init__(name, sources=[])

class build_ext(build_ext_orig):
    def run(self):
        for ext in self.extensions:
            self.build_cmake(ext)
        super().run()

CMakeExtension 类将自身注册为仅在构建过程中调用 CMake 的特殊扩展，而自定义的 build_ext 会覆盖调用 CMake 的默认行为。

测试构建：

构建项目涉及运行 setup.py sdist bdist_wheel。可以使用 pip show 安装和测试生成的 Wheel 发行版，以验证 Python 扩展库 (libfoo.dylib) 是否存在。调用 spam.eggs 中的包装函数可确认扩展按预期工作。

结论：

在 setup.py 中使用 CMake 扩展 setuptools 提供了一种简化的构建方法依赖 CMake 进行复杂构建序列的 Python 扩展。它使开发人员能够无缝集成这两个工具，减少手动步骤并增强开发工作流程。

以上是如何在 setup.py 中使用 CMake 简化 Python 扩展构建？的详细内容。更多信息请关注PHP中文网其他相关文章！