Customize displayed records with qt-log-format command line option

Author: nicoddemus

pytestqt/_tests/test_logging.py

@@ -1,3 +1,4 @@
+import datetime
 import pytest
 
 from pytestqt.qt_compat import qDebug, qWarning, qCritical, QtDebugMsg, \
@@ -83,4 +84,27 @@ def test_types(qtlog):
         """
     )
     res = testdir.runpytest('--no-qt-log')
-    res.stdout.fnmatch_lines('*1 passed*')
+    res.stdout.fnmatch_lines('*1 passed*')
+
+
+def test_logging_formatting(testdir):
+    """
+    Test custom formatting for logging messages.
+
+    :type testdir: _pytest.pytester.TmpTestdir
+    """
+    testdir.makepyfile(
+        """
+        from pytestqt.qt_compat import qWarning
+        def test_types():
+            qWarning('this is a WARNING message')
+            assert 0
+        """
+    )
+    f = '{rec.type_name} {rec.log_type_name} {rec.when:%Y-%m-%d}: {rec.message}'
+    res = testdir.runpytest('--qt-log-format={}'.format(f))
+    today = '{0:%Y-%m-%d}'.format(datetime.datetime.now())
+    res.stdout.fnmatch_lines([
+        '*-- Captured Qt messages --*',
+        'QtWarningMsg WARNING {0}: this is a WARNING message*'.format(today),
+    ])

pytestqt/plugin.py

@@ -4,6 +4,7 @@
 import sys
 import traceback
 import weakref
+import datetime
 
 import pytest
 
@@ -418,6 +419,8 @@ def pytest_addoption(parser):
 
     parser.addoption('--no-qt-log', dest='qt_log', action='store_false',
                      default=True)
+    parser.addoption('--qt-log-format', dest='qt_log_format',
+                     default='{rec.type_name}: {rec.message}')
 
 
 def pytest_configure(config):
@@ -470,8 +473,9 @@ def pytest_runtest_makereport(self, item, call):
                 long_repr = getattr(report, 'longrepr', None)
                 if hasattr(long_repr, 'addsection'):
                     lines = []
-                    for r in item.qt_log_capture.records:
-                        lines.append('{r.type_name}: {r.message}'.format(r=r))
+                    for rec in item.qt_log_capture.records:
+                        log_format = self.config.getoption('qt_log_format')
+                        lines.append(log_format.format(rec=rec))
                     if lines:
                         long_repr.addsection('Captured Qt messages',
                                              '\n'.join(lines))
@@ -519,13 +523,15 @@ class Record(object):
     :attr str log_type_name:
         type name similar to the logging package, for example ``DEBUG``,
         ``WARNING``, etc.
+    :attr datetime.datetime when: when the message was sent
     """
 
     def __init__(self, msg_type, message):
         self._type = msg_type
         self._message = message
         self._type_name = self._get_msg_type_name(msg_type)
         self._log_type_name = self._get_log_type_name(msg_type)
+        self._when = datetime.datetime.now()
 
     @property
     def message(self):
@@ -543,6 +549,10 @@ def type_name(self):
     def log_type_name(self):
         return self._log_type_name
 
+    @property
+    def when(self):
+        return self._when
+
     @classmethod
     def _get_msg_type_name(cls, msg_type):
         """