Supporting qWaitForWindowShown in Qt5 and updated documentation

Author: nicoddemus

README.rst

@@ -56,10 +56,16 @@ Requirements
 
 Python 2.6 or later, including Python 3+.
 
-Works with either PySide_ or
-PyQt_ picking whichever is available on the system, giving
-preference to ``PySide`` if both are installed (to force it to use ``PyQt``, set
-the environment variable ``PYTEST_QT_FORCE_PYQT=true``).
+Works with either PySide_, PyQt_ (``PyQt4`` and ``PyQt5``) picking whichever
+is available on the system, giving preference to the first one installed in
+this order:
+
+- ``PySide``
+- ``PyQt4``
+- ``PyQt5``
+
+To force a particular version of PyQt_, set the environment variable
+``PYTEST_QT_FORCE_PYQT=4`` or ``PYTEST_QT_FORCE_PYQT=5``.
 
 Documentation
 =============

docs/index.rst

@@ -26,10 +26,16 @@ Python 2.6 or later, including Python 3+.
 
 Tested with pytest version 2.5.2.
 
-Works with either `PySide` or
-`PyQt`, picking one that is available giving
-preference to `PySide` if both are installed (to force it to use `PyQt`, set
-the environment variable `PYTEST_QT_FORCE_PYQT=true`).
+Works with either ``PySide``, ``PyQt4`` or ``PyQt5``, picking whichever
+is available on the system giving preference to the first one installed in
+this order:
+
+- ``PySide``
+- ``PyQt4``
+- ``PyQt5``
+
+To force a particular version of ``PyQt``, set the environment variable
+``PYTEST_QT_FORCE_PYQT=4`` or ``PYTEST_QT_FORCE_PYQT=5``.
 
 Installation
 ============

pytestqt/plugin.py

@@ -199,8 +199,16 @@ def waitForWindowShown(self, widget):
 
         :param QWidget widget:
             Widget to wait on.
+
+        .. note:: In Qt5, the actual method called is qWaitForWindowExposed,
+            but this name is kept for backward compatibility
         """
-        QtTest.QTest.qWaitForWindowShown(widget)
+        if hasattr(QtTest.QTest, 'qWaitForWindowShown'):
+            # PyQt4 and PySide
+            QtTest.QTest.qWaitForWindowShown(widget)
+        else:
+            # PyQt5
+            QtTest.QTest.qWaitForWindowExposed(widget)
 
     wait_for_window_shown = waitForWindowShown  # pep-8 alias
 

pytestqt/qt_compat.py

@@ -26,12 +26,22 @@
             msg = 'pytest-qt requires either PyQt4 or PySide to be installed'
             raise ImportError(msg)
 
-        PYQT_VER = os.environ.get('PYTEST_QT_FORCE_PYQT', '4')
-        # backward compatibility
-        if PYQT_VER == 'true':
-            PYQT_VER = '4'
-        if PYQT_VER not in ('4', '5'):
-            raise RuntimeError('Unsupported PyQt version: %s' % PYQT_VER)
+        if 'PYTEST_QT_FORCE_PYQT' in os.environ:
+            PYQT_VER = os.environ.get('PYTEST_QT_FORCE_PYQT', '4')
+            # backward compatibility
+            if PYQT_VER == 'true':
+                PYQT_VER = '4'
+            if PYQT_VER not in ('4', '5'):
+                msg = 'Unsupported PyQt version in $PYTEST_QT_FORCE_PYQT: %s'
+                raise RuntimeError(msg % PYQT_VER)
+        else:
+            # give preference for PyQt4 for backward compatibility
+            try:
+                import PyQt4
+                PYQT_VER = '4'
+            except ImportError:
+                import PyQt5
+                PYQT_VER = '5'
 
         USING_PYSIDE = False