如何根据PEP 517（即pyproject）构建C扩展。toml而不是setup.py？

Question

我想为CPython构建一个C扩展。我传统上可以使用＜code＞设置来完成。py文件。然而，出于PEP517中提到的原因，我更喜欢使用＜code＞pyproject.toml＜/code＞的声明性方法。我知道setuptools是唯一可以在所有相关平台上构建C扩展的构建后端。事实上，除了过时的distutils之外，我还不知道有任何后端能够构建C扩展。

在此背景下，常见的＜code＞设置。py将如下所示：

from setuptools import setup, Extension
kwargs = dict(
    name='mypackage',
    # more metadata
    ext_modules=[
        Extension('mypackage.mymodule', ['lib/mymodule.c',
                                         'lib/mypackage.c',
                                         'lib/myalloc.c'],
                  include_dirs=['lib'],
                  py_limited_api=True)])

setup(**kwargs)

现在的挑战是将上述内容放入< code>pyproject.toml和< code>setup.cfg中。

setup工具文档建议pyproject.toml如下所示：

[build-system]
requires = [
    "setuptools >=52.0",
        'wheel >= 0.36']
build-backend = "setuptools.build_meta"

看见

• https://setuptools.readthedocs.io/en/latest/build_meta.html和
• https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#declarative-配置

此外，实际的元数据应该放入< code>setup.cfg中。但是，我还没有找到任何关于如何将< code>ext_modules kwarg，尤其是< code>Extension()调用，翻译成< code>setup.cfg语法的解释。

Answer 1

下面是一个黑客，可用于使用 pyproject.toml 构建 ext，而无需依赖 setup.py

pyproject.toml

[tool.setuptools]
py-modules = ["_custom_build"]

[tool.setuptools.cmdclass]
build_py = "_custom_build.build_py"

_custom_build.py

from setuptools import Extension
from setuptools.command.build_py import build_py as _build_py

class build_py(_build_py):
    def run(self):
        self.run_command("build_ext")
        return super().run()

    def initialize_options(self):
        super().initialize_options()
        if self.distribution.ext_modules == None:
            self.distribution.ext_modules = []

        self.distribution.ext_modules.append(
            Extension(
                "termial_random.random",
                sources=["termial_random/random.c"],
                extra_compile_args=["-std=c17", "-lm"],
            )
        )

Answer 2

严格来说，< code>pyproject.toml并不是要取代< code>setup.py，而是要确保在仍然需要的情况下正确执行它(参见PEP

如果存在构建后端密钥，则优先，并且源代码树遵循指定后端的格式和约定（因此，除非后端需要，否则不需要 setup.py）。项目可能仍希望包含与不使用此规范的工具兼容的 setup.py。

虽然setuptools计划将所有内容从脚本移动到配置文件中，但这并不总是可能的：

有两种类型的元数据：静态和动态。

• 静态元数据（setup.cfg）：保证每次都是一样的，这样更简单，更容易阅读，并且避免了许多常见的错误，比如编码错误。
• 动态元数据（setup.py）：可能是非确定性的。任何动态的或在安装时确定的项目，以及扩展模块或setuptools的扩展，都需要进入setup.py。

静态元数据应该是首选，而动态元数据应该仅在绝对必要时作为一个出口使用。

事实上，＜code＞setuptools＜/code＞仍将使用虚构的＜code＞设置。py（如果不存在）。

注意：自版本

话虽如此，如果你想尽可能多地坚持静态方式，你可以将所有内容移动到pyproject.toml文件中，其余的暂时保留在 setup.py：

[build-system]
requires = ["setuptools>=61"]
build-backend = "setuptools.build_meta"

[project]
name = "mypackage"
# more metadata

from setuptools import setup, Extension

setup_args = dict(
    ext_modules = [
        Extension(
            'mypackage.mymodule',
            ['lib/mymodule.c', 'lib/mypackage.c', 'lib/myalloc.c'],
            include_dirs = ['lib'],
            py_limited_api = True
        )
    ]
)
setup(**setup_args)