Adding support for PySide2 in pytest-qt.

Author: Fabio Zadrozny

.pydevproject

@@ -2,6 +2,7 @@
 <?eclipse-pydev version="1.0"?><pydev_project>
 <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
 <path>/${PROJECT_DIR_NAME}</path>
+<path>/${PROJECT_DIR_NAME}/tests</path>
 </pydev_pathproperty>
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.7</pydev_property>
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>

pytestqt/qt_compat.py

@@ -1,15 +1,14 @@
 """
 Provide a common way to import Qt classes used by pytest-qt in a unique manner,
-abstracting API differences between PyQt4, PyQt5 and PySide.
+abstracting API differences between PyQt4, PyQt5, PySide and PySide2.
 
 .. note:: This module is not part of pytest-qt public API, hence its interface
 may change between releases and users should not rely on it.
 
 Based on from https://github.com/epage/PythonUtils.
 """
 
-from __future__ import with_statement
-from __future__ import division
+from __future__ import with_statement, division
 from collections import namedtuple
 import os
 
@@ -29,7 +28,7 @@ def _get_qt_api_from_env(self):
         api = os.environ.get('PYTEST_QT_API')
         if api is not None:
             api = api.lower()
-            if api not in ('pyside', 'pyqt4', 'pyqt4v2', 'pyqt5'):  # pragma: no cover
+            if api not in ('pyside', 'pyside2', 'pyqt4', 'pyqt4v2', 'pyqt5'):  # pragma: no cover
                 msg = 'Invalid value for $PYTEST_QT_API: %s'
                 raise RuntimeError(msg % api)
         return api
@@ -42,22 +41,27 @@ def _can_import(name):
             except ImportError:
                 return False
 
-        if _can_import('PyQt5'):
+        # Note, not importing only the root namespace because when uninstalling from conda,
+        # the namespace can still be there.
+        if _can_import('PyQt5.QtCore'):
             return 'pyqt5'
-        elif _can_import('PySide'):
+        elif _can_import('PySide.QtCore'):
             return 'pyside'
-        elif _can_import('PyQt4'):
+        elif _can_import('PySide2.QtCore'):
+            return 'pyside2'
+        elif _can_import('PyQt4.QtCore'):
             return 'pyqt4'
         return None
 
     def set_qt_api(self, api):
         self.pytest_qt_api = api or self._get_qt_api_from_env() or self._guess_qt_api()
         if not self.pytest_qt_api:  # pragma: no cover
