在Python项目中,setup.py和setup.cfg有什么不同
问题描述
需要知道setup.py和setup.cfg之间的区别。两者在OpenStack项目中都得到了突出的使用
解决方案
传统上使用setup.py
来构建一个Python包,即
python setup.py build
与任何旧的Python文件一样,setup.py
可以包含大量代码。然而,在大多数情况下,它纯粹是声明性的,只是列出了包属性,例如
from setuptools import setup
setup(
name="foobar",
version="0.1.0",
author="John Doe",
# ...
)
事实上,有些人认为在setup.py
中加入太多逻辑是不好的风格。为了反映这一点,setup.cfg
(按设计是声明性的)在包装中变得更受欢迎:
[metadata]
name = foobar
version = 0.1.0
author = John Doe
# ...
这样做的好处是,打包软件(例如setupTools)不需要评估Python文件来获取元数据,而只需分析配置文件。
您可以向其添加虚拟setup.py
from setuptools import setup
if __name__ == "__main__":
setup()
或填满PEP 517/518,改为添加pyproject.toml
。
[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"
然后可以使用pypa-build(pip install build
)
python3 -m build --sdist --wheel .
这就是说,目前(2019/20/21),Python打包软件的前景非常活跃,目前还不清楚哪种方法将是未来定义Python包的首选方法。例如,有PEP 621建议将包元数据放入pyproject.toml
。
相关文章