不能完全替代,但可以大幅简化setup.py;setup.cfg是纯配置文件,必须配合仅含setup()调用的setup.py使用,否则pip install .会报错。

setup.cfg 能不能替代 setup.py?
不能完全替代,但可以大幅简化它。setup.cfg 本身是纯数据配置文件,不执行逻辑;而 setup.py 是 Python 脚本,必须存在(哪怕只有一行),用来调用 setuptools.setup()。如果你删掉 setup.py,运行 pip install . 或 python -m build 会直接报错:ModuleNotFoundError: No module named 'setuptools' 或更隐蔽的 error: no setup.py or pyproject.toml found。
真正可行的做法是把 setup.py 瘦身成“空壳”:
- 确保编码为 UTF-8,尤其含中文时,否则读取
setup.cfg中的description可能乱码 - 内容只需三行:
from setuptools import setup、if __name__ == "__main__":、setup() - 任何动态逻辑(如从 Git 获取版本号、环境变量判断依赖)仍得留在
setup.py里——setup.cfg不支持表达式或函数调用
metadata 和 options 区块怎么填才不踩坑?
[metadata] 块管项目身份,[options] 块管安装行为,二者字段不能混用。常见错误是把 python_requires 写进 [metadata],结果被忽略——它属于 [options]。
关键字段对照:
立即学习“Python免费学习笔记(深入)”;
-
[metadata]:必填name、version;推荐填author、author_email、description、long_description = file: README.md(注意路径是相对于setup.cfg的) -
[options]:必填packages = find:(启用自动发现)或显式写packages = mypackage, mypackage.utils;install_requires每行一个依赖,支持版本约束如requests>=2.25.0;python_requires = >=3.8在这里 - 别漏掉
[options.packages.find]子区块:加where = src表示源码在src/目录下,否则find:默认只扫项目根目录
能不能用 setup.cfg 统一管 pytest/flake8 这些工具?
能,但有边界。setup.cfg 支持通过 [tool:xxx] 形式内聚第三方工具配置,比如 [tool:pytest]、[flake8],前提是这些工具明确声明支持 INI 格式且读取 setup.cfg(pytest ≥ 6.0、flake8 ≥ 3.7 都支持)。
实际限制很实在:
-
[tool:pytest]下的testpaths = tests有效,但addopts = --strict-markers如果含空格或特殊字符,INI 解析容易出错,建议改用pyproject.toml -
[flake8]可以写max-line-length = 120,但无法定义多行 ignore 规则(INI 不支持续行),复杂规则还是得单独放.flake8 - 不是所有工具都认这个约定:black、isort 默认只读自己的配置文件,不会主动查
setup.cfg
为什么现在更推荐 pyproject.toml 而不是 setup.cfg?
因为 setup.cfg 的 INI 格式本质是妥协产物——它解决的是“把 setup.py 里的硬编码参数抽出来”,但没解决“多工具配置分散”和“语法表达力弱”的根本问题。PEP 518 明确将 pyproject.toml 定为构建系统唯一入口,setup.cfg 已被 setuptools 标记为 legacy(尽管仍支持)。
最现实的卡点在于:当你需要同时配 setuptools、pytest、mypy、black,且其中某些工具(如 mypy)只认 TOML 或自家格式时,setup.cfg 就成了孤岛。强行塞进去,要么配置失效,要么触发解析异常,反而增加调试成本。


















