Python高级技术之：`pytest`的`capsys`和`capfd`：如何捕获标准输出和标准错误。

各位观众，大家好！ 欢迎来到今天的Python高级技术讲座。 今天我们要聊聊pytest里两个非常实用的小工具：capsys和capfd， 它们能帮你轻松捕获标准输出（stdout）和标准错误（stderr）。 想象一下，你的代码里塞满了print语句，或者某些库偷偷摸摸地往屏幕上输出了一些东西，你想验证这些输出是否符合预期，或者只是想把它们保存下来以便后续分析，这时候capsys和capfd就派上大用场了。

一、为什么需要捕获标准输出和标准错误？

在深入了解capsys和capfd之前，我们先来思考一个问题：为什么要捕获标准输出和标准错误？

• 单元测试： 在单元测试中，我们经常需要验证函数或方法是否产生了预期的输出。例如，一个计算器函数，我们需要确保它不仅返回了正确的结果，还在控制台打印了计算过程。
• 调试： 当程序出现问题时，标准输出和标准错误通常会包含一些有用的调试信息。捕获这些信息可以帮助我们更快地定位问题。
• 日志记录： 有时候，我们需要把程序的输出保存到日志文件中，以便后续分析。capsys和capfd可以方便地获取程序的输出，然后写入日志文件。
• 清理输出： 有些第三方库可能会产生大量的输出，影响测试结果的可读性。我们可以使用capsys和capfd来清理这些输出。

二、capsys：捕获标准输出和标准错误到字符串

capsys是pytest提供的一个fixture，它可以捕获测试函数执行期间的标准输出和标准错误，并将它们保存到字符串中。

1. 基本用法

import pytest

def test_print_output(capsys):
    print("Hello, stdout!")
    import sys
    print("Hello, stderr!", file=sys.stderr)

    captured = capsys.readouterr()
    assert captured.out == "Hello, stdout!n"
    assert captured.err == "Hello, stderr!n"

在这个例子中，我们定义了一个名为test_print_output的测试函数，它接受一个capsys参数。在测试函数中，我们使用print函数向标准输出和标准错误分别输出了一些内容。然后，我们调用capsys.readouterr()方法来获取捕获的输出。readouterr()方法返回一个namedtuple，包含out和err两个属性，分别表示标准输出和标准错误的内容。最后，我们使用assert语句来验证捕获的输出是否符合预期。

2. capsys.readouterr()的细节

capsys.readouterr()方法会返回一个namedtuple，其结构如下：

from collections import namedtuple

CaptureFixtureResult = namedtuple("CaptureFixtureResult", ["out", "err"])

这意味着你可以像这样访问捕获的输出：

captured = capsys.readouterr()
stdout_output = captured.out
stderr_output = captured.err

3. capsys.disabled()：临时禁用捕获

有时候，我们可能需要在测试函数中临时禁用capsys的捕获功能。例如，我们可能想在调试时直接看到程序的输出。capsys提供了一个disabled()方法来实现这个功能。

import pytest

def test_disable_capture(capsys):
    with capsys.disabled():
        print("This will be printed to the console.")

    captured = capsys.readouterr()
    assert captured.out == ""  # 捕获不到 "This will be printed to the console."

在这个例子中，我们使用with capsys.disabled():语句块来禁用capsys的捕获功能。在语句块中，我们使用print函数向标准输出输出了一些内容。由于capsys被禁用，所以这些内容会直接打印到控制台，而不会被capsys捕获。

4. 什么时候使用capsys？

• 当你想验证函数或方法是否产生了预期的输出时。
• 当你想把程序的输出保存到字符串中，以便后续分析时。
• 当你需要临时禁用capsys的捕获功能时。

三、capfd：捕获标准输出和标准错误到文件描述符

capfd是pytest提供的另一个fixture，它也可以捕获测试函数执行期间的标准输出和标准错误，但与capsys不同的是，capfd将输出捕获到文件描述符中。这意味着你可以像操作文件一样读取和写入捕获的输出。

1. 基本用法

import pytest
import sys

def test_file_descriptor_capture(capfd):
    print("Hello, stdout!")
    print("Hello, stderr!", file=sys.stderr)

    captured = capfd.readouterr()
    assert captured.out == "Hello, stdout!n"
    assert captured.err == "Hello, stderr!n"

这个例子与capsys的例子非常相似。唯一的区别是，我们使用了capfd fixture，而不是capsys fixture。capfd.readouterr()方法同样返回一个namedtuple，包含out和err两个属性，分别表示标准输出和标准错误的内容。

2. capfd.readouterr()的细节

capfd.readouterr()的返回值结构与capsys完全相同，也是一个CaptureFixtureResult namedtuple。

3. capfd.disabled()：临时禁用捕获

与capsys类似，capfd也提供了一个disabled()方法来临时禁用捕获功能。

import pytest

def test_disable_capfd(capfd):
    with capfd.disabled():
        print("This will be printed to the console.")

    captured = capfd.readouterr()
    assert captured.out == ""

4. 什么时候使用capfd？

• 当你想像操作文件一样读取和写入捕获的输出时。
• 当你需要临时禁用capfd的捕获功能时。
• 当你的代码需要处理文件描述符时，capfd可能更方便。

四、capsys vs capfd：选择哪个？

capsys和capfd都可以捕获标准输出和标准错误，那么我们应该选择哪个呢？

一般来说，capsys更常用，因为它更简单易用。capsys将输出捕获到字符串中，方便我们进行字符串操作和比较。

capfd则更适合处理文件描述符的场景。例如，你可能需要将捕获的输出传递给另一个进程，或者你需要使用文件描述符相关的系统调用。

下表总结了capsys和capfd的主要区别：

特性	capsys	capfd
捕获方式	字符串	文件描述符
易用性	更简单	相对复杂
适用场景	大部分场景，字符串操作	处理文件描述符的场景
readouterr()返回值	CaptureFixtureResult namedtuple	CaptureFixtureResult namedtuple
disabled()	支持	支持

五、高级用法：自定义输出流

有时候，我们可能需要捕获自定义的输出流，而不仅仅是标准输出和标准错误。例如，我们可能有一个自定义的日志类，它会将日志信息输出到特定的文件或网络地址。

虽然capsys和capfd主要用于捕获标准输出和标准错误，但我们可以通过一些技巧来实现自定义输出流的捕获。

1. 重定向标准输出和标准错误

最常用的方法是重定向标准输出和标准错误。我们可以使用sys.stdout和sys.stderr来访问标准输出和标准错误的文件对象，然后将它们重定向到我们自己的文件对象。

import pytest
import sys
from io import StringIO

def test_redirect_output(capsys):
    # 创建一个StringIO对象来捕获输出
    string_io = StringIO()

    # 保存原始的标准输出和标准错误
    original_stdout = sys.stdout
    original_stderr = sys.stderr

    # 重定向标准输出和标准错误
    sys.stdout = string_io
    sys.stderr = string_io

    try:
        print("Hello, custom output!")
        print("Hello, custom error!", file=sys.stderr)

        # 获取捕获的输出
        captured_output = string_io.getvalue()

        # 验证捕获的输出
        assert "Hello, custom output!" in captured_output
        assert "Hello, custom error!" in captured_output

        # 使用capsys 来检查是否标准输出和标准错误确实没有输出
        captured_capsys = capsys.readouterr()
        assert captured_capsys.out == ""
        assert captured_capsys.err == ""

    finally:
        # 恢复原始的标准输出和标准错误
        sys.stdout = original_stdout
        sys.stderr = original_stderr

在这个例子中，我们首先创建了一个StringIO对象，用于存储捕获的输出。然后，我们保存了原始的标准输出和标准错误的文件对象，并将标准输出和标准错误重定向到StringIO对象。在try语句块中，我们使用print函数向标准输出和标准错误输出了一些内容。然后，我们调用string_io.getvalue()方法来获取捕获的输出。最后，在finally语句块中，我们恢复了原始的标准输出和标准错误的文件对象。

2. Monkey Patching

另一种方法是使用monkey patching。Monkey patching是指在运行时动态地修改对象的属性或方法。我们可以使用monkey patching来替换print函数或日志类的输出方法，从而捕获它们的输出。

import pytest
import io

def test_monkey_patching(monkeypatch):
    # 创建一个StringIO对象来捕获输出
    string_io = io.StringIO()

    # 定义一个替换的print函数
    def mock_print(*args, **kwargs):
        print(*args, file=string_io, **kwargs)

    # 使用monkeypatch来替换print函数
    monkeypatch.setattr("builtins.print", mock_print)

    # 调用print函数
    print("Hello, monkey patched output!")

    # 获取捕获的输出
    captured_output = string_io.getvalue()

    # 验证捕获的输出
    assert captured_output == "Hello, monkey patched output!n"

在这个例子中，我们首先创建了一个StringIO对象，用于存储捕获的输出。然后，我们定义了一个替换的print函数mock_print，它会将输出写入到StringIO对象。最后，我们使用monkeypatch.setattr()方法来替换内置的print函数。

六、最佳实践

• 只在必要时使用capsys和capfd： 频繁使用capsys和capfd可能会影响测试性能。只在需要验证输出或捕获输出时才使用它们。
• 使用with语句块： 使用with capsys.disabled():或with capfd.disabled():语句块可以确保在语句块执行完毕后，capsys或capfd的捕获功能会被自动恢复。
• 避免在生产代码中使用capsys和capfd： capsys和capfd是pytest提供的测试工具，不应该在生产代码中使用。

七、总结

今天我们学习了pytest提供的两个强大的fixture：capsys和capfd。它们可以帮助我们轻松捕获标准输出和标准错误，并在单元测试、调试和日志记录等方面发挥重要作用。希望大家能够灵活运用这两个工具，编写出更健壮、更易于维护的Python代码。

记住，capsys适合大多数场景，简单易用，而capfd则更适合处理文件描述符的特殊情况。根据你的具体需求选择合适的工具，才能事半功倍。

感谢大家的聆听，下次再见！