如何在 pyproject.toml 中通过环境变量动态控制可选依赖项

聖光之護

聖光之護

2026-08-01

898人浏览

原创

如何在 pyproject.toml 中通过环境变量动态控制可选依赖项

pyproject.toml 本身不支持运行时环境变量插值,但可通过标准可选依赖机制 + 安装时显式声明(如 pip install mypkg[with-cdeps])实现等效逻辑,兼顾可重现性与构建灵活性。

pyproject.toml 本身不支持运行时环境变量插值,但可通过标准可选依赖机制 + 安装时显式声明(如 pip install mypkg[with-cdeps])实现等效逻辑,兼顾可重现性与构建灵活性。

在现代 Python 包管理中,pyproject.toml 是声明式配置文件,其内容在构建和分发阶段被静态解析,不支持执行 Python 代码或读取环境变量(如 os.environ)。因此,无法像旧式 setup.py 那样直接嵌入条件逻辑(例如 if os.environ.get("DO_NOT_INSTALL_THIS_PACKAGE"))。但这并不意味着丧失灵活性——正确做法是遵循 PEP 621PyPA 最佳实践,将条件依赖建模为语义清晰的可选依赖组(optional dependencies)

✅ 推荐方案:使用 project.optional-dependencies

在 pyproject.toml 中定义一个明确用途的可选依赖组(例如 cdeps),将 this_package 归入其中:

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "mypkg"
version = "0.1.0"
dependencies = [
  "requests>=2.28",
  "numpy>=1.23",
]

[project.optional-dependencies]
cdeps = ["this_package>=1.0.0"]

? 注意:cdeps 是自定义名称,可按需改为 with-clibs、native-build 等更具描述性的标识。

PHP基础-环境变量函数等
PHP基础-环境变量函数等

PHP基础-环境变量函数等 vip-kj-zhu/php-kj/4-jQuery-最流行的JS函数库.zip

下载

安装时,根据本地环境状态选择是否启用该依赖:

  • 若系统已预装 C 库(且 this_package 的 wheel 不可用或无需编译),则仅安装基础包:
    pip install mypkg
  • 若需由 this_package 提供 C 库支持(例如在 CI 或无系统库的环境中),则显式启用可选依赖:
    pip install mypkg[cdeps]

该方式完全兼容 pip、uv、poetry(需额外配置)及所有 PEP 517 构建后端,且生成的 .dist-info 元数据清晰可审计。

⚠️ 重要注意事项

  • 不可在 pyproject.toml 中写 dependencies = [...] if os.getenv(...) else [...] —— 这会导致解析失败或未定义行为。
  • 避免“反向命名陷阱”:不要命名为 no-cdeps;应正向命名(如 cdeps),默认不启用,符合用户直觉和工具链预期。
  • 若需更细粒度控制(如跳过某依赖的编译步骤),可在 setup.cfg 或 pyproject.toml 的 [build-system] 下配合构建后端(如 setuptools 的 config_settings)实现,但属于进阶场景,通常不必要。
  • 对于开发流程,可结合 pip install -e ".[cdeps]" 实现可复现的 editable 安装。

总之,用可选依赖替代运行时环境变量判断,不是妥协,而是拥抱标准化、可验证、跨工具链一致的现代打包范式。

相关文章

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

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

下载

相关标签:

环境变量

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

相关专题

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

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

2023.07.20

1104

4

python能做什么
python能做什么

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

2023.07.25

2049

7

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

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

2023.07.31

1185

3

python教程
python教程

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

2023.08.03

8709

23

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

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

2023.08.04

1477

5

python eval
python eval

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

2023.08.04

1529

5

scratch和python区别
scratch和python区别

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

2023.08.11

880

5

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

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

2023.08.10

530

4

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

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

2023.08.11

1109

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP基础-环境/变量/函数等
PHP基础-环境/变量/函数等

共57课时 | 17.5万人学习