讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

Laper
Laper

剧本策划到成片协作

updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

Python 配置即代码的实践思路

阿墨吖_7855

阿墨吖_7855

发布时间:2026-02-23 20:30:11

|

1019人浏览过

|

来源于php中文网

原创

pyproject.toml 不能仅写 [build-system],因为工具链需实际消费字段:pip install -e . 需 [project],poetry 忽略它,[build-system.requires] 必须匹配真实构建工具,动态 version 易被缓存坑,setup.py 虽弃用但 CI 可能仍依赖。

python 配置即代码的实践思路

为什么 pyproject.toml 不能只写 [build-system] 就完事

因为 Python 的“配置即代码”不是把配置文件写全就自动生效,而是依赖工具链对字段的实际消费。比如 setuptools 会读 [project],但 poetry 默认忽略它;pip install -e . 只认 [build-system] + [project],而 pipx 安装时还会检查 [project.scripts] 是否存在。

常见错误现象:pip install -e . 成功但 import mypkg 报 ModuleNotFoundError;或者 python -m build 失败,提示 Unknown distribution option: 'entry_points'。

  • 必须确保 [build-system.requires] 包含真正用于构建的工具,例如 ["setuptools>=61.0", "wheel"],而不是抄别人项目里的 ["poetry-core"] 却没装 poetry
  • [project] 下的 name 和 version 必须是字符串,不能是动态表达式(如 "0.1.0.dev"+open("VERSION").read()),否则 pip 解析失败
  • 如果用 src/ 目录结构,得加 [project.paths] 或在 [tool.setuptools] 里配 package-dir = {"" = "src"},否则打包时找不到模块

setup.py 已弃用,但删掉它可能让 CI 崩溃

PEP 621 明确推荐用 pyproject.toml 替代 setup.py,但很多 CI 流水线、Docker 构建脚本或内部工具仍硬编码调用 python setup.py sdist。直接删掉 setup.py 不是“干净”,而是制造隐性故障。

使用场景:你刚迁移到 pyproject.toml,本地 pip install -e . 没问题,但 Jenkins 上跑 python setup.py bdist_wheel 报错 No module named 'setuptools'。

立即学习“Python免费学习笔记(深入)”;

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
  • 最省事的做法是留一个极简 setup.py,只包含 from setuptools import setup; setup(),它会自动 fallback 到 pyproject.toml 中的 [project]
  • 不要在 setup.py 里写逻辑(比如读 VERSION 文件),否则和 pyproject.toml 的 version 不一致,导致安装后 importlib.metadata.version("mypkg") 返回错误值
  • CI 脚本中优先替换为 python -m build --wheel,它原生支持 PEP 621,且不依赖 setup.py

动态 version 怎么写才不会被缓存坑死

用 Git 描述符(如 v1.2.0-3-gabc123)生成版本号很常见,但 pip 在 editable 模式下会缓存 pyproject.toml 解析结果,导致改了 commit 后 importlib.metadata.version() 还返回旧值。

性能影响:每次 import 都执行 git describe 会拖慢启动;兼容性影响:某些环境(如 Alpine Linux)没装 git,pip install 直接失败。

  • 推荐用 setuptools_scm:在 [tool.setuptools_scm] 里配 version_scheme = "guess-next-dev",它只在构建时运行一次 git 命令,生成静态 version 写入 wheel 元数据
  • 避免在 [project.version] 直接写函数调用,比如 "{file:VERSION}" 或 "{attr: mypkg.__version__}",这些只在某些工具(如 hatch)里支持,pip 原生不认
  • 如果必须手动管理,把 version 放进 src/mypkg/_version.py,由构建工具写入,再在 pyproject.toml 里用 [project.dynamic.version] 声明,这样 pip 才能识别

tool.* 下的配置项到底谁在读

pyproject.toml 里 [tool.black]、[tool.ruff]、[tool.mypy] 这些段落,Python 解释器完全不看——它们只是各工具约定俗成的存放位置。真正决定行为的是你**实际执行的命令**和**对应工具是否安装**。

容易踩的坑:在 [tool.isort] 里写了 profile = "black",但没装 isort,结果 pre-commit 钩子静默跳过;或者 [tool.pytest.ini_options] 配了 addopts,但 pytest 版本太老不支持该字段,直接报错退出。

  • 每个 [tool.XXX] 段落只对 XXX 工具生效,pip、python、venv 全部无视,别指望它们影响 import 行为或虚拟环境创建
  • 不同工具对同一名字的字段语义可能冲突,比如 [tool.black.line-length] 是 int,但 [tool.ruff.line-length] 是 string,写错类型会导致工具启动失败
  • 想确认某段配置是否生效?直接运行对应命令加 --verbose,例如 black --verbose . 会打印它加载了哪些配置项

复杂点在于,同一个配置项在不同工具链里可能触发完全不同的行为路径——比如 [project.optional-dependencies] 在 pip install mypkg[dev] 和 poetry add --group dev pytest 中的解析逻辑就不是一回事,别假设“写了就能用”。

热门AI工具

更多
讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

3510

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

7963

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

9642

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

5067

2025.07.23

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

7319

2023.08.02

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1898

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

3104

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6344

2023.10.24

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

40

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn