Feature request: use caplog with custom formatter

See original GitHub issue

My application uses a quite heavily customized logging formatter. Right now, the logging plugin only allows to specify the formats for the formatter, not completely replacing it. It would be nice if there was a clean way to provide a custom formatter.

This is the workaround I use for now, patching the plugin class on the module:

from _pytest import logging as pytest_logging

def pytest_configure(config):
    config.pluginmanager.get_plugin('logging').LoggingPlugin = MyLoggingPlugin

class MyLoggingPlugin(pytest_logging.LoggingPlugin):
    def __init__(self, config):
        super().__init__(config)
        self.formatter = MyCustomFormatter()

Issue Analytics

State:
Created 6 years ago
Reactions:10
Comments:7 (4 by maintainers)

Top GitHub Comments

9reactions

brechincommented, Jun 29, 2020

One option (definitely not optimal) would be to instantiate your custom formatter and set it explicitly on the caplog handler.

def test_my_function(caplog)
    formatter = MyCustomFormatter()
    caplog.handler.setFormatter(formatter)

    my_function()
    assert caplog.text == ....

2reactions

nicoddemuscommented, Nov 30, 2017

Perhaps this can be implemented as a hook:

@hookimpl(firstresult=True)
def pytest_logging_formatter(config):
    """Return a logging.Formatter instance that will be used by the internal logging capture"""

Then you can do this in your root conftest.py file:

def pytest_logging_formatter(config):
    return MyCustomFormatter()

Top Results From Across the Web

Pytest caplog works with custom logger when created with a ...

I have been testing my custom loggers with Pytest. Created a custom logger from Yaml config file, and wrote the following test:

How to manage logging — pytest documentation

If desired the log and date format can be specified to anything that the ... To access logs from other stages, use the...

_pytest.logging module — pytest API documentation

Returns a list of a stripped down version of log records intended for use in assertion comparison. The format of the tuple is:...

loguru Documentation - Read the Docs

Loguru is a library which aims to bring enjoyable logging in Python. Did you ever feel lazy about configuring a logger and used...

Reference — pytest documentation

@pytest.fixture; config.cache; capsys; capsysbinary; capfd; capfdbinary; doctest_namespace; request; pytestconfig; record_property; caplog; monkeypatch ...