Merge pull request #268 from blurstudio/QtPrintSupport

Misplaced members can't create Qt sub-modules

Author: MHendricks

Qt.py

@@ -43,7 +43,7 @@
 import shutil
 
 
-__version__ = "1.1.0.b10"
+__version__ = "1.1.0.b11"
 
 # Enable support for `from Qt import *`
 __all__ = []
@@ -394,6 +394,16 @@
         "QGLFormat",
         "QGLWidget"
     ],
+    "QtPrintSupport": [
+        "QAbstractPrintDialog",
+        "QPageSetupDialog",
+        "QPrintDialog",
+        "QPrintEngine",
+        "QPrintPreviewDialog",
+        "QPrintPreviewWidget",
+        "QPrinter",
+        "QPrinterInfo"
+    ],
     "QtSql": [
         "QSql",
         "QSqlDatabase",
@@ -706,6 +716,14 @@
         "QtCore.Signal": "QtCore.Signal",
         "QtCore.Slot": "QtCore.Slot",
         "QtGui.QItemSelectionRange": "QtCore.QItemSelectionRange",
+        "QtGui.QAbstractPrintDialog": "QtPrintSupport.QAbstractPrintDialog",
+        "QtGui.QPageSetupDialog": "QtPrintSupport.QPageSetupDialog",
+        "QtGui.QPrintDialog": "QtPrintSupport.QPrintDialog",
+        "QtGui.QPrintEngine": "QtPrintSupport.QPrintEngine",
+        "QtGui.QPrintPreviewDialog": "QtPrintSupport.QPrintPreviewDialog",
+        "QtGui.QPrintPreviewWidget": "QtPrintSupport.QPrintPreviewWidget",
+        "QtGui.QPrinter": "QtPrintSupport.QPrinter",
+        "QtGui.QPrinterInfo": "QtPrintSupport.QPrinterInfo",
     },
     "PyQt4": {
         "QtGui.QAbstractProxyModel": "QtCore.QAbstractProxyModel",
@@ -717,6 +735,14 @@
         "QtCore.pyqtSignal": "QtCore.Signal",
         "QtCore.pyqtSlot": "QtCore.Slot",
         "QtGui.QItemSelectionRange": "QtCore.QItemSelectionRange",
+        "QtGui.QAbstractPrintDialog": "QtPrintSupport.QAbstractPrintDialog",
+        "QtGui.QPageSetupDialog": "QtPrintSupport.QPageSetupDialog",
+        "QtGui.QPrintDialog": "QtPrintSupport.QPrintDialog",
+        "QtGui.QPrintEngine": "QtPrintSupport.QPrintEngine",
+        "QtGui.QPrintPreviewDialog": "QtPrintSupport.QPrintPreviewDialog",
+        "QtGui.QPrintPreviewWidget": "QtPrintSupport.QPrintPreviewWidget",
+        "QtGui.QPrinter": "QtPrintSupport.QPrinter",
+        "QtGui.QPrinterInfo": "QtPrintSupport.QPrinterInfo",
     }
 }
 
@@ -910,16 +936,34 @@ def _reassign_misplaced_members(binding):
         src_module, src_member = src.split(".")
         dst_module, dst_member = dst.split(".")
 
+        # Get the member we want to store in the namesapce.
         try:
-            src_object = getattr(Qt, dst_module)
+            dst_value = getattr(getattr(Qt, "_" + src_module), src_member)
         except AttributeError:
-            # Skip reassignment of non-existing members.
-            # This can happen if a request was made to
-            # rename a member that didn't exist, for example
+            # If the member we want to store in the namespace does not exist,
+            # there is no need to continue. This can happen if a request was
+            # made to rename a member that didn't exist, for example
             # if QtWidgets isn't available on the target platform.
+            _log("Misplaced member has no source: {}".format(src))
             continue
 
