WIP: remove the windows only QtAxContainer module

Author: MHendricks

CAVEATS.md

@@ -437,18 +437,47 @@ unable to automatically fix your code but shows you possible code that you will
 need to manually fix.
 
 
-#### QtCore.QWinEventNotifier
+#### Platform specific members
 
-This class is only available on Windows, for now we are not exposing it in Qt.py.
+There are several platform specific Qt members that could be exposed by Qt.py.
+Qt.py is targeted at exposing members common across all supported Qt versions
+and platforms, so we are not including them by default.
+
+- `QtCore.QWinEventNotifier`
+- `QtAxContainer.QAxBase` Available as `QAxContainer` in PyQt5/6.
+- `QtAxContainer.QAxObject` Available as `QAxContainer` in PyQt5/6.
+- `QtAxContainer.QAxWidget` Available as `QAxContainer` in PyQt5/6.
 
 
 ##### Workaround
 
-This can be added to Qt.py using QtSiteConfig.
+They can be added to Qt.py using QtSiteConfig.
 
 
 ```python
+import sys
+
+
 def update_members(members):
-    # Add the windows only `QWinEventNotifier`
-    members["QtCore"].append("QsciAPIs")
+    # Add windows only `QWinEventNotifier` class
+    if sys.platform == "win32":
+        members["QtCore"].append("QWinEventNotifier")
+
+        # Add the windows only QtAxContainer class
+        members["QtAxContainer"] = [
+            "QAxBase"
+            "QAxObject"
+            "QAxWidget"
+        ]
+
+def update_misplaced_members(members):
+    if sys.platform != "win32":
+        return
+
+    # Correctly map the Windows only QtAxContainer misplaced in PyQtX.
+    for binding in ("PyQt6", "PyQt5"):
+        members[binding].setdefault("__misplaced__", []).append("QAxContainer")
+        members[binding]["QAxContainer.QAxBase"] = "QtAxContainer.QAxBase"
+        members[binding]["QAxContainer.QAxObject"] = "QtAxContainer.QAxObject"
+        members[binding]["QAxContainer.QAxWidget"] = "QtAxContainer.QAxWidget"
 ```

membership.py

@@ -13,11 +13,16 @@
 SKIP_MODULES = [
     'PyQt5.Qt',  # This module only exists in PyQt5 and is not exposed by Qt.py
     'PyQt5.uic.pyuic',  # Problematic as it is executed on import
-    'QtCore.QWinEventNotifier',  # This class is only available on Windows.
+    # These modules are only available on windows
+    "PyQt5.QAxContainer",
+    "PyQt6.QAxContainer",
+    "PySide2.QtAxContainer",
+    "PySide6.QtAxContainer",
 ]
 SKIP_MEMBERS = [
-    'qApp',  # See main README.md on qApp
     "QIntList",  # Missing from Qt5 or PyQt6, but present in ~50 modules
+    'qApp',  # See main README.md on qApp
+    'QWinEventNotifier',  # This class is only available on Windows.
 ]
 
 # Will contain all modules for the current binding
@@ -33,7 +38,7 @@
 # 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",
+    # "QtAxContainer",
     "QtOpenGL",
 ]
 
@@ -151,7 +156,7 @@ def compare(dicts):
 def membership_table(binding_maps):
     rows = {}
     headers = (
-        ["Module", "Class"] + list(binding_maps.keys()) + ["Potentially Misplaced"]
+        ["Module", "Class"] + sorted(binding_maps.keys()) + ["Potentially Misplaced"]
     )
     columns = len(binding_maps) + 1
     cls_modules = {}

src/Qt.py

@@ -84,7 +84,7 @@
 """
 
 _common_members = {
-    "QtAxContainer": [],
+    # "QtAxContainer": [],
     "QtCore": [
         "QAbstractAnimation",
         "QAbstractEventDispatcher",
@@ -1406,9 +1406,9 @@ def wrapper(self, descrip):
 """
 _misplaced_members = {
     "PySide6": {
-        "QtAxContainer.QAxBase": "QtAxContainer.QAxBase",
-        "QtAxContainer.QAxObject": "QtAxContainer.QAxObject",
-        "QtAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
+        # "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],
@@ -1449,10 +1449,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",
+        # "__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",
@@ -1494,9 +1494,9 @@ def wrapper(self, descrip):
     },
     "PySide2": {
         "__misplaced__": ["QtOpenGLFunctions"],
-        "QtAxContainer.QAxBase": "QtAxContainer.QAxBase",
-        "QtAxContainer.QAxObject": "QtAxContainer.QAxObject",
-        "QtAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
+        # "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],
@@ -1540,14 +1540,14 @@ def wrapper(self, descrip):
             "_QOpenGLFunctions_2_0",
             "_QOpenGLFunctions_2_1",
             "_QOpenGLFunctions_4_1_Core",
-            "QAxContainer",
+            # "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",
+        # "QAxContainer.QAxBase": "QtAxContainer.QAxBase",
+        # "QAxContainer.QAxObject": "QtAxContainer.QAxObject",
+        # "QAxContainer.QAxWidget": "QtAxContainer.QAxWidget",
         "QtCore.pyqtProperty": "QtCore.Property",
         "QtCore.pyqtSignal": "QtCore.Signal",
         "QtCore.pyqtSlot": "QtCore.Slot",

tests.py

@@ -1232,8 +1232,9 @@ def test__misplaced__():
     """
     import Qt
 
-    assert Qt.QtAxContainer.QAxBase
-    assert Qt.QtAxContainer.QAxWidget
+    # NOTE: Windows only
+    # assert Qt.QtAxContainer.QAxBase
+    # assert Qt.QtAxContainer.QAxWidget
     assert Qt.QtOpenGL.QAbstractOpenGLFunctions
     assert Qt.QtOpenGL.QOpenGLBuffer
     assert Qt.QtOpenGL.QOpenGLFunctions_2_0
@@ -1248,7 +1249,8 @@ def test__misplaced__none():
         os.environ["QT_PREFERRED_BINDING"] = "None"
         import Qt
 
-        assert Qt.QtAxContainer
+        # NOTE: Windows only
+        # assert Qt.QtAxContainer
         assert Qt.QtOpenGL
     finally:
         os.environ["QT_PREFERRED_BINDING"] = current