Merge pull request #34 from pytest-dev/pyqt5

Adding PyQt5 support

Fixes #33

Author: nicoddemus

.travis.yml

@@ -1,19 +1,26 @@
 language: python
 
 python:
-  - 2.7
-  - 3.2
+  - "2.7"
+  - "3.2"
 
 virtualenv:
-  system_site_packages: true  
+  system_site_packages: true
+
+matrix:
+  allow_failures:
+    # unfortunately couldn't find a reliable way to test pyqt5 on travis yet
+    - env: PYTEST_VERSION=2.7.0 PYTEST_QT_API=pyqt5
 
 env:
- - PYTEST_VERSION=2.6.4 PYTEST_QT_FORCE_PYQT=true
- - PYTEST_VERSION=2.6.4 PYTEST_QT_FORCE_PYQT=false
- - PYTEST_VERSION=2.7.0 PYTEST_QT_FORCE_PYQT=true
- - PYTEST_VERSION=2.7.0 PYTEST_QT_FORCE_PYQT=false
+ - PYTEST_VERSION=2.6.4 PYTEST_QT_API=pyqt4
+ - PYTEST_VERSION=2.6.4 PYTEST_QT_API=pyside
+ - PYTEST_VERSION=2.7.0 PYTEST_QT_API=pyqt4
+ - PYTEST_VERSION=2.7.0 PYTEST_QT_API=pyside
+ - PYTEST_VERSION=2.7.0 PYTEST_QT_API=pyqt5
 
 install:
+ - sudo add-apt-repository --yes ppa:ubuntu-sdk-team/ppa
  - sudo apt-get update
 
  # Qt

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 API, set the environment variable ``PYTEST_QT_API`` to
+``pyside``, ``pyqt4`` or ``pyqt5``.
 
 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 API, set the environment variable ``PYTEST_QT_API`` to
+``pyside``, ``pyqt4`` or ``pyqt5``.
 
 Installation
 ============

install-qt.py

@@ -12,11 +12,12 @@ def run(cmd):
         sys.exit('command %s failed with status %s' % (cmd, r))
 
 py3k = sys.version_info[0] == 3
-if os.environ['PYTEST_QT_FORCE_PYQT'] == "true":
+if os.environ['PYTEST_QT_API'] in ('pyqt4', 'pyqt5'):
+    pyqt_ver = os.environ['PYTEST_QT_API'][-1]
     if py3k:
-        run('sudo apt-get install -qq python3-pyqt4')
+        run('sudo apt-get install -qq python3-pyqt%s' % pyqt_ver)
     else:
-        run('sudo apt-get install -qq python-qt4')
+        run('sudo apt-get install -qq python-qt%s' % pyqt_ver)
 else:
     if py3k:
         run('sudo apt-get install -qq python3-pyside')

pytestqt/_tests/test_basics.py

@@ -1,15 +1,16 @@
 import weakref
 import pytest
-from pytestqt.qt_compat import QtGui, Qt, QEvent, QtCore
+from pytestqt.qt_compat import QtGui, Qt, QEvent, QtCore, QApplication, \
+    QWidget
 
 
 def test_basics(qtbot):
     """
     Basic test that works more like a sanity check to ensure we are setting up a QApplication
     properly and are able to display a simple event_recorder.
     """
-    assert isinstance(QtGui.qApp, QtGui.QApplication)
-    widget = QtGui.QWidget()
+    assert QApplication.instance() is not None
+    widget = QWidget()
     qtbot.addWidget(widget)
     widget.setWindowTitle('W1')
     widget.show()
@@ -62,7 +63,7 @@ def test_stop_for_interaction(qtbot):
     """
     Test qtbot.stopForInteraction()
     """
-    widget = QtGui.QWidget()
+    widget = QWidget()
     qtbot.addWidget(widget)
     qtbot.waitForWindowShown(widget)
     QtCore.QTimer.singleShot(0, widget.close)
@@ -73,13 +74,13 @@ def test_widget_kept_as_weakref(qtbot):
     """
     Test if the widget is kept as a weak reference in QtBot
     """
-    widget = QtGui.QWidget()
+    widget = QWidget()
     qtbot.add_widget(widget)
     widget = weakref.ref(widget)
     assert widget() is None
 
 
-class EventRecorder(QtGui.QWidget):
+class EventRecorder(QWidget):
 
     """
     Widget that records some kind of events sent to it.
@@ -90,7 +91,7 @@ class EventRecorder(QtGui.QWidget):
     """
 
     def __init__(self):
-        QtGui.QWidget.__init__(self)
+        QWidget.__init__(self)
         self._event_types = {}
         self.event_data = None
 

pytestqt/_tests/test_exceptions.py

@@ -1,7 +1,7 @@
 import pytest
 import sys
 from pytestqt.plugin import capture_exceptions, format_captured_exceptions
-from pytestqt.qt_compat import QtGui, Qt, QtCore
+from pytestqt.qt_compat import QtGui, Qt, QtCore, QApplication
 
 
 pytest_plugins = 'pytester'
