Remove thin wrapper over qInstallMessageHandler

Author: nicoddemus

pytestqt/_tests/test_logging.py

@@ -8,10 +8,10 @@
 pytest_plugins = 'pytester'
 
 
-@pytest.mark.parametrize('test_succeds, qt_log',
+@pytest.mark.parametrize('test_succeeds, qt_log',
                          [(True, True), (True, False), (False, False),
                           (False, True)])
-def test_basic_logging(testdir, test_succeds, qt_log):
+def test_basic_logging(testdir, test_succeeds, qt_log):
     """
     Test Qt logging capture output.
 
@@ -26,10 +26,10 @@ def test_types():
             qWarning('this is a WARNING message')
             qCritical('this is a CRITICAL message')
             assert {0}
-        """.format(test_succeds)
+        """.format(test_succeeds)
     )
     res = testdir.runpytest(*(['--no-qt-log'] if not qt_log else []))
-    if test_succeds:
+    if test_succeeds:
         assert 'Captured Qt messages' not in res.stdout.str()
         assert 'Captured stderr call' not in res.stdout.str()
     else:
@@ -406,7 +406,8 @@ def test_context_none(testdir):
         def test_foo(request):
             log_capture = request.node.qt_log_capture
             context = log_capture._Context(None, None, None)
-            log_capture._handle(QtWarningMsg, "WARNING message", context)
+            log_capture._handle_with_context(QtWarningMsg,
+                                             context, "WARNING message")
             assert 0
         """
     )

pytestqt/plugin.py

@@ -13,7 +13,8 @@
 import re
 
 from pytestqt.qt_compat import QtCore, QtTest, QApplication, QT_API, \
-    qInstallMsgHandler, QtDebugMsg, QtWarningMsg, QtCriticalMsg, QtFatalMsg
+    qInstallMsgHandler, qInstallMessageHandler, QtDebugMsg, QtWarningMsg, \
+    QtCriticalMsg, QtFatalMsg
 
 
 def _inject_qtest_methods(cls):
@@ -692,7 +693,7 @@ def pytest_runtest_makereport(self, item, call):
 class _QtMessageCapture(object):
     """
     Captures Qt messages when its `handle` method is installed using
-    qInstallMsgHandler, and stores them into `messages` attribute.
+    qInstallMsgHandler, and stores them into `records` attribute.
 
     :attr _records: list of Record instances.
     :attr _ignore_regexes: list of regexes (as strings) that define if a record
@@ -705,10 +706,26 @@ def __init__(self, ignore_regexes):
         self._previous_handler = None
 
     def _start(self):
-        self._previous_handler = qInstallMsgHandler(self._handle)
+        """
+        Start receiving messages from Qt.
+        """
+        if qInstallMsgHandler:
+            previous_handler = qInstallMsgHandler(self._handle_no_context)
+        else:
+            assert qInstallMessageHandler
+            previous_handler = qInstallMessageHandler(self._handle_with_context)
+        self._previous_handler = previous_handler
 
     def _stop(self):
-        qInstallMsgHandler(self._previous_handler)
+        """
+        Stop receiving messages from Qt, restoring the previously installed
+        handler.
+        """
+        if qInstallMsgHandler:
+            qInstallMsgHandler(self._previous_handler)
+        else:
+            assert qInstallMessageHandler
+            qInstallMessageHandler(self._previous_handler)
 
     @contextmanager
     def disabled(self):
@@ -724,10 +741,13 @@ def disabled(self):
 
     _Context = namedtuple('_Context', 'file function line')
 
-    def _handle(self, msg_type, message, context=None):
+    def _append_new_record(self, msg_type, message, context):
         """
-        Method to be installed using qInstallMsgHandler, stores each message
-        into the `messages` attribute.
+        Creates a new Record instance and stores it.
+
+        :param msg_type: Qt message typ
+        :param message: message string, if bytes it will be converted to str.
+        :param context: QMessageLogContext object or None
         """
         def to_unicode(s):
             if isinstance(s, bytes):
@@ -751,6 +771,20 @@ def to_unicode(s):
 
         self._records.append(Record(msg_type, message, ignored, context))
 
+    def _handle_no_context(self, msg_type, message):
+        """
+        Method to be installed using qInstallMsgHandler (Qt4),
+        stores each message into the `_records` attribute.
+        """
+        self._append_new_record(msg_type, message, context=None)
+
+    def _handle_with_context(self, msg_type, context, message):
+        """
+        Method to be installed using qInstallMessageHandler (Qt5),
+        stores each message into the `_records` attribute.
+        """
+        self._append_new_record(msg_type, message, context=context)
+
     @property
     def records(self):
         """Access messages captured so far.

pytestqt/qt_compat.py

@@ -76,6 +76,11 @@ def _import_module(module_name):
     QtCriticalMsg = QtCore.QtCriticalMsg
     QtFatalMsg = QtCore.QtFatalMsg
 
+    # Qt4 and Qt5 have different functions to install a message handler;
+    # the plugin will try to use the one that is not None
+    qInstallMsgHandler = None
+    qInstallMessageHandler = None
+
     if QT_API == 'pyside':
         Signal = QtCore.Signal
         Slot = QtCore.Slot
@@ -93,19 +98,7 @@ def _import_module(module_name):
             _QtWidgets = _import_module('QtWidgets')
             QApplication = _QtWidgets.QApplication
             QWidget = _QtWidgets.QWidget
-
-            def qInstallMsgHandler(handler):
-                """
-                Installs the given function as a message handler. This
-                will adapt Qt5 message handler signature into Qt4
-                message handler's signature.
-                """
-                def _Qt5MessageHandler(msg_type, context, msg):
-                    handler(msg_type, msg, context)
-                if handler is not None:
-                    return QtCore.qInstallMessageHandler(_Qt5MessageHandler)
-                else:
-                    return QtCore.qInstallMessageHandler(None)
+            qInstallMessageHandler = QtCore.qInstallMessageHandler
         else:
             QApplication = QtGui.QApplication
             QWidget = QtGui.QWidget
@@ -141,6 +134,7 @@ def __getattr__(cls, name):
     QApplication = Mock()
     QWidget = Mock()
     qInstallMsgHandler = Mock()
+    qInstallMessageHandler = Mock()
     qDebug = Mock()
     qWarning = Mock()
     qCritical = Mock()