Add QtSiteConfig example adding windows specific QtAxContainer

This shows how to use QtSiteConfig to add this module as well as modifying
the new `__extras__` misplaced member feature.

Author: MHendricks

examples/QtSiteConfig_platforms/QtSiteConfig.py

@@ -0,0 +1,28 @@
+import sys
+
+
+IS_WIN = sys.platform == "win32"
+
+
+def update_members(members):
+    # Add windows only `QWinEventNotifier` class
+    if IS_WIN:
+        members["QtCore"].append("QWinEventNotifier")
+
+        # Add the windows only QtAxContainer class. The PySideX bindings use
+        # the QtAxContainer module name, so we can just add them here
+        members["QtAxContainer"] = ["QAxBase", "QAxObject", "QAxWidget"]
+
+
+def update_misplaced_members(members):
+    if IS_WIN:
+        # Correctly map the Windows only QtAxContainer misplaced in PyQtX.
+        # PySide6/2 uses the QtAxContainer module name, rename PyQt's module.
+        for bnd in ("PyQt6", "PyQt5"):
+            # We have to add "QAxContainer" to __extras__ so it's imported
+            # by Qt.py and available for misplaced_members to access
+            members[bnd].setdefault("__extras__", []).append("QAxContainer")
+            # Add each individual misplaced member mapping to add to Qt.py
+            members[bnd]["QAxContainer.QAxBase"] = "QtAxContainer.QAxBase"
+            members[bnd]["QAxContainer.QAxObject"] = "QtAxContainer.QAxObject"
+            members[bnd]["QAxContainer.QAxWidget"] = "QtAxContainer.QAxWidget"

examples/QtSiteConfig_platforms/README.md

@@ -0,0 +1,21 @@
+## `QtSiteConfig_platforms` example
+
+This example illustrates how to use QtSiteConfig to give access to platform specific Qt members.
+
+**Usage**
+
+```bash
+$ cd to/this/directory
+$ python main.py
+# Qt.QtCore was successfully removed by QSiteConfig.py
+```
+
+Because `QtSiteConfig.py` is in the current working directory, it is available to import by Python. If running from a different directory, then you can append this directory to your `PYTHONPATH`
+
+```bash
+$ set PYTHONPATH=path/to/QtSiteConfig/
+$ python main.py
+# Qt.QtCore was successfully removed by QSiteConfig.py
+```
+
+> Linux and MacOS users: Replace `set` with `export`

examples/QtSiteConfig_platforms/main.py

@@ -0,0 +1,56 @@
+"""Example of QtSiteConfig module used to modify exposed members of Qt.py"""
+
+import os
+import sys
+
+IS_WIN = sys.platform == "win32"
+print(f'Platform {"is" if IS_WIN else "is not"} windows: "{sys.platform}"')
+
+
+def test():
+    """QtCore is taken out of Qt.py via QtSiteConfig.py"""
+
+    # Expose this directory, and therefore QtSiteConfig, to Python
+    sys.path.insert(0, os.path.dirname(__file__))
+
+    try:
+        from Qt.QtCore import QWinEventNotifier  # noqa: F401
+    except ImportError:
+        if IS_WIN:
+            raise ImportError(
+                "Qt.QtCore.QWinEventNotifier is not importable on windows"
+                "update_members was not applied correctly."
+            )
+        else:
+            print(
+                "Qt.QtCore.QWinEventNotifier was not added on this "
+                "non-windows platform"
+            )
+    else:
+        if IS_WIN:
+            print(
+                "Qt.QtCore.QWinEventNotifier was added on windows via "
+                "QtSiteConfig.py"
+            )
+        else:
+            raise ImportError(
+                "Qt.QtCore.QWinEventNotifier was importable, on this "
+                "non-windows platform. This should be impossible."
+            )
+
+    # Test _misplaced_members is applied correctly
+    import Qt
+
+    assert not hasattr(Qt, "QAxContainer")
+    if IS_WIN:
+        assert Qt.QtAxContainer
+        assert Qt.QtAxContainer.QAxBase
+        assert Qt.QtAxContainer.QAxWidget
+        print("Qt.QtAxContainer and members were added on windows.")
+    else:
+        assert not hasattr(Qt, "QtAxContainer")
+        print("Qt.QtAxContainer and members was not added on non-windows.")
+
+
+if __name__ == "__main__":
+    test()

tox.ini

@@ -179,3 +179,4 @@ commands =
     # Testing examples..
     examples: python -m nose2 --verbose examples.loadUi.baseinstance1
     examples: python -m nose2 --verbose examples.QtSiteConfig.main
+    examples: python -m nose2 --verbose examples.QtSiteConfig_platforms.main