overwrite pytest log format

[jgzzzz]

Hello,

I wanted to ask if there is a way I can define my own format for the logger output like this:

import logging

class MyFormatter(logging.Formatter):
    def format(self, record):
        record.message2 = record.args.get("message2")
        return super().format(record)

logger = logging.getLogger('test')
ch = logging.StreamHandler()
ch.setFormatter(MyFormatter('%(message)s - %(asctime)s - %(message2)s'))
logging.basicConfig( level=logging.INFO, handlers=[ch] )

logger.info("[PASSED]", {"message2": "User log message"})

So what I want is two be able to write two string to the log line, one with the passed or fail string and trhe other with the comment from the user.

Thanks

[twmr]

No, AFAIK that is not easily possible. I guess you have to override the format method of the formatter instance/attribute of the LoggingPlugin.

The log-format ('%(message)s - %(asctime)s - %(message2)s') can be set in e.g. pytest.ini or pyproject.toml.

HTH

[jgzzzz]

Thanks, I solve it by making a copy on the logging.py from pytest and defined there at the beginning of the file

#new format
class MyFormatter(logging.Formatter):
    def format(self, record):
        record.message2 = record.args.get("message2")
        return super().format(record)

also I overwrote the formater as you suggested with my formater.

    def  _create_formatter(self, log_format, log_date_format, auto_indent):
        # Color option doesn't exist if terminal plugin is disabled.
        color = getattr(self._config.option, "color", "no")
        if color != "no" and ColoredLevelFormatter.LEVELNAME_FMT_REGEX.search(
            log_format
        ):
            formatter: logging.Formatter = ColoredLevelFormatter(
                create_terminal_writer(self._config), log_format, log_date_format
            )
        else:
            #formatter = logging.Formatter(log_format, log_date_format)
            formatter = MyFormatter(log_format, log_date_format)
        formatter._style = PercentStyleMultiline(
            formatter._style._fmt, auto_indent=auto_indent
        )

        return formatter

Then on the main conftest.py
I register that as a pluggin:

from mylogging import loggingPlugin

@pytest.hookimpl(trylast=True)
def pytest_configure(config):
  
    # Get the standard logging plugin...
    standard_logger = config.pluginmanager.getplugin('logging-plugin')
    my_logger = LoggingPlugin(standard_logger._config)

    # ...and replace it with my logger.
    config.pluginmanager.unregister(standard_logger)
    config.pluginmanager.register(my_logger, 'my-logging-plugin')

also the pytest.ini has the format '%(message)s - %(asctime)s - %(message2)s' defined.