Question

我正在为下一个函数编写测试：

def foo():
    print 'hello world!'

所以，当我想测试这个函数时，代码将是这样的：

import sys
from foomodule import foo
def test_foo():
    foo()
    output = sys.stdout.getline().strip() # because stdout is an StringIO instance
    assert output == 'hello world!'

但如果我使用-s参数运行nosetests，测试会崩溃。如何通过unittest或nose模块捕获输出？

Answer 1

我使用此context manager来捕获输出。它最终通过临时替换sys.stdout使用与其他一些答案相同的技术。我更喜欢上下文管理器，因为它将所有簿记包装到一个函数中，因此我不必重新编写任何try-finally代码，而且我不必为此编写setup和teardown函数。

import sys
from contextlib import contextmanager
from StringIO import StringIO

@contextmanager
def captured_output():
    new_out, new_err = StringIO(), StringIO()
    old_out, old_err = sys.stdout, sys.stderr
    try:
        sys.stdout, sys.stderr = new_out, new_err
        yield sys.stdout, sys.stderr
    finally:
        sys.stdout, sys.stderr = old_out, old_err

像这样使用：

with captured_output() as (out, err):
    foo()
# This can go inside or outside the `with` block
output = out.getvalue().strip()
self.assertEqual(output, 'hello world!')

此外，由于在退出with块时恢复原始输出状态，我们可以在与第一个相同的函数中设置第二个捕获块，这是使用设置和拆卸功能无法实现的，并且在手动编写try-finally块时变得罗嗦。当测试的目标是比较两个函数相对于彼此的结果而不是一些预先计算的值时，这种能力就派上用场了。

Answer 2

如果你真的想这样做，你可以在测试期间重新分配sys.stdout。

def test_foo():
    import sys
    from foomodule import foo
    from StringIO import StringIO

    saved_stdout = sys.stdout
    try:
        out = StringIO()
        sys.stdout = out
        foo()
        output = out.getvalue().strip()
        assert output == 'hello world!'
    finally:
        sys.stdout = saved_stdout

但是，如果我正在编写此代码，我希望将可选的out参数传递给foo函数。

def foo(out=sys.stdout):
    out.write("hello, world!")

然后测试更简单：

def test_foo():
    from foomodule import foo
    from StringIO import StringIO

    out = StringIO()
    foo(out=out)
    output = out.getvalue().strip()
    assert output == 'hello world!'

Answer 3

从版本2.7开始，您不再需要重新分配sys.stdout，这是通过buffer flag提供的。而且，这是nosetest的默认行为。

以下是非缓冲上下文失败的示例：

import sys
import unittest

def foo():
    print 'hello world!'

class Case(unittest.TestCase):
    def test_foo(self):
        foo()
        if not hasattr(sys.stdout, "getvalue"):
            self.fail("need to run in buffered mode")
        output = sys.stdout.getvalue().strip() # because stdout is an StringIO instance
        self.assertEquals(output,'hello world!')

您可以通过unit2命令行标记-b，--buffer或unittest.main选项设置缓冲区。相反的是通过nosetest标志--nocapture实现的。

if __name__=="__main__":   
    assert not hasattr(sys.stdout, "getvalue")
    unittest.main(module=__name__, buffer=True, exit=False)
    #.
    #----------------------------------------------------------------------
    #Ran 1 test in 0.000s
    #
    #OK
    assert not hasattr(sys.stdout, "getvalue")

    unittest.main(module=__name__, buffer=False)
    #hello world!
    #F
    #======================================================================
    #FAIL: test_foo (__main__.Case)
    #----------------------------------------------------------------------
    #Traceback (most recent call last):
    #  File "test_stdout.py", line 15, in test_foo
    #    self.fail("need to run in buffered mode")
    #AssertionError: need to run in buffered mode
    #
    #----------------------------------------------------------------------
    #Ran 1 test in 0.002s
    #
    #FAILED (failures=1)

Answer 4

很多这些答案对我来说都失败了，因为你不能在Python 3中from StringIO import StringIO。这是基于@naxa评论和Python Cookbook的最小工作片段。

from io import StringIO
from unittest.mock import patch

with patch('sys.stdout', new=StringIO()) as fakeOutput:
    print('hello world')
    self.assertEqual(fakeOutput.getvalue().strip(), 'hello world')

Answer 5

在python 3.5中，您可以使用contextlib.redirect_stdout()和StringIO()。这是对代码的修改

import contextlib
from io import StringIO
from foomodule import foo

def test_foo():
    temp_stdout = StringIO()
    with contextlib.redirect_stdout(temp_stdout):
        foo()
    output = temp_stdout.getvalue().strip()
    assert output == 'hello world!'

