讲师中心 微信公众号
AI工具推荐 视频效率加速

如何防止 Python 包构建时将测试函数打包进发布版本

千静同学_8061

千静同学_8061

发布时间:2026-10-22 17:47:04

|

305人浏览过

|

来源于php中文网

原创

如何防止 Python 包构建时将测试函数打包进发布版本

在 Python 包开发中,将单元测试与源码共置(如 Rust 的 #[cfg(test)] 风格)可提升可维护性,但需确保测试函数不被意外导出或安装到最终包中;本文介绍一种稳定、符合 Python 惯例的解决方案。

在 python 包开发中,将单元测试与源码共置(如 rust 的 `#[cfg(test)]` 风格)可提升可维护性,但需确保测试函数不被意外导出或安装到最终包中;本文介绍一种稳定、符合 python 惯例的解决方案。

Python 默认会将模块中所有顶层可调用对象(包括 test_* 函数)作为公共接口的一部分导入和分发,这与 Rust 中 #[cfg(test)] 的编译期条件排除机制有本质区别。直接使用 if "pytest" in sys.modules 等运行时检测方式虽可行,但存在环境判断脆弱、IDE 误提示、类型检查干扰等问题,不推荐用于生产级项目。

✅ 推荐方案:伪私有测试类 + pytest 自定义发现规则

核心思路是利用 Python 的命名约定(单下划线前缀 _ 或双下划线 __)暗示私有性,并结合 pytest 的配置能力,仅让测试发现器识别特定结构,同时阻止测试函数被直接导入:

# add.py
def add(a, b):
    """Return the sum of a and b."""
    return a + b


class __Test:
    """Private test container — not intended for import or runtime use."""

    def test_add(self):
        assert add(1, 2) == 3

    def test_add_negative(self):
        assert add(-1, 1) == 0

接着,在项目根目录创建 pytest.ini(或 pyproject.toml 中的 [tool.pytest.ini_options]),显式声明测试类匹配模式:

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载

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

# pytest.ini
[pytest]
python_classes = __Test

✅ 效果说明:

  • uv build 或 pip install . 构建/安装后,__Test 类仍存在于模块中(符合 Python 运行时语义),但其方法 无法通过 from foo.add import test_add 导入(因方法嵌套在类内,非模块级符号);
  • uv run pytest 或 pytest 能正常发现并执行 __Test.test_add(得益于 python_classes 配置);
  • IDE 和类型检查器(如 mypy、pyright)默认忽略双下划线前缀类的自动补全,降低误用概率;
  • 符合 PEP 8 关于 __name 命名表示“强私有”的约定,语义清晰、无副作用。

⚠️ 注意事项:

  • 不要将 __Test 类命名为 _Test(单下划线),因为 pytest 默认 python_classes = Test*,可能意外匹配其他测试类;
  • 若使用 pyproject.toml 管理 pytest 配置,请写为:
    [tool.pytest.ini_options]
    python_classes = ["__Test"]
  • 此方案不依赖运行时条件判断,避免了 sys.modules 检查的可靠性问题(例如某些测试 runner 可能未注入 "pytest" 模块名);
  • 如需彻底排除测试代码(如发布精简版包),可配合 MANIFEST.in 排除含 test_ 的函数定义(不推荐),或采用源码预处理工具(复杂度高)——而本方案在简洁性、兼容性与工程实践间取得了最佳平衡。

总结:通过 __Test 类封装 + pytest.ini 显式配置,你既能享受测试紧贴实现的开发体验,又能保证发布的包干净、专业、零污染。

热门AI工具

更多
DeepSeek

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

豆包大模型

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

WorkBuddy

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

蛙蛙写作

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

超级简历WonderCV

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

相关专题

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

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

1771

2023.07.20

python能做什么
python能做什么

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

4644

2023.07.25

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

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

1749

2023.07.31

python教程
python教程

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

27537

2023.08.03

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

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

3327

2023.08.04

python eval
python eval

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

3327

2023.08.04

scratch和python区别
scratch和python区别

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

1203

2023.08.11

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

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

596

2023.08.10

剧云故事大纲与分场规划教程
剧云故事大纲与分场规划教程

本专题讲解剧云梗概与多级大纲功能,覆盖全局、分集、分场结构生成,以及主线冲突、剧情节点和场次顺序调整。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

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