Introducing PYTEST_QT_API configuration variable

Also simplified the code that decided which API to use

Author: nicoddemus

.travis.yml

@@ -10,14 +10,14 @@ virtualenv:
 matrix:
   allow_failures:
     # unfortunately couldn't find a reliable way to test pyqt5 on travis yet
-    - env: PYTEST_VERSION=2.7.0 PYTEST_QT_FORCE_PYQT=5
+    - env: PYTEST_VERSION=2.7.0 PYTEST_QT_API=pyqt5
 
 env:
- - PYTEST_VERSION=2.6.4 PYTEST_QT_FORCE_PYQT=4
- - PYTEST_VERSION=2.6.4 PYTEST_QT_FORCE_PYQT=false
- - PYTEST_VERSION=2.7.0 PYTEST_QT_FORCE_PYQT=4
- - PYTEST_VERSION=2.7.0 PYTEST_QT_FORCE_PYQT=false
- - PYTEST_VERSION=2.7.0 PYTEST_QT_FORCE_PYQT=5
+ - 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

README.rst

@@ -64,8 +64,8 @@ this order:
 - ``PyQt4``
 - ``PyQt5``
 
-To force a particular version of PyQt_, set the environment variable
-``PYTEST_QT_FORCE_PYQT=4`` or ``PYTEST_QT_FORCE_PYQT=5``.
+To force a particular API, set the environment variable ``PYTEST_QT_API`` to
+``pyside``, ``pyqt4`` or ``pyqt5``.
 
 Documentation
 =============

docs/index.rst

@@ -34,8 +34,8 @@ this order:
 - ``PyQt4``
 - ``PyQt5``
 
-To force a particular version of ``PyQt``, set the environment variable
-``PYTEST_QT_FORCE_PYQT=4`` or ``PYTEST_QT_FORCE_PYQT=5``.
+To force a particular API, set the environment variable ``PYTEST_QT_API`` to
+``pyside``, ``pyqt4`` or ``pyqt5``.
 
 Installation
 ============

install-qt.py

@@ -12,9 +12,8 @@ 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'] != "false":
-    pyqt_ver = os.environ['PYTEST_QT_FORCE_PYQT']
-    assert pyqt_ver in ('4', '5'), 'unexpected pyqt_version: %s' % pyqt_ver
+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-pyqt%s' % pyqt_ver)
     else:

pytestqt/plugin.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from pytestqt.qt_compat import QtCore, QtTest, QApplication
+from pytestqt.qt_compat import QtCore, QtTest, QApplication, QT_API
 
 
 def _inject_qtest_methods(cls):
@@ -203,10 +203,10 @@ def waitForWindowShown(self, widget):
         .. note:: In Qt5, the actual method called is qWaitForWindowExposed,
             but this name is kept for backward compatibility
         """
-        if hasattr(QtTest.QTest, 'qWaitForWindowShown'):
+        if hasattr(QtTest.QTest, 'qWaitForWindowShown'): # pragma: no cover
             # PyQt4 and PySide
             QtTest.QTest.qWaitForWindowShown(widget)
-        else:
+        else: # pragma: no cover
             # PyQt5
             QtTest.QTest.qWaitForWindowExposed(widget)
 
@@ -418,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,72 +11,78 @@
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 if not on_rtd:  # pragma: no cover
-    try:
-        from PySide import QtCore
-        USING_PYSIDE = True
-    except ImportError:
-        USING_PYSIDE = False
-
-    FORCE_PYQT = os.environ.get('PYTEST_QT_FORCE_PYQT', 'false') != 'false'
-    PYQT_VER = None
-    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'
-            raise ImportError(msg)
+            return False
 
-        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)
+    def _guess_qt_api():
+        if _try_import('PySide'):
+            return 'pyside'
+        elif _try_import('PyQt4'):
+            return 'pyqt4'
+        elif _try_import('PyQt5'):
+            return 'pyqt5'
         else:
-            # give preference for PyQt4 for backward compatibility
-            try:
-                import PyQt4
-                PYQT_VER = '4'
-            except ImportError:
-                import PyQt5
-                PYQT_VER = '5'
-
-        USING_PYSIDE = False
-
-    if USING_PYSIDE:
-        def _import_module(module_name):
-            pyside = __import__('PySide', globals(), locals(), [module_name], 0)
-            return getattr(pyside, module_name)
-    
-        Signal = QtCore.Signal
-        Slot = QtCore.Slot
-        Property = QtCore.Property
+            msg = 'pytest-qt requires either PySide, PyQt4 or PyQt5 to be installed'
+            raise ImportError(msg)
+
+    # backward compatibility support: PYTEST_QT_FORCE_PYQT
+    if os.environ.get('PYTEST_QT_FORCE_PYQT', 'false') == 'true':
+        QT_API = 'pyqt4'
     else:
-        def _import_module(module_name):
-            pyside = __import__('PyQt%s' % PYQT_VER,
-                                globals(), locals(), [module_name], 0)
-            return getattr(pyside, module_name)
+        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()
 
-        QtCore = _import_module('QtCore')
-        Signal = QtCore.pyqtSignal
-        Slot = QtCore.pyqtSlot
-        Property = QtCore.pyqtProperty
-    
-    
+    # 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 not USING_PYSIDE and PYQT_VER == '5':
-        _QtWidgets = _import_module('QtWidgets')
-        QApplication = _QtWidgets.QApplication
-        QWidget = _QtWidgets.QWidget
-    else:
+
+    if QT_API == 'pyside':
+        Signal = QtCore.Signal
+        Slot = QtCore.Slot
+        Property = QtCore.Property
         QApplication = QtGui.QApplication
         QWidget = QtGui.QWidget
 
+    elif QT_API in ('pyqt4', 'pyqt5'):
+        Signal = QtCore.pyqtSignal
+        Slot = QtCore.pyqtSlot
+        Property = QtCore.pyqtProperty
+
+        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
 
@@ -104,3 +110,4 @@ def __getattr__(cls, name):
     QEvent = Mock()
     QApplication = Mock()
     QWidget = Mock()
+    QT_API = '<none>'