-        dst_value = getattr(getattr(Qt, "_" + src_module), src_member)
+        try:
+            src_object = getattr(Qt, dst_module)
+        except AttributeError:
+            if dst_module not in _common_members:
+                # Only create the Qt parent module if its listed in
+                # _common_members. Without this check, if you remove QtCore
+                # from _common_members, the default _misplaced_members will add
+                # Qt.QtCore so it can add Signal, Slot, etc.
+                msg = 'Not creating missing member module "{m}" for "{c}"'
+                _log(msg.format(m=dst_module, c=dst_member))
+                continue
+            # If the dst is valid but the Qt parent module does not exist
+            # then go ahead and create a new module to contain the member.
+            setattr(Qt, dst_module, _new_module(dst_module))
+            src_object = getattr(Qt, dst_module)
+            # Enable direct import of the new module
+            sys.modules[__name__ + "." + dst_module] = src_object
 
         setattr(
             src_object,

examples/QtSiteConfig/QtSiteConfig.py

@@ -8,7 +8,6 @@ def update_members(members):
     Arguments:
         members (dict): The members considered by Qt.py
     """
-
     # Contrived example used for unit testing. This makes the QtCore module
     # not accessible. I chose this so it can be tested everywhere, for a
     # more realistic example see the README
@@ -22,6 +21,7 @@ def update_misplaced_members(members):
     Arguments:
         members (dict): The members considered by Qt.py
     """
+    # Create Qt.QtGui.QColorTest that points to Qtgui.QColor for unit testing.
     members["PySide2"]["QtGui.QColor"] = "QtGui.QColorTest"
     members["PyQt5"]["QtGui.QColor"] = "QtGui.QColorTest"
     members["PySide"]["QtGui.QColor"] = "QtGui.QColorTest"
@@ -83,7 +83,9 @@ def wrapper(*args, **kwargs):
         wrapper.__doc__ = some_function.__doc__
         wrapper.__name__ = some_function.__name__
         return wrapper
-    decorators.setdefault("QWidget", {})["windowTitleDecorator"] = \
+    decorators.setdefault("QWidget", {})["windowTitleDecorator"] = (
         _widgetDecorator
-    decorators.setdefault("QMainWindow", {})["windowTitleDecorator"] = \
+    )
+    decorators.setdefault("QMainWindow", {})["windowTitleDecorator"] = (
         _mainWindowDecorator
+    )

examples/QtSiteConfig/main.py

@@ -27,8 +27,9 @@ def test():
 
     # Test _misplaced_members is applied correctly
     from Qt import QtGui
-    assert QtGui.QColorTest == QtGui.QColor, \
+    assert QtGui.QColorTest == QtGui.QColor, (
         "QtGui.QColor was not mapped to QtGui.QColorTest"
+    )
 
     # Test _compatibility_members is applied correctly
     title = "Test Widget"
@@ -38,20 +39,23 @@ def test():
     wid.setWindowTitle(title)
 
     # Verify that our simple remapping of QWidget.windowTitle works
-    assert QtCompat.QWidget.windowTitleTest(wid) == title, \
+    assert QtCompat.QWidget.windowTitleTest(wid) == title, (
         "Non-decorated function was added to QtCompat.QWidget"
+    )
     # Verify that our decorated remapping of QWidget.windowTitle works
     check = "Test: {}".format(title)
-    assert QtCompat.QWidget.windowTitleDecorator(wid) == check, \
+    assert QtCompat.QWidget.windowTitleDecorator(wid) == check, (
         "Decorated method was not added to QtCompat.QWidget"
+    )
 
     # Verify that our decorated remapping of QMainWindow.windowTitle is
     # different than the QWidget version.
     win = QtWidgets.QMainWindow()
     win.setWindowTitle(title)
     check = "QMainWindow Test: {}".format(title)
-    assert QtCompat.QMainWindow.windowTitleDecorator(win) == check, \
+    assert QtCompat.QMainWindow.windowTitleDecorator(win) == check, (
         "Decorated method was added to QtCompat.QMainWindow"
+    )
     # Suppress "app" imported but unused warning
     app
 

membership.py

@@ -51,23 +51,27 @@ def compare(dicts):
     return common_members
 
 
-def copy_qtgui_to_qtwidgets():
+def copy_qtgui_to_modules():
     """Copies the QtGui list of PySide/PyQt4 into QtWidgets"""
 
     pyside_filepath = PREFIX + '/PySide.json'
     pyqt4_filepath = PREFIX + '/PyQt4.json'
     pyside = read_json(pyside_filepath)
     pyqt4 = read_json(pyqt4_filepath)
 
+    # When Qt4 was moved to Qt5, they split QtGui into QtGui, QtWidgets, and
+    # QtPrintSupport.
     pyside['QtWidgets'] = pyside['QtGui']
     pyqt4['QtWidgets'] = pyqt4['QtGui']
+    pyside['QtPrintSupport'] = pyside['QtGui']
+    pyqt4['QtPrintSupport'] = pyqt4['QtGui']
 
     write_json(pyside, pyside_filepath)
-    print('--> Copied QtGui to QtWidgets for ' + os.path.basename(
-        pyside_filepath))
+    print('--> Copied QtGui to QtWidgets and QtPrintSupport for {0}'.format(
+        os.path.basename(pyside_filepath)))
     write_json(pyqt4, pyqt4_filepath)
-    print('--> Copied QtGui to QtWidgets for ' + os.path.basename(
-        pyqt4_filepath))
+    print('--> Copied QtGui to QtWidgets and QtPrintSupport for {0}'.format(
+        os.path.basename(pyqt4_filepath)))
 
 
 def sort_common_members():
@@ -127,7 +131,7 @@ def generate_common_members():
     (options, args) = parser.parse_args()
 
     if options.copy:
-        copy_qtgui_to_qtwidgets()
+        copy_qtgui_to_modules()
 
     elif options.generate:
         generate_common_members()