QtSiteConfig.py

# Contrived example used for unit testing. For a more realistic example
# see the README


def update_members(members):
    """This optional function is called by Qt.py to modify the modules exposed.

    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
    members.pop("QtCore")


def update_misplaced_members(members):
    """This optional function is called by Qt.py to standardize the location
    and naming of exposed classes.

    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"
    members["PyQt4"]["QtGui.QColor"] = "QtGui.QColorTest"


def update_compatibility_members(members):
    """This optional function is called by Qt.py to modify the structure of
    QtCompat namespace classes.

    Arguments:
        members (dict): The members considered by Qt.py
    """
    # Create a QtCompat.QWidget compatibility class. This example is
    # is used to provide a testable unittest
    for binding in ("PySide2", "PyQt5", "PySide", "PyQt4"):
        members[binding]["QWidget"] = {
            # Simple remapping of QWidget.windowTitle
            "windowTitleTest": "QtWidgets.QWidget.windowTitle",
            # Remap QWidget.windowTitle with a decorator that modifies
            # the returned value.
            "windowTitleDecorator": "QtWidgets.QWidget.windowTitle",
        }
        members[binding]["QMainWindow"] = {
            "windowTitleDecorator": "QtWidgets.QMainWindow.windowTitle"
        }


def update_compatibility_decorators(binding, decorators):
    """ This optional function is called by Qt.py to modify the decorators
    applied to QtCompat namespace objects.

    Arguments:
        binding (str): The Qt binding being wrapped by Qt.py
        decorators (dict): Maps specific decorator functions to
            QtCompat namespace methods. See Qt._build_compatibility_members
            for more info.
    """

    def _widgetDecorator(some_function):
        def wrapper(*args, **kwargs):
            ret = some_function(*args, **kwargs)
            # Modifies the returned value so we can test that the
            # decorator works.
            return "Test: {}".format(ret)
        # preserve docstring and name of original function
        wrapper.__doc__ = some_function.__doc__
        wrapper.__name__ = some_function.__name__
        return wrapper

    # Assign a different decorator for the same method name on each class
    def _mainWindowDecorator(some_function):
        def wrapper(*args, **kwargs):
            ret = some_function(*args, **kwargs)
            # Modifies the returned value so we can test that the
            # decorator works.
            return "QMainWindow Test: {}".format(ret)
        # preserve docstring and name of original function
        wrapper.__doc__ = some_function.__doc__
        wrapper.__name__ = some_function.__name__
        return wrapper
    decorators.setdefault("QWidget", {})["windowTitleDecorator"] = (
        _widgetDecorator
    )
    decorators.setdefault("QMainWindow", {})["windowTitleDecorator"] = (
        _mainWindowDecorator
    )