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

如何单元测试包含无限循环的异步函数(Pytest + asyncio)

阿瑶君_5841

阿瑶君_5841

发布时间:2026-07-01 09:20:41

|

308人浏览过

|

来源于php中文网

原创

如何单元测试包含无限循环的异步函数(Pytest + asyncio)

本文介绍在 Pytest 中安全、可控地测试含 while True 或隐式无限循环的异步函数(如 receive_data 和 analyse_data)的实用策略,核心是通过 mock 控制终止条件与队列行为,并验证协程间数据流与副作用。

本文介绍在 pytest 中安全、可控地测试含 `while true` 或隐式无限循环的异步函数(如 `receive_data` 和 `analyse_data`)的实用策略,核心是通过 mock 控制终止条件与队列行为,并验证协程间数据流与副作用。

在异步单元测试中,直接运行含“无限循环”的协程(如 while True: 或依赖外部永不停止的生成器)会导致测试挂起、超时甚至阻塞整个测试套件。但正如示例代码所示,receive_data 和 analyse_data 实际上并非真正“无限”——它们的退出由可干预的同步逻辑控制:

  • receive_data 依赖 sync_receive_data_packets() 的迭代结束;
  • analyse_data 依赖 termination_signal_received() 的返回值。

因此,可测试性的关键不在于“绕过异步”,而在于精准 mock 这些同步锚点,并辅以受控的 asyncio.Queue 行为。

✅ 推荐测试策略(三步法)

  1. Mock 终止条件与数据源
    使用 @patch 替换 sync_receive_data_packets 为有限生成器,termination_signal_received 为可控布尔函数:
from unittest.mock import patch
import pytest
import asyncio

@pytest.mark.asyncio
async def test_receive_data_populates_queue():
    queue = asyncio.Queue(maxsize=100)
    test_packets = [b"pkt1", b"pkt2", b"pkt3"]

    # Mock generator to yield finite items
    def mock_sync_generator():
        yield from test_packets

    with patch("your_module.sync_receive_data_packets", mock_sync_generator):
        await receive_data(queue)

    # Verify all packets were enqueued
    assert queue.qsize() == len(test_packets)
    for expected in test_packets:
        assert await queue.get() == expected
        queue.task_done()
  1. Mock 分析逻辑并验证调用链
    对 analyse_data,需 mock termination_signal_received 提前退出,并验证 sync_data_analysis 是否被正确调用:
@pytest.mark.asyncio
async def test_analyse_data_processes_queue_items():
    queue = asyncio.Queue()
    test_packets = [b"pkt_a", b"pkt_b"]

    # Pre-fill queue
    for pkt in test_packets:
        await queue.put(pkt)

    # Mock termination to exit after 2 iterations
    termination_calls = 0
    def mock_termination():
        nonlocal termination_calls
        termination_calls += 1
        return termination_calls > len(test_packets)  # Exit after processing all

    with patch("your_module.termination_signal_received", mock_termination), \
         patch("your_module.sync_data_analysis") as mock_analysis:

        await analyse_data(queue)

        # Verify analysis called exactly once per packet
        assert mock_analysis.call_count == len(test_packets)
        mock_analysis.assert_has_calls([call(pkt) for pkt in test_packets])
  1. 集成测试双协程协作(可选进阶)
    若需验证 receive_data 与 analyse_data 在同一事件循环中的协同行为,可使用 asyncio.create_task + asyncio.wait_for 设定超时保护:
@pytest.mark.asyncio
async def test_end_to_end_pipeline():
    queue = asyncio.Queue(maxsize=5)
    received = []

    # Mock data source & analysis
    def mock_source():
        yield b"data_1"
        yield b"data_2"
        yield StopIteration  # or let generator end naturally

    def mock_analysis(pkt):
        received.append(pkt)

    with patch("your_module.sync_receive_data_packets", mock_source), \
         patch("your_module.sync_data_analysis", mock_analysis), \
         patch("your_module.termination_signal_received", lambda: len(received) >= 2):

        # Launch both tasks concurrently
        task1 = asyncio.create_task(receive_data(queue))
        task2 = asyncio.create_task(analyse_data(queue))

        # Wait max 2s — prevents hang if logic misbehaves
        await asyncio.wait_for(asyncio.gather(task1, task2), timeout=2.0)

    assert received == [b"data_1", b"data_2"]

⚠️ 注意事项与最佳实践

  • 永远添加超时:对 await 任意可能无限等待的操作(尤其是 queue.get()),务必使用 asyncio.wait_for(..., timeout=...),避免测试卡死;
  • 避免 loop.run_until_complete:Pytest-asyncio 已管理事件循环,直接 await 即可,手动获取/运行 loop 反而易出错;
  • @pytest.mark.asyncio 是必需的:确保测试函数在 asyncio event loop 中执行;
  • Queue 状态需显式清理:queue.task_done() 必须在 queue.get() 后调用,否则 queue.join() 会永久等待(若测试中用到);
  • 真实无限循环?自定义 Queue:若函数确无退出条件(如 while True: 且不可 mock),应实现轻量 TestQueue 类,重写 put/get 以支持 raise TestStopIteration 等中断机制。

通过以上方法,你不仅能验证 await queue.put() 和 await queue.get() 的正确调度,更能精准断言数据流转路径、副作用调用与生命周期控制——让“看似不可测”的异步循环变得清晰、可靠、可维护。

热门AI工具

更多
VibeKnow
VibeKnow Hot

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

豆包大模型

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

UpDream
UpDream Hot

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

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

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

相关专题

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

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

1771

2023.07.20

python能做什么
python能做什么

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

4564

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

26917

2023.08.03

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

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

3267

2023.08.04

python eval
python eval

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

3267

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

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

60

2026.10.16

热门下载

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

精品课程

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

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