如何查看pytest运行期间创建的正常打印输出？

Question

有时我想在我的代码中插入一些打印语句,看看在我练习时会打印出来的内容.我通常的"锻炼"方法是使用现有的pytest测试.但是当我运行这些时,我似乎无法看到任何标准输出(至少来自PyCharm,我的IDE).

在pytest运行期间有没有一种简单的方法来查看标准输出？

Answer 1

该-s开关禁用每次测试捕获.

Answer 2

pytest 从单个测试中捕获标准输出，并仅在特定条件下显示它们，以及它默认打印的测试摘要。

可以使用“-r”选项显示额外的摘要信息：

pytest -rP

显示通过测试的捕获输出。

pytest -rx

显示失败测试的捕获输出（默认行为）。

-r 的输出格式比 -s 更漂亮。

Answer 3

在接受回答的评论中,乔问道:

有没有办法打印到控制台并捕获输出,以便它显示在junit报告中？

在UNIX中,这通常被称为teeing.理想情况下,teeing而不是捕获将是py.test默认值.非理想情况下,py.test和任何现有的第三方py.test插件(我知道,无论如何)都不支持发球 - 尽管Python平凡地支持开箱即用的发球.

猴子修补py.test做任何不受支持的事情都是非平凡的.为什么？因为:

• 大多数py.test功能都锁定在不打算从外部导入的私有_pytest包之后.试图在不知道你正在做什么的情况下这样做通常会导致公共包在运行时引发模糊的异常.^{非常感谢,py.test.你到那里真的很健壮的建筑.}pytest
• 即使你做弄清楚如何猴子修补私人_pytest安全地API,你必须这样做之前运行的公共pytest包由外部运行py.test命令.您不能在插件中执行此操作(例如,conftest测试套件中的顶级模块).当py.test懒惰地动态导入你的插件时,你想要实现猴子补丁的任何py.test类早已被实例化 - 并且你无权访问该实例.这意味着,如果您希望有意义地应用您的monkey-patch,则无法再安全地运行外部py.test命令.相反,您必须使用自定义setuptools test命令(按顺序)包装该命令的运行:
  1. Monkey-patches私有_pytestAPI.
  2. 调用public pytest.main()函数来运行py.test命令.

这个答案猴子补丁py.test -s和--capture=no捕获stderr但不是 stdout的选项.默认情况下,这些选项既不捕获stderr也不捕获stdout.当然,这不是很发球.但是每一个伟大的旅程都始于一个繁琐的前传,每个人都会忘记五年.

为什么这样？我现在要告诉你.我的py.test驱动的测试套件包含慢速功能测试.显示这些测试的标准输出是有帮助的,可以让人放心,防止leyceckillall -9 py.test在另一个长期运行的功能测试未能连续几周做任何事情时触及.但是,显示这些测试的stderr会阻止py.test报告测试失败时的异常回溯.这完全没有用.因此,我们强制py.test捕获stderr而不是 stdout.

在我们开始之前,这个答案假设您已经有一个自定义setuptools test命令来调用py.test.如果不这样做,请参阅py.test编写良好的良好实践页面的手册集成小节.

不要不安装pytest亚军,第三方插件setuptools的提供自定义setuptools的test命令也调用py.test.如果已安装pytest-runner,您可能需要卸载该pip3包,然后采用上面链接的手动方法.

假设您按照上面突出显示的手动积分中的说明进行操作,您的代码库现在应该包含一个PyTest.run_tests()方法.修改此方法以类似于:

class PyTest(TestCommand):
             .
             .
             .
    def run_tests(self):
        # Import the public "pytest" package *BEFORE* the private "_pytest"
        # package. While importation order is typically ignorable, imports can
        # technically have side effects. Tragicomically, that is the case here.
        # Importing the public "pytest" package establishes runtime
        # configuration required by submodules of the private "_pytest" package.
        # The former *MUST* always be imported before the latter. Failing to do
        # so raises obtuse exceptions at runtime... which is bad.
        import pytest
        from _pytest.capture import CaptureManager, FDCapture, MultiCapture

        # If the private method to be monkey-patched no longer exists, py.test
        # is either broken or unsupported. In either case, raise an exception.
        if not hasattr(CaptureManager, '_getcapture'):
            from distutils.errors import DistutilsClassError
            raise DistutilsClassError(
                'Class "pytest.capture.CaptureManager" method _getcapture() '
                'not found. The current version of py.test is either '
                'broken (unlikely) or unsupported (likely).'
            )

        # Old method to be monkey-patched.
        _getcapture_old = CaptureManager._getcapture

        # New method applying this monkey-patch. Note the use of:
        #
        # * "out=False", *NOT* capturing stdout.
        # * "err=True", capturing stderr.
        def _getcapture_new(self, method):
            if method == "no":
                return MultiCapture(
                    out=False, err=True, in_=False, Capture=FDCapture)
            else:
                return _getcapture_old(self, method)

        # Replace the old with the new method.
        CaptureManager._getcapture = _getcapture_new

        # Run py.test with all passed arguments.
        errno = pytest.main(self.pytest_args)
        sys.exit(errno)

要启用此monkey-patch,请运行py.test,如下所示:

python setup.py test -a "-s"

现在将捕获Stderr而不是 stdout.漂亮!

将上面的猴子补丁扩展到tee stdout和stderr,留给玩家一个充满空闲时间的练习.

Answer 4

运行测试时使用该-s选项.exampletest.py运行测试时,所有打印语句都将打印在控制台上.

py.test exampletest.py -s

Answer 5

根据pytest文档,pytest的第3版可以在测试中临时禁用捕获:

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

Answer 6

pytest --capture=tee-sys最近添加（v5.4.0）。您可以捕获以及查看 stdout/err 上的输出。

Answer 7

pytest -s -v test_login.py在控制台中尝试 更多信息.

-v 这是一个简短的 --verbose

-s 意味着'禁用所有捕获'

Answer 8

pytest test_name.py -v -s

简单的！

Answer 9

您还可以通过在项目根目录中或中设置以下内容来启用 实时日志记录。pytest.initox.ini

[pytest]
log_cli = True

或者直接在cli上指定

pytest -o log_cli=True

Answer 10

您可以使用下面的这些命令显示打印输出。*-rP可以比-s,--capture=no和更清晰地显示打印输出--capture=tee-sys：

pytest -rP

pytest -s

pytest --capture=no

pytest --capture=tee-sys

Answer 11

我建议使用 -h 命令。有一些非常有趣的命令可以用于。但是，对于这种特殊情况：-s 快捷方式为 --capture=no。足够

pytest <test_file.py> -s

Answer 12

如果您使用的是logging，除了通用 stdout 之外，您还需要指定打开日志输出-s。基于pytest 测试中的日志记录，我正在使用：

pytest --log-cli-level=DEBUG -s my_directory/