使用 pytest.ini 进行日志记录。如何附加到文件?

时间:2021-01-21 08:17:12

标签: python logging pytest

我正在尝试将日志记录添加到我的 pytest 测试中,并且一切正常,除了每个其他测试运行的日志都重写了所有宝贵的信息。

这是我的 pytest.ini 文件:

log_file = my.log
log_file_level = DEBUG
log_file_format = %(levelname)s %(asctime)s - %(message)s (%(filename)s:%(lineno)s)
log_file_date_format=%Y-%m-%d %H:%M:%S

这是我的测试代码:

import os
class TestLog:
    def test_log_1(self):
        logging.info('everything is okay')
        output = 2
        assert output == 2, 'everything is okay'

    def test_log_2(self):
        output = 0
        logging.info(f'test params: {output}')
        try:
            assert output == 2, 'everything is okay'
        except AssertionError:
            logging.error(f"'everything is not okay'")
            raise AssertionError

我尝试添加 logging.basicConfig(filemode = "a") 但没有帮助。

任何帮助将不胜感激

1 个答案:

答案 0 :(得分:1)

引用 pytest docs

<块引用>

此日志文件以写入模式打开,这意味着它将在每个运行测试会话中被覆盖。

这意味着你不能通过配置强制附加模式; logging.basicConfig 在这里也无济于事,因为它在调用太晚时是一个 noop,或者它确实配置了日志记录,但后来 pytest 仍然会忽略它并设置自己的处理程序。

我看到的唯一选择是通过将新日志与前一个日志合并来管理附加。在开始时备份 my.log,在退出前将其与新的 my.log 合并。将代码放在项目中的文件 conftest.py 或测试根目录中:

import io
import pathlib
import os
import shutil


def pytest_configure(config):
    log_file = config.rootpath / config.getini("log_file")
    if log_file.is_file():
        config._backup = log_file.with_name(".log.bak")
        shutil.copy(log_file, config._backup)


@pytest.hookimpl(trylast=True)
def pytest_unconfigure(config):
    log_file = config.rootpath / config.getini("log_file")
    if log_file.is_file():
        log_backup = getattr(config, "_backup", None)
        if log_backup and log_backup.is_file():
            log_file.write_text(log_backup.read_text() + log_file.read_text())
            log_backup.unlink()

另一个选项可能会弄乱 pytest 内部结构,但由于模式是硬编码的,因此实现会相当丑陋,例如猴子修补 _pytest.logging._FileHandler 并强制执行追加模式。因此,我建议不要这样做。