Rename QtShim to QtCompat

Author: mottosso

CAVEATS.md

@@ -258,11 +258,11 @@ Use compatibility wrapper.
 
 ```python
 # PySide2
->>> from Qt import QtWidgets, QtShim
+>>> from Qt import QtWidgets, QtCompat
 >>> app = QtWidgets.QApplication(sys.argv)
 >>> view = QtWidgets.QTreeWidget()
 >>> header = view.header()
->>> QtShim.setSectionResizeMode(header, QtWidgets.QHeaderView.Fixed)
+>>> QtCompat.setSectionResizeMode(header, QtWidgets.QHeaderView.Fixed)
 ```
 
 Or a conditional.

Qt.py

@@ -109,7 +109,7 @@ def _remap(object, name, value, safe=True):
 
 
 def _add(object, name, value):
-    """Append to self, accessible via Qt.QtShim"""
+    """Append to self, accessible via Qt.QtCompat"""
     self.__added__.append(name)
     setattr(self, name, value)
 
@@ -174,7 +174,7 @@ def _pyqt4():
         # QtWebkit is optional in Qt , therefore might not be available
         pass
 
-    _add(PyQt4, "QtShim", self)
+    _add(PyQt4, "QtCompat", self)
     _add(PyQt4, "__binding__", PyQt4.__name__)
     _add(PyQt4, "load_ui", lambda fname: uic.loadUi(fname))
     _add(PyQt4, "translate", lambda context, sourceText, disambiguation, n: (
@@ -349,7 +349,7 @@ def init():
         else:
             # Reference to this module
             binding.__shim__ = self
-            binding.QtShim = self
+            binding.QtCompat = self
 
             sys.modules.update({
                 __name__: binding,

README.md

@@ -81,7 +81,7 @@ app.exec_()
 
 ### Documentation
 
-All members of `Qt` stem directly from those available via PySide2, along with these additional members, accessible via `Qt.QtShim`.
+All members of `Qt` stem directly from those available via PySide2, along with these additional members, accessible via `Qt.QtCompat`.
 
 | Attribute               | Returns     | Description
 |:------------------------|:------------|:------------
@@ -103,8 +103,8 @@ All members of `Qt` stem directly from those available via PySide2, along with t
 **Example**
 
 ```python
->>> from Qt import QtShim
->>> QtShim.__binding__
+>>> from Qt import QtCompat
+>>> QtCompat.__binding__
 'PyQt5'
 ```
 
@@ -115,7 +115,7 @@ All members of `Qt` stem directly from those available via PySide2, along with t
 Some bindings offer features not available in others, you can use `__binding__` to capture those.
 
 ```python
-if "PySide" in QtShim.__binding__:
+if "PySide" in QtCompat.__binding__:
   do_pyside_stuff()
 ```
 
@@ -128,7 +128,7 @@ If your system has multiple choices where one or more is preferred, you can over
 ```bash
 $ set QT_PREFERRED_BINDING=PyQt5  # Windows
 $ export QT_PREFERRED_BINDING=PyQt5  # Unix/OSX
-$ python -c "from Qt import QtShim;print(QtShim.__binding__)"
+$ python -c "from Qt import QtCompat;print(QtCompat.__binding__)"
 PyQt5
 ```
 
@@ -169,10 +169,10 @@ The `uic.loadUi` function of PyQt4 and PyQt5 as well as the `QtUiTools.QUiLoader
 
 ```python
 import sys
-from Qt import QtShim
+from Qt import QtCompat
 
 app = QtWidgets.QApplication(sys.argv)
-ui = QtShim.load_ui(fname="my.ui")
+ui = QtCompat.load_ui(fname="my.ui")
 ui.show()
 app.exec_()
 ```
@@ -340,6 +340,30 @@ Send us a pull-request with your project here.
 
 ### Developer Guide
 
+Tests are performed on each aspect of the shim.
+
+- [Functional](tests.py)
+- [Caveats](build_caveats.py)
+- [Examples](examples)
+- [Membership](build_membership.py)
+
+Each of these are run under..
+
+- Python 2.7
+- Python 3.4
+
+..once for each binding or under a specific binding only.
+
+Tests that are written at module level are run four times - once per binding - whereas tests written under a specific if-statement are run only for this particular binding.
+
+```python
+if binding("PyQt4"):
+	def test_something_related_to_pyqt4():
+		pass
+```
+
+**Running tests**
+
 Due to the nature of multiple bindings and multiple interpreter support, setting up a development environment in which to properly test your contraptions can be challenging. So here is a guide for how to do just that using **Docker**.
 
 With Docker setup, here's what you do.

tests.py

@@ -219,15 +219,15 @@ def retranslateUi(self, uic):
     with open(fname, "w") as f:
         f.write(before)
 
-    from Qt import QtShim
+    from Qt import QtCompat
 
     os.chdir(self.tempdir)
-    QtShim.cli(args=["--convert", "idempotency.py"])
+    QtCompat.cli(args=["--convert", "idempotency.py"])
 
     with open(fname) as f:
         assert f.read() == after
 
-    QtShim.cli(args=["--convert", "idempotency.py"])
+    QtCompat.cli(args=["--convert", "idempotency.py"])
 
     with open(fname) as f:
         assert f.read() == after
@@ -240,10 +240,10 @@ def test_convert_backup():
     with open(fname, "w") as f:
         f.write("")
 
-    from Qt import QtShim
+    from Qt import QtCompat
 
     os.chdir(self.tempdir)
-    QtShim.cli(args=["--convert", "idempotency.py"])
+    QtCompat.cli(args=["--convert", "idempotency.py"])
 
     assert os.path.exists(
         os.path.join(self.tempdir, "%s_backup%s" % os.path.splitext(fname))
@@ -252,52 +252,52 @@ def test_convert_backup():
 
 def test_meta_add():
     """Qt._add() appends to __added__"""
-    from Qt import QtShim
+    from Qt import QtCompat
 
     module = imp.new_module("QtMock")
 
-    QtShim._add(module, "MyAttr", None)
+    QtCompat._add(module, "MyAttr", None)
 
-    assert "MyAttr" in QtShim.__added__, QtShim.__added__
-    assert "MyAttr" not in QtShim.__remapped__
-    assert "MyAttr" not in QtShim.__modified__
+    assert "MyAttr" in QtCompat.__added__, QtCompat.__added__
+    assert "MyAttr" not in QtCompat.__remapped__
+    assert "MyAttr" not in QtCompat.__modified__
 
 
 def test_meta_remap():
     """Qt._remap() appends to __modified__"""
-    from Qt import QtShim
+    from Qt import QtCompat
 
     module = imp.new_module("QtMock")
 
-    QtShim._remap(module, "MyAttr", None)
+    QtCompat._remap(module, "MyAttr", None)
 
-    assert "MyAttr" not in QtShim.__added__, QtShim.__added__
-    assert "MyAttr" in QtShim.__remapped__
-    assert "MyAttr" not in QtShim.__modified__
+    assert "MyAttr" not in QtCompat.__added__, QtCompat.__added__
+    assert "MyAttr" in QtCompat.__remapped__
+    assert "MyAttr" not in QtCompat.__modified__
 
 
 def test_meta_remap_existing():
     """Qt._remap() of existing member throws an exception"""
-    from Qt import QtShim
+    from Qt import QtCompat
 
     module = imp.new_module("QtMock")
     module.MyAttr = None
 
-    assert_raises(AttributeError, QtShim._remap, module, "MyAttr", None)
+    assert_raises(AttributeError, QtCompat._remap, module, "MyAttr", None)
 
 
 def test_meta_force_remap_existing():
     """Unsafe Qt._remap() of existing member adds to modified"""
-    from Qt import QtShim
+    from Qt import QtCompat
 
     module = imp.new_module("QtMock")
     module.MyAttr = 123
 
-    QtShim._remap(module, "MyAttr", None, safe=False)
+    QtCompat._remap(module, "MyAttr", None, safe=False)
 
-    assert "MyAttr" in QtShim.__remapped__, QtShim.__remapped__
-    assert "MyAttr" not in QtShim.__added__
-    assert "MyAttr" in QtShim.__modified__
+    assert "MyAttr" in QtCompat.__remapped__, QtCompat.__remapped__
+    assert "MyAttr" not in QtCompat.__added__
+    assert "MyAttr" in QtCompat.__modified__
     assert module.MyAttr is None, module.MyAttr