Mocking PySide and PyQt4 when building docs at readthedocs

Author: nicoddemus

src/pytestqt/qt_compat.py

@@ -6,49 +6,75 @@
 
 from __future__ import with_statement
 from __future__ import division
+import os
 
-_TRY_PYSIDE = True
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-try:
-    if not _TRY_PYSIDE:
-        raise ImportError()
-    import PySide.QtCore as _QtCore
-    QtCore = _QtCore
-    USES_PYSIDE = True
-except ImportError:
-    import sip
-    sip.setapi('QString', 2)
-    sip.setapi('QVariant', 2)
-    import PyQt4.QtCore as _QtCore
-    QtCore = _QtCore
-    USES_PYSIDE = False
-
-
-def _pyside_import_module(moduleName):
-    pyside = __import__('PySide', globals(), locals(), [moduleName], -1)
-    return getattr(pyside, moduleName)
-
-
-def _pyqt4_import_module(moduleName):
-    pyside = __import__('PyQt4', globals(), locals(), [moduleName], -1)
-    return getattr(pyside, moduleName)
-
-
-if USES_PYSIDE:
-    import_module = _pyside_import_module
-
-    Signal = QtCore.Signal
-    Slot = QtCore.Slot
-    Property = QtCore.Property
+if not on_rtd:
+    try:
+        import PySide.QtCore as _QtCore
+        QtCore = _QtCore
+        USES_PYSIDE = True
+    except ImportError:
+        import sip
+        sip.setapi('QString', 2)
+        sip.setapi('QVariant', 2)
+        import PyQt4.QtCore as _QtCore
+        QtCore = _QtCore
+        USES_PYSIDE = False
+    
+    
+    def _pyside_import_module(moduleName):
+        pyside = __import__('PySide', globals(), locals(), [moduleName], -1)
+        return getattr(pyside, moduleName)
+    
+    
+    def _pyqt4_import_module(moduleName):
+        pyside = __import__('PyQt4', globals(), locals(), [moduleName], -1)
+        return getattr(pyside, moduleName)
+    
+    
+    if USES_PYSIDE:
+        import_module = _pyside_import_module
+    
+        Signal = QtCore.Signal
+        Slot = QtCore.Slot
+        Property = QtCore.Property
+    else:
+        import_module = _pyqt4_import_module
+    
+        Signal = QtCore.pyqtSignal
+        Slot = QtCore.pyqtSlot
+        Property = QtCore.pyqtProperty
+    
+    
+    QtGui = import_module('QtGui')
+    QtTest = import_module('QtTest')
+    Qt = QtCore.Qt
+    QEvent = QtCore.QEvent
+    
 else:
-    import_module = _pyqt4_import_module
-
-    Signal = QtCore.pyqtSignal
-    Slot = QtCore.pyqtSlot
-    Property = QtCore.pyqtProperty
-
+    # mock Qt when we are generating documentation at readthedocs.org
 
-QtGui = import_module('QtGui')
-QtTest = import_module('QtTest')
-Qt = QtCore.Qt
-QEvent = QtCore.QEvent
+    class Mock(object):
+        def __init__(self, *args, **kwargs):
+            pass
+    
+        def __call__(self, *args, **kwargs):
+            return Mock()
+    
+        @classmethod
+        def __getattr__(cls, name):
+            if name in ('__file__', '__path__'):
+                return '/dev/null'
+            elif name[0] == name[0].upper():
+                mockType = type(name, (), {})
+                mockType.__module__ = __name__
+                return mockType
+            else:
+                return Mock()
+    
+    QtGui = Mock()
+    QtTest = Mock()
+    Qt = Mock()
+    QEvent = Mock()