如何在Python构建流程中自动剔除测试代码与敏感配置文件

小瑶大大_7202

小瑶大大_7202

2026-11-05

632人浏览

原创

最简方案是在pyproject.toml中配置[tool.setuptools.packages.find] exclude = ["tests", "tests."],确保tests目录不被构建进wheel或sdist。

如何在python构建流程中自动剔除测试代码与敏感配置文件

构建时跳过 tests/ 目录的最简方案

PyPI 上传或 pip install . 构建时,默认会把整个源码树打包进去,tests/ 目录若没显式排除,就会进 wheel 或 sdist。这不是“是否运行测试”的问题,而是“是否打包”的问题。

最稳妥的做法是在 setup.py 或 pyproject.toml 中声明排除规则,而非依赖 .gitignore 或临时脚本。

  • 用 setup.py:在 setup() 调用中加 packages=find_packages(exclude=["tests*", "tests.*"])
  • 用 pyproject.toml(推荐):在 [tool.setuptools.packages.find] 下写 exclude = ["tests*", "tests.*"]
  • ⚠️ 注意:find_packages() 不处理非 Python 文件(如 tests/data/example.json),这类需额外用 MANIFEST.in

MANIFEST.in 怎么精准剔除敏感配置文件

MANIFEST.in 控制的是 sdist(源码包)里包含哪些非 Python 文件,它对 wheel 无效——wheel 只打包 packages 和 data_files 显式声明的内容。所以如果你的 config/ 下有 prod.env、secrets.yaml 这类文件,又没被 packages 包含,它们本不该进包;但万一被 recursive-include config *.yaml 这类宽泛规则捕获,就危险了。

  • 绝对不要写 recursive-include * *.env —— 它会把 tests/fixtures/.env 也拖进去
  • 应写成 prune config/secrets.* 或 prune **/secrets.*,用 prune 显式剔除
  • 验证是否生效:运行 python setup.py sdist --dry-run,看输出列表里有没有敏感文件名

CI 构建前用脚本做二次校验

人工维护 MANIFEST.in 和 setup.py 容易漏,尤其当团队多人提交、目录结构变动频繁时。可以在 CI 的构建步骤前加一道检查:

Python Hardener
Python Hardener

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

下载
  • 用 find . -name "*.env" -o -name "secrets.*" -o -name "config.*" | grep -v "^\./venv\|^\./.git" 扫描工作区
  • 再用 tar -tzf dist/*.tar.gz | grep -E '\.(env|yaml|yml|json)$' | grep -v 'test' 检查已生成的 sdist
  • 如果命中敏感文件名,立即 exit 1 中断发布流程
  • 这个检查必须放在 python -m build 之后、twine upload 之前

为什么不能靠 __pycache__ 或 .pyc 过滤来防泄漏

有人误以为删掉 __pycache__ 就安全了,其实完全无关。Python 编译缓存不包含源码逻辑,更不会把 os.environ["DB_PASSWORD"] 这种值编译进去。真正风险来自三类文件:硬编码密钥的 .py、未 exclude 的 config/、以及被 MANIFEST.in 错误 include 的 .env。

最隐蔽的坑是:某些模板引擎(如 Jinja2)会把 config/ 当作静态资源自动收集;某些打包工具(如 poetry build)默认忽略 MANIFEST.in,只认 include 配置——这时候得去查 poetry.toml 里的 [[tool.poetry.include]] 是否漏写了排除项。

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

相关文章

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

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

下载

相关标签:

python 配置文件

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

相关专题

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

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

2023.07.20

1871

4

python能做什么
python能做什么

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

2023.07.25

5084

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30677

23

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

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

2023.08.04

3647

5

python eval
python eval

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

2023.08.04

3647

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2843

5

热门下载

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

精品课程

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