-            msg = 'pytest-qt requires either PySide, PyQt4 or PyQt5 to be installed'
+            msg = 'pytest-qt requires either PySide, PySide2, PyQt4 or PyQt5 to be installed'
             raise RuntimeError(msg)
 
         _root_modules = {
             'pyside': 'PySide',
+            'pyside2': 'PySide2',
             'pyqt4': 'PyQt4',
             'pyqt4v2': 'PyQt4',
             'pyqt5': 'PyQt5',
@@ -100,21 +104,35 @@ def _import_module(module_name):
         self.qInstallMsgHandler = None
         self.qInstallMessageHandler = None
 
-        if self.pytest_qt_api == 'pyside':
+        if self.pytest_qt_api in ('pyside', 'pyside2'):
             self.Signal = QtCore.Signal
             self.Slot = QtCore.Slot
             self.Property = QtCore.Property
             self.QApplication = QtGui.QApplication
             self.QWidget = QtGui.QWidget
             self.QStringListModel = QtGui.QStringListModel
-            self.qInstallMsgHandler = QtCore.qInstallMsgHandler
 
             self.QStandardItem = QtGui.QStandardItem
             self.QStandardItemModel = QtGui.QStandardItemModel
-            self.QStringListModel = QtGui.QStringListModel
-            self.QSortFilterProxyModel = QtGui.QSortFilterProxyModel
             self.QAbstractListModel = QtCore.QAbstractListModel
             self.QAbstractTableModel = QtCore.QAbstractTableModel
+            self.QStringListModel = QtGui.QStringListModel
+
+            if self.pytest_qt_api == 'pyside2':
+                _QtWidgets = _import_module('QtWidgets')
+                self.QApplication = _QtWidgets.QApplication
+                self.QWidget = _QtWidgets.QWidget
+                self.QLineEdit = _QtWidgets.QLineEdit
+                self.qInstallMessageHandler = QtCore.qInstallMessageHandler
+
+                self.QSortFilterProxyModel = QtCore.QSortFilterProxyModel
+            else:
+                self.QApplication = QtGui.QApplication
+                self.QWidget = QtGui.QWidget
+                self.QLineEdit = QtGui.QLineEdit
+                self.qInstallMsgHandler = QtCore.qInstallMsgHandler
+
+                self.QSortFilterProxyModel = QtGui.QSortFilterProxyModel
 
             def extract_from_variant(variant):
                 """PySide does not expose QVariant API"""
@@ -180,9 +198,16 @@ def make_variant(value=None):
             self.make_variant = make_variant
 
     def get_versions(self):
-        if self.pytest_qt_api == 'pyside':
-            import PySide
-            return VersionTuple('PySide', PySide.__version__, self.QtCore.qVersion(),
+        if self.pytest_qt_api in ('pyside', 'pyside2'):
+            qt_api_name = 'PySide2' if self.pytest_qt_api == 'pyside2' else 'PySide'
+            if self.pytest_qt_api == 'pyside2':
+                import PySide2
+                version = PySide2.__version__
+            else:
+                import PySide
+                version = PySide.__version__
+
+            return VersionTuple(qt_api_name, version, self.QtCore.qVersion(),
                                 self.QtCore.__version__)
         else:
             qt_api_name = 'PyQt5' if self.pytest_qt_api == 'pyqt5' else 'PyQt4'

pytestqt/qtbot.py

@@ -218,7 +218,7 @@ def waitForWindowShown(self, widget):
 
         .. note:: This method is also available as ``wait_for_window_shown`` (pep-8 alias)
         """
-        if qt_api.pytest_qt_api == 'pyqt5':
+        if hasattr(qt_api.QtTest.QTest, 'qWaitForWindowExposed'):
             return qt_api.QtTest.QTest.qWaitForWindowExposed(widget)
         else:
             return qt_api.QtTest.QTest.qWaitForWindowShown(widget)

tests/test_logging.py

@@ -4,6 +4,8 @@
 
 from pytestqt.qt_compat import qt_api
 
+pytestmark = pytest.mark.skipif(qt_api.pytest_qt_api == 'pyside2', reason="https://bugreports.qt.io/browse/PYSIDE-435")
+
 
 @pytest.mark.parametrize('test_succeeds', [True, False])
 @pytest.mark.parametrize('qt_log', [True, False])

tests/test_qtest_proxies.py

@@ -4,7 +4,7 @@
 from pytestqt.qt_compat import qt_api
 
 
-fails_on_pyqt = pytest.mark.xfail('qt_api.pytest_qt_api != "pyside"')
+fails_on_pyqt = pytest.mark.xfail('qt_api.pytest_qt_api not in ("pyside", "pyside2")')
 
 
 @pytest.mark.parametrize('expected_method', [
@@ -29,4 +29,4 @@ def test_expected_qtest_proxies(qtbot, expected_method):
     Ensure that we are exporting expected QTest API methods.
     """
     assert hasattr(qtbot, expected_method)
-    assert getattr(qtbot, expected_method).__name__ == expected_method
+    assert getattr(qtbot, expected_method).__name__ == expected_method

tests/test_wait_signal.py

@@ -290,22 +290,36 @@ def test_wait_signals_invalid_strict_parameter(qtbot, signaller):
 
 def test_destroyed(qtbot):
     """Test that waitSignal works with the destroyed signal (#82).
-
-    For some reason, this crashes PySide although it seems perfectly fine code.
     """
-    if qt_api.pytest_qt_api == 'pyside':
-        pytest.skip('test crashes PySide')
+    if qt_api.pytest_qt_api.startswith('pyside'):
+        # PySide uses shiboken instead of sip.
+        if qt_api.pytest_qt_api == 'pyside':
+            try:
+                from PySide import shiboken
+            except ImportError:
+                import shiboken
+        else:
+            from PySide2 import shiboken2 as shiboken
 
-    import sip
+        class Obj(qt_api.QtCore.QObject):
+            pass
 
-    class Obj(qt_api.QtCore.QObject):
-        pass
+        obj = Obj()
+        with qtbot.waitSignal(obj.destroyed):
+            obj.deleteLater()
+
+        assert not shiboken.isValid(obj)
+    else:
+        import sip
 
-    obj = Obj()
-    with qtbot.waitSignal(obj.destroyed):
-        obj.deleteLater()
+        class Obj(qt_api.QtCore.QObject):
+            pass
+
+        obj = Obj()
+        with qtbot.waitSignal(obj.destroyed):
+            obj.deleteLater()
 
-    assert sip.isdeleted(obj)
+        assert sip.isdeleted(obj)
 
 
 class TestArgs:
@@ -708,7 +722,7 @@ def get_mixed_signals_with_guaranteed_name(signaller):
     Returns a list of signals with the guarantee that the signals have names (i.e. the names are
     manually provided in case of using PySide, where the signal names cannot be determined at run-time).
     """
-    if qt_api.pytest_qt_api == 'pyside':
+    if qt_api.pytest_qt_api.startswith('pyside'):
         signals = [(signaller.signal, "signal()"), (signaller.signal_args, "signal_args(QString,int)"),
                    (signaller.signal_args, "signal_args(QString,int)")]
     else:
@@ -790,7 +804,7 @@ def test_without_callback_and_args(self, qtbot, signaller):
         In a situation where a signal without args is expected but not emitted, tests that the TimeoutError
         message contains the name of the signal (without arguments).
         """
-        if qt_api.pytest_qt_api == 'pyside':
+        if qt_api.pytest_qt_api.startswith('pyside'):
             signal = (signaller.signal, "signal()")
         else:
             signal = signaller.signal
@@ -811,7 +825,7 @@ def test_unable_to_get_callback_name(self, qtbot, signaller):
         if sys.version_info >= (3,5):
             pytest.skip("Only on Python 3.4 and lower double-wrapped functools.partial callbacks are a problem")
 
-        if qt_api.pytest_qt_api == 'pyside':
+        if qt_api.pytest_qt_api.startswith('pyside'):
             signal = (signaller.signal_single_arg, "signal_single_arg(int)")
         else:
             signal = signaller.signal_single_arg
@@ -836,7 +850,7 @@ def test_with_single_arg(self, qtbot, signaller):
         rejected by a callback, tests that the TimeoutError message contains the name of the signal and the
         list of non-accepted arguments.
         """
-        if qt_api.pytest_qt_api == 'pyside':
+        if qt_api.pytest_qt_api.startswith('pyside'):
             signal = (signaller.signal_single_arg, "signal_single_arg(int)")
         else:
             signal = signaller.signal_single_arg
@@ -858,7 +872,7 @@ def test_with_multiple_args(self, qtbot, signaller):
         rejected by a callback, tests that the TimeoutError message contains the name of the signal and the
         list of tuples of the non-accepted arguments.
         """
-        if qt_api.pytest_qt_api == 'pyside':
+        if qt_api.pytest_qt_api.startswith('pyside'):
             signal = (signaller.signal_args, "signal_args(QString,int)")
         else:
             signal = signaller.signal_args
@@ -999,7 +1013,7 @@ def test_degenerate_error_msg(self, qtbot, signaller):
         by the user. This degenerate messages doesn't contain the signals' names, and includes a hint to the user how
         to fix the situation.
         """
-        if qt_api.pytest_qt_api != 'pyside':
+        if qt_api.pytest_qt_api not in ('pyside', 'pyside2'):
             pytest.skip("test only makes sense for PySide, whose signals don't contain a name!")
 
         with pytest.raises(TimeoutError) as excinfo: