如何从我的 setup.py 中读取 pyproject.toml 中的项目依赖项，以避免在两个文件中重复信息？

Question

我们正在升级使用BeeWare 的公文包 0.3.1进行打包，它使用pyproject.toml而不是setup.py指定如何打包，包括要在包中包含哪些依赖项。

这是一个pyproject.tomlfor公文包的最小示例：

[tool.briefcase.app.exampleapp]
formal_name = "exampleapp"
description = "something"
requires = ['PyQt5', 'qtconsole']
sources = ['exampleapp']

我们想访问来自 的需求列表setup.py，因此我们不必在两个文件中复制它，并使它们保持同步。我们还没有准备好离开setuptools，这仅用于打包。替代方案当然是让setup.py自动生成pyproject.toml文件，但这似乎与PEP 518的意图有点背道而驰。

Answer 1

据我所知，公文包实际上并不兼容PEP 517（至少默认情况下不兼容）。它使用一个pyproject.toml文件，但不填充该[build-system]部分，因此应该可以在该文件中设置实际的PEP 517构建后端而不会引起冲突。

pyproject.toml

[build-system]
build-backend = 'setuptools.build_meta'
requires = [
    'setuptools',
    'toml',
]

[tool.briefcase.app.exampleapp]
formal_name = 'exampleapp'
description = 'something'
requires = ['PyQt5', 'qtconsole']
sources = ['exampleapp']

setup.py

#!/usr/bin/env python3

import pathlib

import pkg_resources
import setuptools
import toml

def _parse_briefcase_toml(pyproject_path, app_name):
    pyproject_text = pyproject_path.read_text()
    pyproject_data = toml.loads(pyproject_text)
    briefcase_data = pyproject_data['tool']['briefcase']
    app_data = briefcase_data['app'][app_name]
    setup_data = {
        'name': pkg_resources.safe_name(app_data['formal_name']),
        'version': briefcase_data['version'],
        'install_requires': app_data['requires'],
        # ...
    }
    return setup_data

def _setup():
    app_name = 'exampleapp'
    pyproject_path = pathlib.Path('pyproject.toml')
    setup_data = _parse_briefcase_toml(pyproject_path, app_name)
    setuptools.setup(**setup_data)

if __name__ == '__main__':
    _setup()

然后pip和其他PEP 517兼容的前端应该能够通过委托给setuptools来构建和安装项目，同时注意正确设置包含setuptools和toml的构建环境。

我想也可以让公文包处理pyproject.toml文件的解析（也许用briefcase.config.parse_config(...)），但它没有记录，所以我不知道这些 API 的稳定性如何。