testing QTest methods are available in qtbot

Author: nicoddemus

pytestqt/_tests/test_qtest_proxies.py

@@ -0,0 +1,31 @@
+import pytest
+
+from pytestqt.qt_compat import USING_PYSIDE
+
+
+fails_on_pyqt = pytest.mark.xfail(USING_PYSIDE, reason='not exported by PyQt')
+
+
+@pytest.mark.parametrize('expected_method', [
+    'keyPress',
+    'keyClick',
+    'keyClicks',
+    'keyEvent',
+    'keyPress',
+    'keyRelease',
+    fails_on_pyqt('keyToAscii'),
+
+    'mouseClick',
+    'mouseDClick',
+    'mouseEvent',
+    'mouseMove',
+    'mousePress',
+    'mouseRelease',
+],
+)
+def test_expected_qtest_proxies(qtbot, expected_method):
+    """
+    Ensure that we are exporting expected QTest API methods.
+    """
+    hasattr(qtbot, expected_method)
+    assert getattr(qtbot, expected_method).__name__ == expected_method

pytestqt/plugin.py

@@ -16,13 +16,16 @@ def _inject_qtest_methods(cls):
 
     def create_qtest_proxy_method(method_name):
 
-        qtest_method = getattr(QtTest.QTest, method_name)
+        if hasattr(QtTest.QTest, method_name):
+            qtest_method = getattr(QtTest.QTest, method_name)
 
-        def result(*args, **kwargs):
-            return qtest_method(*args, **kwargs)
+            def result(*args, **kwargs):
+                return qtest_method(*args, **kwargs)
 
-        functools.update_wrapper(result, qtest_method)
-        return staticmethod(result)
+            functools.update_wrapper(result, qtest_method)
+            return staticmethod(result)
+        else:
+            return None
 
     # inject methods from QTest into QtBot
     method_names = [
@@ -43,7 +46,8 @@ def result(*args, **kwargs):
     ]
     for method_name in method_names:
         method = create_qtest_proxy_method(method_name)
-        setattr(cls, method_name, method)
+        if method is not None:
+            setattr(cls, method_name, method)
 
     return cls
 
@@ -113,7 +117,9 @@ class QtBot(object):
         :param Qt.Key_* key: one of the constants for keys in the Qt namespace.
         
         :return type: str 
-        :returns: the equivalent character string. 
+        :returns: the equivalent character string.
+
+        .. note:: this method is not available in PyQt.
     
     ---
     
@@ -149,7 +155,7 @@ class QtBot(object):
         :param int delay: after the event, delay the test for this miliseconds (if > 0).
             
     
-    .. _QTest API: http://doc.qt.digia.com/4.7/qtest.html
+    .. _QTest API: http://doc.qt.digia.com/4.8/qtest.html
     
     """
 

pytestqt/qt_compat.py

@@ -14,24 +14,24 @@
     try:
         import PySide.QtCore as _QtCore
         QtCore = _QtCore
-        USE_PYSIDE = True
+        USING_PYSIDE = True
     except ImportError:
-        USE_PYSIDE = False
+        USING_PYSIDE = False
 
     FORCE_PYQT = os.environ.get('PYTEST_QT_FORCE_PYQT', 'false') == 'true'
-    if not USE_PYSIDE or FORCE_PYQT:
+    if not USING_PYSIDE or FORCE_PYQT:
         try:
             import sip
         except ImportError:
             msg = 'pytest-qt requires either PyQt4 or PySide to be installed'
             raise ImportError(msg)
-        USE_PYSIDE = False
+        USING_PYSIDE = False
         sip.setapi('QString', 2)
         sip.setapi('QVariant', 2)
         import PyQt4.QtCore as _QtCore
         QtCore = _QtCore
 
-    if USE_PYSIDE:
+    if USING_PYSIDE:
         def _import_module(moduleName):
             pyside = __import__('PySide', globals(), locals(), [moduleName], 0)
             return getattr(pyside, moduleName)
@@ -55,8 +55,9 @@ def _import_module(moduleName):
     QEvent = QtCore.QEvent
 
 else:
-    # mock Qt when we are generating documentation at readthedocs.org
+    USING_PYSIDE = True
 
+    # mock Qt when we are generating documentation at readthedocs.org
     class Mock(object):
         def __init__(self, *args, **kwargs):
             pass