Answer 6

我只是在学习Python，发现自己正在努力解决类似问题，并对输出方法进行单元测试。我对foo模块的传递单元测试结果看起来像这样：

import sys
import unittest
from foo import foo
from StringIO import StringIO

class FooTest (unittest.TestCase):
    def setUp(self):
        self.held, sys.stdout = sys.stdout, StringIO()

    def test_foo(self):
        foo()
        self.assertEqual(sys.stdout.getvalue(),'hello world!\n')

Answer 7

编写测试通常会向我们展示编写代码的更好方法。与Shane的答案类似，我想建议另一种方式来看待这个问题。你真的想断言你的程序输出了某个字符串，或者只是构造了某个字符串来输出吗？这变得更容易测试，因为我们可以假设Python print语句正确地完成了它的工作。

def foo_msg():
    return 'hello world'

def foo():
    print foo_msg()

然后你的测试非常简单：

def test_foo_msg():
    assert 'hello world' == foo_msg()

当然，如果您真的需要测试程序的实际输出，那么请随意忽略。：）

Answer 8

根据Rob Kennedy的回答，我写了一个基于类的上下文管理器版本来缓冲输出。

用法如下：

with OutputBuffer() as bf:
    print('hello world')
assert bf.out == 'hello world\n'

以下是实施：

from io import StringIO
import sys


class OutputBuffer(object):

    def __init__(self):
        self.stdout = StringIO()
        self.stderr = StringIO()

    def __enter__(self):
        self.original_stdout, self.original_stderr = sys.stdout, sys.stderr
        sys.stdout, sys.stderr = self.stdout, self.stderr
        return self

    def __exit__(self, exception_type, exception, traceback):
        sys.stdout, sys.stderr = self.original_stdout, self.original_stderr

    @property
    def out(self):
        return self.stdout.getvalue()

    @property
    def err(self):
        return self.stderr.getvalue()

Answer 9

或者考虑使用pytest，它内置了对断言stdout和stderr的支持。见docs

def test_myoutput(capsys): # or use "capfd" for fd-level
    print("hello")
    captured = capsys.readouterr()
    assert captured.out == "hello\n"
    print("next")
    captured = capsys.readouterr()
    assert captured.out == "next\n"

Answer 10

n611x007和Noumenon都已经建议使用unittest.mock，但是此答案适用于Acumenus's，以说明如何轻松包装unittest.TestCase方法来与嘲笑stdout。

import io
import unittest
import unittest.mock

msg = "Hello World!"


# function we will be testing
def foo():
    print(msg, end="")


# create a decorator which wraps a TestCase method and pass it a mocked
# stdout object
mock_stdout = unittest.mock.patch('sys.stdout', new_callable=io.StringIO)


class MyTests(unittest.TestCase):

    @mock_stdout
    def test_foo(self, stdout):
        # run the function whose output we want to test
        foo()
        # get its output from the mocked stdout
        actual = stdout.getvalue()
        expected = msg
        self.assertEqual(actual, expected)

Answer 11

