如何通过setup.cfg优化Python项目的打包元数据管理?

浅丽小哥_4958

浅丽小哥_4958

2026-06-11

1033人浏览

原创

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

如何通过setup.cfg优化python项目的打包元数据管理?

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]。

关键字段对照:

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
  • [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 就成了孤岛。强行塞进去,要么配置失效,要么触发解析异常,反而增加调试成本。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1791

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4704

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27857

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3347

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3367

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2603

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习