0

0

Python 配置即代码的实践思路

舞夢輝影

舞夢輝影

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

|

999人浏览过

|

来源于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 mypkgModuleNotFoundError;或者 python -m build 失败,提示 Unknown distribution option: 'entry_points'

  • 必须确保 [build-system.requires] 包含真正用于构建的工具,例如 ["setuptools>=61.0", "wheel"],而不是抄别人项目里的 ["poetry-core"] 却没装 poetry
  • [project] 下的 nameversion 必须是字符串,不能是动态表达式(如 "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免费学习笔记(深入)”;

TURF(开源)权限管理系统
TURF(开源)权限管理系统

TURF(开源)权限定制管理系统(以下简称“TURF系统”),是蓝水工作室推出的一套基于软件边界设计理念研发的具有可定制性的权限管理系统。TURF系统充分考虑了易用性,将配置、设定等操作进行了图形化设计,完全在web界面实现,程序员只需在所要控制的程序中简单调用一个函数,即可实现严格的程序权限管控,管控力度除可达到文件级别外,还可达到代码级别,即可精确控制到

下载
  • 最省事的做法是留一个极简 setup.py,只包含 from setuptools import setup; setup(),它会自动 fallback 到 pyproject.toml 中的 [project]
  • 不要在 setup.py 里写逻辑(比如读 VERSION 文件),否则和 pyproject.tomlversion 不一致,导致安装后 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 工具生效,pippythonvenv 全部无视,别指望它们影响 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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

351

2023.10.09

更新pip版本
更新pip版本

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

426

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、保存并关闭文件即可。

789

2024.12.23

python升级pip
python升级pip

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

362

2025.07.23

string转int
string转int

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

830

2023.08.02

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

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

618

2023.08.03

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

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

217

2023.09.04

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

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

1558

2023.10.24

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1127

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.7万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号