@@ -31,7 +31,7 @@ def test_catch_exceptions_in_virtual_methods(qtbot, raise_error):
     tests fail if any.
     """
     v = Receiver(raise_error)
-    app = QtGui.QApplication.instance()
+    app = QApplication.instance()
     app.sendEvent(v, QtCore.QEvent(QtCore.QEvent.User))
     app.sendEvent(v, QtCore.QEvent(QtCore.QEvent.User))
     app.processEvents()
@@ -67,9 +67,9 @@ def test_no_capture(testdir, no_capture_by_marker):
         ''')
     testdir.makepyfile('''
         import pytest
-        from pytestqt.qt_compat import QtGui, QtCore
+        from pytestqt.qt_compat import QWidget, QtCore
 
-        class MyWidget(QtGui.QWidget):
+        class MyWidget(QWidget):
 
             def mouseReleaseEvent(self, ev):
                 raise RuntimeError

pytestqt/plugin.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from pytestqt.qt_compat import QtCore, QtGui, QtTest
+from pytestqt.qt_compat import QtCore, QtTest, QApplication, QT_API
 
 
 def _inject_qtest_methods(cls):
@@ -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'): # pragma: no cover
+            # PyQt4 and PySide
+            QtTest.QTest.qWaitForWindowShown(widget)
+        else: # pragma: no cover
+            # PyQt5
+            QtTest.QTest.qWaitForWindowExposed(widget)
 
     wait_for_window_shown = waitForWindowShown  # pep-8 alias
 
@@ -370,9 +378,9 @@ def qapp():
     fixture that instantiates the QApplication instance that will be used by
     the tests.
     """
-    app = QtGui.QApplication.instance()
+    app = QApplication.instance()
     if app is None:
-        app = QtGui.QApplication([])
+        app = QApplication([])
         yield app
         app.exit()
     else:
@@ -410,4 +418,8 @@ def pytest_configure(config):
     config.addinivalue_line(
         'markers',
         "qt_no_exception_capture: Disables pytest-qt's automatic exception "
-        'capture for just one test item.')
+        'capture for just one test item.')
+
+
+def pytest_report_header():
+    return ['qt-api: %s' % QT_API]

pytestqt/qt_compat.py

@@ -11,47 +11,78 @@
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 if not on_rtd:  # pragma: no cover
-    try:
-        import PySide.QtCore as _QtCore
-        QtCore = _QtCore
-        USING_PYSIDE = True
-    except ImportError:
-        USING_PYSIDE = False
-
-    FORCE_PYQT = os.environ.get('PYTEST_QT_FORCE_PYQT', 'false') == 'true'
-    if not USING_PYSIDE or FORCE_PYQT:
+
+    def _try_import(name):
         try:
-            import sip
+            __import__(name)
+            return True
         except ImportError:
-            msg = 'pytest-qt requires either PyQt4 or PySide to be installed'
+            return False
+
+    def _guess_qt_api():
+        if _try_import('PySide'):
+            return 'pyside'
+        elif _try_import('PyQt4'):
+            return 'pyqt4'
+        elif _try_import('PyQt5'):
+            return 'pyqt5'
+        else:
+            msg = 'pytest-qt requires either PySide, PyQt4 or PyQt5 to be installed'
             raise ImportError(msg)
-        USING_PYSIDE = False
-        import PyQt4.QtCore as _QtCore
-        QtCore = _QtCore
-
-    if USING_PYSIDE:
-        def _import_module(moduleName):
-            pyside = __import__('PySide', globals(), locals(), [moduleName], 0)
-            return getattr(pyside, moduleName)
-    
+
+    # backward compatibility support: PYTEST_QT_FORCE_PYQT
+    if os.environ.get('PYTEST_QT_FORCE_PYQT', 'false') == 'true':
+        QT_API = 'pyqt4'
+    else:
+        QT_API = os.environ.get('PYTEST_QT_API')
+        if QT_API is not None:
+            QT_API = QT_API.lower()
+            if QT_API not in ('pyside', 'pyqt4', 'pyqt5'):
+                msg = 'Invalid value for $PYTEST_QT_API: %s'
+                raise RuntimeError(msg % QT_API)
+        else:
+            QT_API = _guess_qt_api()
+
+    # backward compatibility
+    USING_PYSIDE = QT_API == 'pyside'
+
+    def _import_module(module_name):
+        m = __import__(_root_module, globals(), locals(), [module_name], 0)
+        return getattr(m, module_name)
+
+    _root_modules = {
+        'pyside': 'PySide',
+        'pyqt4': 'PyQt4',
+        'pyqt5': 'PyQt5',
+    }
+    _root_module = _root_modules[QT_API]
+
+    QtCore = _import_module('QtCore')
+    QtGui = _import_module('QtGui')
+    QtTest = _import_module('QtTest')
+    Qt = QtCore.Qt
+    QEvent = QtCore.QEvent
+
+    if QT_API == 'pyside':
         Signal = QtCore.Signal
         Slot = QtCore.Slot
         Property = QtCore.Property
-    else:
-        def _import_module(moduleName):
-            pyside = __import__('PyQt4', globals(), locals(), [moduleName], 0)
-            return getattr(pyside, moduleName)
-    
+        QApplication = QtGui.QApplication
+        QWidget = QtGui.QWidget
+
+    elif QT_API in ('pyqt4', 'pyqt5'):
         Signal = QtCore.pyqtSignal
         Slot = QtCore.pyqtSlot
         Property = QtCore.pyqtProperty
-    
-    
-    QtGui = _import_module('QtGui')
-    QtTest = _import_module('QtTest')
-    Qt = QtCore.Qt
-    QEvent = QtCore.QEvent
-    
+
+        if QT_API == 'pyqt5':
+            _QtWidgets = _import_module('QtWidgets')
+            QApplication = _QtWidgets.QApplication
+            QWidget = _QtWidgets.QWidget
+        else:
+            QApplication = QtGui.QApplication
+            QWidget = QtGui.QWidget
+
 else:  # pragma: no cover
     USING_PYSIDE = True
 
@@ -77,3 +108,6 @@ def __getattr__(cls, name):
     QtTest = Mock()
     Qt = Mock()
     QEvent = Mock()
+    QApplication = Mock()
+    QWidget = Mock()
+    QT_API = '<none>'