基于此线程中所有出色的答案，这就是我解决的方法。我想尽可能地保留它。我使用setUp()增强了单元测试机制，以捕获sys.stdout和sys.stderr，添加了新的断言API，以将捕获的值与期望值进行比较，然后恢复sys.stdout和{{ 1}}经过sys.stderr单元测试tearDown(). I did this to keep a similar unit test API as the built-in sys.stdout API while still being able to unit test values printed to sys.stderr`。

or

运行单元测试时，输出为：

import io
import sys
import unittest


class TestStdout(unittest.TestCase):

    # before each test, capture the sys.stdout and sys.stderr
    def setUp(self):
        self.test_out = io.StringIO()
        self.test_err = io.StringIO()
        self.original_output = sys.stdout
        self.original_err = sys.stderr
        sys.stdout = self.test_out
        sys.stderr = self.test_err

    # restore sys.stdout and sys.stderr after each test
    def tearDown(self):
        sys.stdout = self.original_output
        sys.stderr = self.original_err

    # assert that sys.stdout would be equal to expected value
    def assertStdoutEquals(self, value):
        self.assertEqual(self.test_out.getvalue().strip(), value)

    # assert that sys.stdout would not be equal to expected value
    def assertStdoutNotEquals(self, value):
        self.assertNotEqual(self.test_out.getvalue().strip(), value)

    # assert that sys.stderr would be equal to expected value
    def assertStderrEquals(self, value):
        self.assertEqual(self.test_err.getvalue().strip(), value)

    # assert that sys.stderr would not be equal to expected value
    def assertStderrNotEquals(self, value):
        self.assertNotEqual(self.test_err.getvalue().strip(), value)

    # example of unit test that can capture the printed output
    def test_print_good(self):
        print("------")

        # use assertStdoutEquals(value) to test if your
        # printed value matches your expected `value`
        self.assertStdoutEquals("------")

    # fails the test, expected different from actual!
    def test_print_bad(self):
        print("@=@=")
        self.assertStdoutEquals("@-@-")


if __name__ == '__main__':
    unittest.main()

Answer 12

我喜欢问题和示例代码的直接回答[em] sorens' [1]，特别是因为我不熟悉补丁/模拟之类的新功能。 sorens 没有提出使示例代码的 TestStdIO 类的自定义断言方法可重用而又不求助于剪切/粘贴的方法，因此我采用了使 TestStdIO 在其自己的模块（以下示例中为 teststdoutmethods.py ）中定义的“ mixin”类。由于在TestStdIO中使用的通常由 unittest.TestCase 提供的assert方法引用也可以在测试用例类中找到，因此我从他的示例代码中删除了 import unittest 行，并且从类声明中的 unittest.TestCase 导出 TestStdIO ，即

import io
import sys

class TestStdIO(object):
    def setUp(self):
        ...

否则，TestStdIO的代码为sorens的版本，没有最后两个示例用法。我在Ch的一个基本示例文本游戏之一中，在某个类的一些简单单元测试用例中使用了 TestStdIO 的mixin类版本。 Kinsley和McGugan的使用PyGame开始Python游戏编程的第二篇，例如

import unittest
from teststdoutmethods import TestStdIO   # sorens' TestStdIO as a mixin.
from tank import Tank  # From Beginning Python Game Programming with PyGame.

class Test_Tank_fire(TestStdIO, unittest.TestCase):   # Note multiple inheritance.

    def test_Tank_fire_wAmmo(self):
        oTank1 = Tank('Bill', 5, 100)
        oTank2 = Tank('Jim', 5, 100)

        self.setUp()
        oTank1.fire_at(oTank2)

        self.assertStdoutEquals("Bill fires on Jim\nJim is hit!")
        self.assertEqual(str(oTank1), 'Bill (100 Armor, 4 Ammo)', 'fire_at shooter attribute results incorrect')
        self.assertTrue(str(oTank2) == 'Jim (80 Armor, 5 Ammo)', 'fire_at target attribute results incorrect')

        self.tearDown()

    def test_Tank_fire_woAmmo(self):
        oTank1 = Tank('Bill', 5, 100)
        oTank2 = Tank('Jim', 5, 100)

        # Use up 5 allotted shots.
        for n in range(5):
            oTank1.fire_at(oTank2)

        self.setUp()
        # Try one more.
        oTank1.fire_at(oTank2)

        self.assertStdoutEquals("Bill has no shells!")

        self.tearDown()
    
    def test_Tank_explode(self):
        oTank1 = Tank('Bill', 5, 100)
        oTank2 = Tank('Jim', 5, 100)

        # Use up 4 shots.
        for n in range(4):
            oTank1.fire_at(oTank2)

        self.setUp()
        # Fifth shot should finish the target.
        oTank1.fire_at(oTank2)

        self.assertStdoutEquals("Bill fires on Jim\nJim is hit!\nJim explodes!")
        self.tearDown()

        self.assertTrue(str(oTank2) == 'Jim (DEAD)', 'fire_at target __str__ incorrect when Dead')

测试用例（成功和失败的失败）在Python 3.7中有效。请注意， sorens'技术会捕获setup（）和teardown（）调用之间的所有stdout输出，因此我将它们放在将生成要检查的特定输出的特定操作周围。我认为我的mixin方法是 sorens 打算用于一般重用的方法，但是我想知道是否有人有不同的建议。谢谢。 [1]：https://stackoverflow.com/a/62429695/7386731

Answer 13

Unittest 现在带有上下文管理器（Python 3.7，但也可能是早期版本）。你可以这样做：

# example.py

import logging

def method_with_logging():
    logging.info("Hello, World!")

然后在您的单元测试中：

# test.py

from unittest import TestCase
from example import method_with_logging

class TestExample(TestCase):
    def test_logging(self):
        with self.assertLogs() as captured:
            method_with_logging()
        self.assertEqual(len(captured.records), 1) # check that there is only one log message
        self.assertEqual(captured.records[0].getMessage(), "Hello, World!") # and it is the proper one

取自https://pythonin1minute.com/how-to-test-logging-in-python/

如何在python中使用nosetest / unittest断言输出？

13 个答案: