pytest官方文档 6.2 中文翻译版（第九章）：捕获 STDOUT/STDERR 输出

梦里梦外; 2023-01-19 08:24 11阅读 0赞

# 捕获 STDOUT/STDERR 输出 #

*译者注： stdout是标准输出设备 stderr 是标准错误输出设备*

### 9.1 默认的 stdout/stderr/stdin 捕捉行为 ###

在测试执行的过程中，很多输出被 stdout 和 stderr 捕获。当一个测试或者setup方法失败的时候，相关的输出经常会与错误跟踪（ failure traceback）一起显示。（这个行为可以被命令行中 --show-capture 选项配置）。

另外，如果从stdin中读取失败了，它将会被设置为“null”，因为在自动化测试中，我们几乎不可能等待一个交互式的输入。

### 9.2 设置捕捉方法或禁用捕捉 ###

在pytest中有三种执行捕获的方式：

*  fd （文件描述符）级别的捕捉（默认）：所有对文件系统描述符 1 和 2 的写入会被抓取
 *  sys 级别捕捉：只有在python文件中写 sys.stdout 和 sys.stderr 的会被抓取。向文件描述符的写入操作不会被抓取
 *  tee-sys 捕捉：python中的 sys.stdout 和 sys.stderr 会被抓取，写入也会通过真实系统的 sys.stdout 和 sys.stderr。这允许输出被“实时打印”，被插件用的较多，例如 junitxml

*译者注：关于文件系统描述符，需要了解一些linux的知识，简单理解文件系统描述符写入1 2就是标准输出和标准错误输出*

你可以通过命令行来修改输出的机制：

pytest -s # 禁用所有的抓取
    pytest --capture=sys # 使用python文件中的 sys.stdout/stderr 替换原有的标准输出
    pytest --capture=fd # 也输出标准输出和标准错误输出
    pytest --capture=tee-sys # 结合了 'sys' 和 '-s'，抓取 sys.stdout/stderr 然后传递给真实的标准输出

*译者注：TODO*

### 9.3 使用print来调试 ###

默认捕获行为的一个很大的好处是你可以使用print来进行调试：

# content of test_module.py
    
    def setup_function(function):
    	print("setting up", function)
    
    def test_func1():
    	assert True
    
    def test_func2():
    	assert False

运行这个模块，你会得到失败的方法的精确输出，正确的将会隐藏：

$ pytest
    =========================== test session starts ============================
    platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-0.x.y
    cachedir: $PYTHON_PREFIX/.pytest_cache
    rootdir: $REGENDOC_TMPDIR
    collected 2 items
    test_module.py .F [100%]
    ================================= FAILURES =================================
    ________________________________ test_func2 ________________________________
    def test_func2():
    > assert False
    E assert False
    test_module.py:12: AssertionError
    -------------------------- Captured stdout setup ---------------------------
    setting up <function test_func2 at 0xdeadbeef>
    ========================= short test summary info ==========================
    FAILED test_module.py::test_func2 - assert False
    ======================= 1 failed, 1 passed in 0.12s ========================

### 9.4 在测试方法中访问标准输出 ###

capsys, capsysbinary, capfd, 和capfdbinary 四个夹具允许我们在测试执行的时候访问 stdout/stderr 的输出。下面是一些执行输出检查的例子：

def test_myoutput(capsys): # 或使用 "capfd" 在fd级别进行监听
    	print("hello")
    	sys.stderr.write("world\n")
    	captured = capsys.readouterr()
    	assert captured.out == "hello\n"
    	assert captured.err == "world\n"
    	print("next")
    	captured = capsys.readouterr()
    	assert captured.out == "next\n"

readouterr() 获取了标准输出当前状态的快照，并且会继续捕获。在测试函数完成之后，原始的输出流会被恢复。使用 capsys 这种方法使得我们不需要关注获取输出流和在测试之后重置输出流，同时与pytest自身的捕获机制兼容良好。  
如果你想在文件描述符的层面进行捕获，你可以使用 capfd夹具，这个夹具的使用方法与上面介绍的相同，同时也允许从库中或子进程中抓取那些直接写入操作系统的输出流。  
readouterr的返回值改变为两个属性的元组，out和err。  
如果测试中写入的数据不是文本类型（non-textual）的，你也可以使用capsysbinary来捕获二进制数据，readouterr方法返回一个bytes。  
如果测试中写入的数据不是文本类型（non-textual）的，你也可以使用capfdbinary来捕获二进制数据，readouterr方法返回一个bytes。capfdbinary夹具是作用在文件描述符层面。  
为了在一个测试中暂时的禁用捕获器，capsys和capfd都拥有一个 disabled() 方法，我们可以使用一个上下文管理器去在某一块中禁用捕获：

def test_disabling_capturing(capfd):
        print("this output is captured")
        with capfd.disabled():
            print("output not captured, going directly to sys.stdout")
            print("this output is also captured")