Python中利用unittest.mock测试标准输出stdout的方法

问题描述

问题

假设你的程序中有一个函数会向标准输出（sys.stdout）写入文本，即把内容打印到屏幕上。现在你需要编写测试用例，验证在给定特定输入的情况下，程序能够正确地输出预期的结果。

解决方案概述

解决方案

利用unittest.mock模块提供的patch()函数，可以非常简便地实现这一目标。该方法允许你在单个测试中模拟sys.stdout，并在测试结束后自动回滚，从而避免产生大量临时变量或在测试用例之间暴露状态变量。

代码示例与实现

例如，我们在mymodule模块中定义如下函数：

# mymodule.py

def urlprint(protocol, host, domain):
  url = '{}://{}.{}'.format(protocol, host, domain)
  print(url)

默认情况下，内置的print函数会将输出发送至sys.stdout。为了验证输出确实存在，你可以使用一个替身对象来模拟它，并通过断言确认结果。利用unittest.mock模块的patch()方法，可以方便地在测试运行的上下文中替换对象，并在测试完成后自动恢复其原有状态。以下是对mymodule模块的测试代码示例：

from io import StringIO
from unittest import TestCase
from unittest.mock import patch
import mymodule

class TestURLPrint(TestCase):
  def test_url_gets_to_stdout(self):
    protocol = 'http'
    host = 'www'
    domain = 'example.com'
    expected_url = '{}://{}.{}\n'.format(protocol, host, domain)

    with patch('sys.stdout', new=StringIO()) as fake_out:
      mymodule.urlprint(protocol, host, domain)
      self.assertEqual(fake_out.getvalue(), expected_url)

深入讨论与注意事项

讨论

urlprint()函数接收三个参数，测试方法首先为每个参数设置具体的值。expected_url变量被赋值为包含期望输出内容的字符串。

unittest.mock.patch()函数作为上下文管理器使用，它用StringIO对象替代sys.stdout。fake_out变量是在此过程中创建的模拟对象。在with语句中，你可以执行各种检查操作。当with语句结束时，patch会将所有状态恢复到测试开始前的样子。需要注意的是，某些Python的C扩展可能会忽略sys.stdout的配置而直接写入标准输出。受篇幅限制，此处不深入讨论此情况，该方法主要适用于纯Python代码。如果确实需要在C扩展中捕获I/O，可以先打开一个临时文件，然后将标准输出重定向到该文件中。

以上就是Python如何测试stdout输出的详细内容，更多关于Python测试stdout输出的资料请关注本站其它相关文章！