Add support for misplaced members with no "common" modules

Adds support for adding `Qt.QtOpenGl` and other modules. These modules
don't actually have any common members because the different bindings used
unique module names. For example in Qt6 all QtOpenGL functions are stored
under QtOpenGL, but in PySide2 they are stored under QtGui and QtOpenGLFunctions,
and PyQt5 is ... complex.

Author: MHendricks

membership.py

@@ -30,6 +30,13 @@
 BINDING_NAMES_QT5 = ["PySide2", "PyQt5"]
 BINDING_NAMES_QT6 = ["PySide6", "PyQt6"]
 
+# Include these module names in common modules even if they have no common
+# members. They will be assigned using the misplaced members.
+MISPLACED_MODULES = [
+    "QtAxContainer",
+    "QtOpenGL",
+]
+
 
 def read_json(filename):
     """Read JSON, return dict"""
@@ -132,6 +139,12 @@ def compare(dicts):
         if members:
             common_members[k] = members
 
+    # Add empty misplaced modules. These are where we will add misplaced members
+    # for modules that are not common
+    for module in MISPLACED_MODULES:
+        if module not in common_members:
+            common_members[module] = []
+
     return ret
 
 

src/Qt.py

@@ -77,9 +77,14 @@
 file created by the membership tox environments. See _common_members_sources
 for a list of the python and qt bindings used to generate this list.
 
+Note: Some members like QtOpenGL may contain empty lists. These are targets for
+assigning misplaced members according to the reference binding(PySide6). We
+will need to add them to all bindings including None, so we add them here.
+
 """
 
 _common_members = {
+    "QtAxContainer": [],
     "QtCore": [
         "QAbstractAnimation",
         "QAbstractEventDispatcher",
@@ -475,6 +480,7 @@
         "QTcpSocket",
         "QUdpSocket"
     ],
+    "QtOpenGL": [],
     "QtPositioning": [
         "QGeoAddress",
         "QGeoAreaMonitorInfo",
@@ -1380,9 +1386,15 @@ def wrapper(self, descrip):
     }
 }
 
+The __misplaced__ key contains any modules that need to be imported to handle
+misplaced members. They are not _common_members but need treated the same way.
+
 """
 _misplaced_members = {
     "PySide6": {
+        "QtAxContainer.QAxBase": "QtAxContainer.QAxBase",
+        "QtAxContainer.QAxObject": "QtAxContainer.QAxObject",
+        "QtAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
         "QtCore.Property": "QtCore.Property",
         "QtCore.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
         "QtCore.QCoreApplication.translate": ["QtCompat.translate", _translate],
@@ -1405,6 +1417,11 @@ def wrapper(self, descrip):
         "QtGui.QUndoCommand": "QtWidgets.QUndoCommand",
         "QtGui.QUndoGroup": "QtWidgets.QUndoGroup",
         "QtGui.QUndoStack": "QtWidgets.QUndoStack",
+        "QtOpenGL.QAbstractOpenGLFunctions": "QtOpenGL.QAbstractOpenGLFunctions",
+        "QtOpenGL.QOpenGLBuffer": "QtOpenGL.QOpenGLBuffer",
+        "QtOpenGL.QOpenGLFunctions_2_0": "QtOpenGL.QOpenGLFunctions_2_0",
+        "QtOpenGL.QOpenGLFunctions_2_1": "QtOpenGL.QOpenGLFunctions_2_1",
+        "QtOpenGL.QOpenGLFunctions_4_1_Core": "QtOpenGL.QOpenGLFunctions_4_1_Core",
         "QtStateMachine.QState": "QtCore.QState",
         "QtStateMachine.QStateMachine": "QtCore.QStateMachine",
         "QtSvgWidgets.QGraphicsSvgItem": "QtSvg.QGraphicsSvgItem",
@@ -1418,6 +1435,10 @@ def wrapper(self, descrip):
         "shiboken6.wrapInstance": ["QtCompat.wrapInstance", _wrapinstance],
     },
     "PyQt6": {
+        "__misplaced__": ["QAxContainer"],
+        "QAxContainer.QAxBase": "QtAxContainer.QAxBase",
+        "QAxContainer.QAxObject": "QtAxContainer.QAxObject",
+        "QAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
         "QtCore.pyqtProperty": "QtCore.Property",
         "QtCore.pyqtSignal": "QtCore.Signal",
         "QtCore.pyqtSlot": "QtCore.Slot",
@@ -1440,6 +1461,11 @@ def wrapper(self, descrip):
         "QtGui.QUndoCommand": "QtWidgets.QUndoCommand",
         "QtGui.QUndoGroup": "QtWidgets.QUndoGroup",
         "QtGui.QUndoStack": "QtWidgets.QUndoStack",
+        "QtOpenGL.QAbstractOpenGLFunctions": "QtOpenGL.QAbstractOpenGLFunctions",
+        "QtOpenGL.QOpenGLBuffer": "QtOpenGL.QOpenGLBuffer",
+        "QtOpenGL.QOpenGLFunctions_2_0": "QtOpenGL.QOpenGLFunctions_2_0",
+        "QtOpenGL.QOpenGLFunctions_2_1": "QtOpenGL.QOpenGLFunctions_2_1",
+        "QtOpenGL.QOpenGLFunctions_4_1_Core": "QtOpenGL.QOpenGLFunctions_4_1_Core",
         "QtStateMachine.QState": "QtCore.QState",
         "QtStateMachine.QStateMachine": "QtCore.QStateMachine",
         "QtSvgWidgets.QGraphicsSvgItem": "QtSvg.QGraphicsSvgItem",
@@ -1453,6 +1479,10 @@ def wrapper(self, descrip):
         "uic.loadUi": ["QtCompat.loadUi", _loadUi],
     },
     "PySide2": {
+        "__misplaced__": ["QtOpenGLFunctions"],
+        "QtAxContainer.QAxBase": "QtAxContainer.QAxBase",
+        "QtAxContainer.QAxObject": "QtAxContainer.QAxObject",
+        "QtAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
         "QtCore.Property": "QtCore.Property",
         "QtCore.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
         "QtCore.QCoreApplication.translate": ["QtCompat.translate", _translate],
@@ -1467,9 +1497,14 @@ def wrapper(self, descrip):
         "QtCore.QStringListModel": "QtCore.QStringListModel",
         "QtCore.Signal": "QtCore.Signal",
         "QtCore.Slot": "QtCore.Slot",
+        "QtGui.QAbstractOpenGLFunctions": "QtOpenGL.QAbstractOpenGLFunctions",
+        "QtGui.QOpenGLBuffer": "QtOpenGL.QOpenGLBuffer",
         "QtGui.QRegExpValidator": "QtGui.QRegExpValidator",
         # Older versions of PySide2 still left this in QtGui, this accounts for those too
         "QtGui.QStringListModel": "QtCore.QStringListModel",
+        "QtOpenGLFunctions.QOpenGLFunctions_2_0": "QtOpenGL.QOpenGLFunctions_2_0",
+        "QtOpenGLFunctions.QOpenGLFunctions_2_1": "QtOpenGL.QOpenGLFunctions_2_1",
+        "QtOpenGLFunctions.QOpenGLFunctions_4_1_Core": "QtOpenGL.QOpenGLFunctions_4_1_Core",
         "QtSvg.QGraphicsSvgItem": "QtSvg.QGraphicsSvgItem",
         "QtSvg.QSvgWidget": "QtSvg.QSvgWidget",
         "QtUiTools.QUiLoader": ["QtCompat.loadUi", _loadUi],
@@ -1487,6 +1522,18 @@ def wrapper(self, descrip):
         "shiboken2.wrapInstance": ["QtCompat.wrapInstance", _wrapinstance],
     },
     "PyQt5": {
+        "__misplaced__": [
+            "_QOpenGLFunctions_2_0",
+            "_QOpenGLFunctions_2_1",
+            "_QOpenGLFunctions_4_1_Core",
+            "QAxContainer",
+        ],
+        "_QOpenGLFunctions_2_0.QOpenGLFunctions_2_0": "QtOpenGL.QOpenGLFunctions_2_0",
+        "_QOpenGLFunctions_2_1.QOpenGLFunctions_2_1": "QtOpenGL.QOpenGLFunctions_2_1",
+        "_QOpenGLFunctions_4_1_Core.QOpenGLFunctions_4_1_Core": "QtOpenGL.QOpenGLFunctions_4_1_Core",
+        "QAxContainer.QAxBase": "QtAxContainer.QAxBase",
+        "QAxContainer.QAxObject": "QtAxContainer.QAxObject",
+        "QAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
         "QtCore.pyqtProperty": "QtCore.Property",
         "QtCore.pyqtSignal": "QtCore.Signal",
         "QtCore.pyqtSlot": "QtCore.Slot",
@@ -1501,6 +1548,8 @@ def wrapper(self, descrip):
         "QtCore.QRegExp": "QtCore.QRegExp",
         "QtCore.QSortFilterProxyModel": "QtCore.QSortFilterProxyModel",
         "QtCore.QStringListModel": "QtCore.QStringListModel",
+        "QtGui.QAbstractOpenGLFunctions": "QtOpenGL.QAbstractOpenGLFunctions",
+        "QtGui.QOpenGLBuffer": "QtOpenGL.QOpenGLBuffer",
         "QtGui.QRegExpValidator": "QtGui.QRegExpValidator",
         "QtSvg.QGraphicsSvgItem": "QtSvg.QGraphicsSvgItem",
         "QtSvg.QSvgWidget": "QtSvg.QSvgWidget",
@@ -1713,7 +1762,11 @@ def _warn_import_error(exc, module):
             return
         _warn("ImportError(%s): %s" % (module, msg))
 
-    for name in list(_common_members) + extras:
+    # Process the __misplaced__ modules as if they were common
+    misplaced = _misplaced_members.get(Qt.__binding__, {})
+    misplaced = misplaced.get("__misplaced__", [])
+
+    for name in list(_common_members) + extras + misplaced:
         try:
             submodule = _import_sub_module(
                 module, name)
@@ -1745,6 +1798,9 @@ def _reassign_misplaced_members(binding):
     """
 
     for src, dsts in _misplaced_members[binding].items():
+        if src == "__misplaced__":
+            # Don't process this key here.
+            continue
         # Normalize dsts to a list of potentially multiple misplaced members
         if isinstance(dsts, str):
             # A single string is treated as a single item lists

tests.py

@@ -1224,6 +1224,36 @@ def test_mutliple_misplaced():
     assert Qt.QtGui.QAction == Qt.QtWidgets.QAction
 
 
+def test__misplaced__():
+    """Spot check binding specific imports for missing members.
+
+    This should check at least one import for each common member that requires
+    being added to any bindings `__misplaced__` list.
+    """
+    import Qt
+
+    assert Qt.QtAxContainer.QAxBase
+    assert Qt.QtAxContainer.QAxWidget
+    assert Qt.QtOpenGL.QAbstractOpenGLFunctions
+    assert Qt.QtOpenGL.QOpenGLBuffer
+    assert Qt.QtOpenGL.QOpenGLFunctions_2_0
+    assert Qt.QtOpenGL.QOpenGLFunctions_2_1
+
+
+def test__misplaced__none():
+    """Preferring None should add the __misplaced__ modules"""
+
+    current = os.environ["QT_PREFERRED_BINDING"]
+    try:
+        os.environ["QT_PREFERRED_BINDING"] = "None"
+        import Qt
+
+        assert Qt.QtAxContainer
+        assert Qt.QtOpenGL
+    finally:
+        os.environ["QT_PREFERRED_BINDING"] = current
+
+
 def test_missing():
     """Missing members of Qt.py have been defined with placeholders"""
     import Qt