含随机输出的函数如何优化Doctest测试方案？

针对你描述的场景——函数输出带有随机性（示例为随机打印不同名字，实际是数据库请求结果不可控），目前用doctest的ELLIPSIS标记虽能凑合用，但确实有更精准的测试方案，以下几种方法供参考：

1. 捕获输出并验证是否在预期集合内 #

用pytest或unittest这类测试框架的输出捕获功能，拿到函数的控制台输出后，直接判断它是否属于你预设的合法结果集合。

pytest 示例代码 #

from random import choice
import pytest

def hello():
    print(f"Hello {choice(('Guido', 'Raymond'))}!")

def test_hello_output(capsys):
    hello()
    # 获取并清理输出内容（去掉换行符）
    output = capsys.readouterr().out.strip()
    # 验证输出是两个预期结果之一
    assert output in {"Hello Guido!", "Hello Raymond!"}

unittest 示例代码 #

import unittest
from random import choice
from io import StringIO
import sys

def hello():
    print(f"Hello {choice(('Guido', 'Raymond'))}!")

class TestHelloFunction(unittest.TestCase):
    def test_hello_valid_output(self):
        # 临时替换标准输出以捕获内容
        saved_stdout = sys.stdout
        try:
            output_buffer = StringIO()
            sys.stdout = output_buffer
            hello()
            output = output_buffer.getvalue().strip()
            self.assertIn(output, {"Hello Guido!", "Hello Raymond!"})
        finally:
            # 恢复标准输出
            sys.stdout = saved_stdout

2. 优化doctest的写法（如果坚持用doctest） #

doctest本身支持通过多组示例覆盖所有可能的输出，虽然每次测试只会命中其中一种，但多次运行能覆盖所有情况；或者结合ELLIPSIS的同时，也可以用注释明确允许可选结果：

from random import choice

def hello():
    """
    >>> hello()  # doctest: +ELLIPSIS
    Hello Guido!
    >>> hello()  # doctest: +ELLIPSIS
    Hello Raymond!
    """
    print(f"Hello {choice(('Guido', 'Raymond'))}!")

不过这种方式的严谨性不如第一种方案，更适合简单场景的快速验证。

3. 依赖注入（适配复杂场景如数据库请求） #

对于实际中依赖随机数据库请求的复杂函数，最可靠的做法是把外部依赖抽象成可注入的参数，测试时传入固定的模拟实现，彻底规避随机性。

示例代码：

from random import choice

# 改造函数，允许传入自定义的获取结果的逻辑
def hello(get_target=None):
    # 生产环境默认用随机逻辑，测试时可替换
    if get_target is None:
        get_target = lambda: choice(('Guido', 'Raymond'))
    print(f"Hello {get_target()}!")

# 测试代码（以pytest为例）
def test_hello_with_mocked_data(capsys):
    # 注入固定返回"Guido"的逻辑
    hello(lambda: "Guido")
    assert capsys.readouterr().out.strip() == "Hello Guido!"
    
    # 注入固定返回"Raymond"的逻辑
    hello(lambda: "Raymond")
    assert capsys.readouterr().out.strip() == "Hello Raymond!"

这种方法从根源上解决了随机依赖的测试问题，尤其适合涉及外部服务、数据库的复杂函数，让测试完全可控。

内容的提问来源于stack exchange，提问作者edd313