如何在Python中编写setup.cfg进行声明式包配置

酷雪大大_6730

酷雪大大_6730

2026-09-23

570人浏览

原创

setup.cfg已被pyproject.toml取代,因其不支持动态逻辑、环境标记和现代构建后端声明,且python 3.13移除distutils后其底层支撑消失,仅作为静态兼容层存在。

如何在python中编写setup.cfg进行声明式包配置

setup.cfg 已被官方弃用,Python 3.12+ 中 setuptools 默认不再读取它;现在应优先用 pyproject.toml,但若维护旧项目或需兼容特定工具链,仍可能遇到它——关键不是“怎么写”,而是“写什么、不写什么、为什么容易失效”。

setup.cfg 的生效前提:必须搭配 setup.py 或 setuptools 40.8.0+

仅放一个 setup.cfg 文件不会自动构建包。常见错误是删掉 setup.py 后发现 pip install . 报错 ModuleNotFoundError: No module named 'setuptools' 或静默忽略配置。

  • 必须保留最小化 setup.py:仅含 from setuptools import setup; setup()
  • setuptools 版本低于 40.8.0 时,setup.cfg 中的某些字段(如 [options.packages.find])会被忽略
  • 若项目根目录存在 pyproject.toml,即使内容为空,setup.cfg 也会被完全跳过

核心 section 和易错字段:[metadata] 与 [options] 的边界

[metadata] 只管包元信息(名称、版本、作者等),而实际行为控制(包发现、依赖、入口点)全在 [options] 及其子 section。混淆这两者会导致配置不生效。

A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.
A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.

调用 Cutout.Pro 视觉处理 API 进行背景移除、人像抠图和照片增强,支持文件上传与图片 URL 输入。

下载
  • version 必须写死或用 attr: 引用模块属性(如 version = attr: mypkg.__version__),不能写 version = 0.1.0.dev0+git 这类动态字符串
  • packages 若设为 find:,必须同时声明 [options.packages.find],且 where 路径需相对于 setup.cfg 所在目录(默认是 .
  • install_requires 中的版本约束写法要严格:用 >=3.8,别用 >= 3.8(空格会解析失败)
  • entry_points 必须缩进对齐,且键名只能是标准组名(如 console_scripts),拼错如 consoe_scripts 将静默失效

替代 setup.cfg 的现代写法:pyproject.toml 中对应字段映射

很多团队误以为 “迁移到 pyproject.toml 就是把 setup.cfg 按行翻译过去”,结果因格式差异导致构建失败。关键区别在于 TOML 是分层结构,而 cfg 是扁平 key-value。

  • [metadata][project](注意:classifiers 变成 classifiers = ["Programming Language :: Python :: 3"]
  • [options][project.optional-dependencies][project.urls],而非全塞进 [project]
  • [options.packages.find][tool.setuptools.packages.find](注意命名空间前缀 tool.setuptools
  • python_requires[options] 里是顶层字段,在 [project] 里是 requires-python = ">=3.8"

真正麻烦的不是语法转换,而是 setup.cfg 隐式依赖 setuptools 的默认行为(比如自动包含 tests/ 目录),而 pyproject.toml 要求显式声明所有行为——这点在 CI 环境中特别容易暴露。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3684

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

21117

23

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

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

2023.08.04

2607

5

python eval
python eval

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

2023.08.04

2667

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2063

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程