Pytest官方教程-21-运行日志

安装及入门
使用和调用方法
原有TestSuite使用方法
断言的编写和报告
Pytest fixtures：清晰模块化易扩展
使用Marks标记测试用例
Monkeypatching/对模块和环境进行Mock
使用tmp目录和文件
捕获stdout及stderr输出
捕获警告信息
模块及测试文件中集成doctest测试
skip及xfail: 处理不能成功的测试用例
Fixture方法及测试用例的参数化
缓存: 使用跨执行状态
unittest.TestCase支持
运行Nose用例
经典xUnit风格的setup/teardown
安装和使用插件
插件编写
编写钩子(hook)方法
运行日志
API参考
1. 方法(Functions)
2. 标记(Marks)
3. 钩子(Hooks)
4. 装置(Fixtures)
5. 对象(Objects)
6. 特殊变量(Special Variables)
7. 环境变量(Environment Variables)
8. 配置选项(Configuration Options)
优质集成实践
片状测试
Pytest导入机制及sys.path/PYTHONPATH
配置选项
示例及自定义技巧
Bash自动补全设置

运行日志

版本3.3中的新功能。
在版本3.4中更改。

pytest自动捕获级别WARNING或更高级别的日志消息，并以与捕获的stdout和stderr相同的方式在每个失败的测试中显示它们自己的部分。

无选项运行：

pytest

显示失败的测试如下：

----------------------- Captured stdlog call ----------------------
test_reporting.py    26 WARNING  text going to logger
----------------------- Captured stdout call ----------------------
text going to stdout
----------------------- Captured stderr call ----------------------
text going to stderr
==================== 2 failed in 0.02 seconds =====================

默认情况下，每个捕获的日志消息都显示模块，行号，日志级别和消息。
如果需要，可以通过传递特定格式选项将日志和日期格式指定给日志记录模块支持的任何内容：

pytest --log-format="%(asctime)s %(levelname)s %(message)s" \
        --log-date-format="%Y-%m-%d %H:%M:%S"

显示失败的测试如下：

----------------------- Captured stdlog call ----------------------
2010-04-10 14:48:44 WARNING text going to logger
----------------------- Captured stdout call ----------------------
text going to stdout
----------------------- Captured stderr call ----------------------
text going to stderr
==================== 2 failed in 0.02 seconds =====================

这些选项也可以通过pytest.ini文件自定义：

[pytest]
log_format = %(asctime)s %(levelname)s %(message)s
log_date_format = %Y-%m-%d %H:%M:%S

此外，可以通过以下方式完全禁用对失败测试的捕获内容（stdout，stderr和logs）的报告：

pytest --show-capture=no

caplog夹具

在内部测试中，可以更改捕获的日志消息的日志级别。这是由caplog夹具支持：

def test_foo(caplog):
    caplog.set_level(logging.INFO)
    pass

默认情况下，在根记录器上设置级别，但为方便起见，还可以设置任何记录器的日志级别：

def test_foo(caplog):
    caplog.set_level(logging.CRITICAL, logger='root.baz')
    pass

设置的日志级别将在测试结束时自动恢复。

也可以使用上下文管理器临时更改with块内的日志级别：

def test_bar(caplog):
    with caplog.at_level(logging.INFO):
        pass

同样，默认情况下，根记录器的级别会受到影响，但可以使用以下方式更改任何记录器的级别：

def test_bar(caplog):
    with caplog.at_level(logging.CRITICAL, logger='root.baz'):
        pass

最后，在测试运行期间发送到记录器的所有日志都以logging.LogRecord实例和最终日志文本的形式在夹具上可用。当你想要对消息内容断言时，这非常有用：

def test_baz(caplog):
    func_under_test()
    for record in caplog.records:
        assert record.levelname != 'CRITICAL'
    assert 'wally' not in caplog.text

对于日志记录的所有可用属性，请参阅 logging.LogRecord该类。

record_tuples如果你要做的就是确保在给定的记录器名称下使用给定的严重性和消息记录某些消息，你也可以求助：

def test_foo(caplog):
    logging.getLogger().info('boo %s', 'arg')

    assert caplog.record_tuples == [
        ('root', logging.INFO, 'boo arg'),
    ]

你可以调用caplog.clear()以在测试中重置捕获的日志记录：

def test_something_with_clearing_records(caplog):
    some_method_that_creates_log_records()
    caplog.clear()
    your_test_method()
    assert ['Foo'] == [rec.message for rec in caplog.records]

该caplog.records属性仅包含当前阶段的记录，因此在setup阶段内它仅包含设置日志，call与teardown阶段相同。

要从其他阶段访问日志，请使用该caplog.get_records(when)方法。例如，如果要确保使用某个夹具的测试从不记录任何警告，你可以检查拆解期间的记录setup和call阶段，如下所示：

@pytest.fixture
def window(caplog):
    window = create_window()
    yield window
    for when in ("setup", "call"):
        messages = [
            x.message for x in caplog.get_records(when) if x.level == logging.WARNING
        ]
        if messages:
            pytest.fail(
                "warning messages encountered during testing: {}".format(messages)
            )

完整的API可在以下位置获得_pytest.logging.LogCaptureFixture。

实时日志

通过将log_cli配置选项设置为true，pytest将在将记录记录直接发送到控制台时输出记录记录。

你可以指定通过传递将具有相同或更高级别的日志记录打印到控制台的日志记录级别--log-cli-level。此设置接受python文档中显示的日志记录级别名称或记录级别num的整数。

此外，你还可以指定--log-cli-format以及 --log-cli-date-format默认为--log-format和 --log-date-format未提供的镜像和镜像，但仅应用于控制台日志记录处理程序。

还可以在配置INI文件中设置所有CLI日志选项。选项名称是：

log_cli_level
log_cli_format
log_cli_date_format

如果需要将整个测试套件记录调用记录到文件中，则可以传递 --log-file=/path/to/log/file。此日志文件以写入模式打开，这意味着它将在每次运行测试会话中被覆盖。

你还可以通过传递指定日志文件的日志记录级别 --log-file-level。此设置接受python文档中显示的日志记录级别名称（即大写级别名称）或整数作为日志记录级别num。

此外，你还可以指定--log-file-format和 --log-file-date-format哪个等于--log-format和--log-date-format，但被应用到日志文件记录处理程序。

还可以在配置INI文件中设置所有日志文件选项。选项名称是：

log_file
log_file_level
log_file_format
log_file_date_format

你可以调用set_log_path()以动态自定义log_file路径。此功能被认为是实验性的。

发行说明

此功能是作为pytest-catchlog插件的替代品引入的，它们相互冲突。pytest-capturelog 引入此功能时，后向兼容性API 已被删除，因此如果你仍然需要pytest-catchlog，可以通过添加到以下内容来禁用内部功能pytest.ini：

[pytest]
    addopts=-p no:logging

pytest 3.4中不兼容的变化

引入了此功能，3.3并在社区反馈后进行了一些不兼容的更改3.4：

除非log_level配置或--log-level命令行选项明确请求，否则不再更改日志级别。这允许用户自己配置记录器对象。
现在，默认情况下禁用实时日志，并且可以启用将log_cli配置选项设置为true。启用后，详细程度会增加，因此可以看到每个测试的日志记录。
实时日志现在发送到sys.stdout不再需要-s命令行选项。

如果要部分还原版本的日志记录行为3.3，可以将此选项添加到ini 文件中：

[pytest]
log_cli=true
log_level=NOTSET

有关导致此更改的讨论的更多详细信息，请参阅问题＃3013。