I’m working on a project that needs lots of toolbars on screen at once, even though not all of them will be used at the same time. So, I’m modelling this ‘foldable’ dock widget after what I remember Photoshop panels used to be like.

It’s a work in progress, but would like to hear constructive suggestions.

https://blocks.programming.dev/0101100101/42c5d67f86c049baa3500aa38e439f8a

  • logging_strict@programming.dev
    link
    fedilink
    arrow-up
    3
    ·
    1 天前

    Lets fix the Sphinx in-code documentation (Ignoring should never embed classes within other classes)

    class FoldableDockWidget(QDockWidget):
        """
        A simple Qt Widget that adds a 'minimise' button that vertically reduces the dock widget to just the titlebar to
        allow the dock widget to still take up minimal screen real estate
        """
    
        class TitleBarWidget(QWidget):
            def __init__(self, title:str, parent:QWidget=None):
                """
                We create a custom title bar using QWidget as the base. The title bar has to be wrapped in another widget
                so that its background can be styled easier, otherwise it's impossible to style
                :param title: the title to appear in the title bar
                """
    

    Becomes

    class FoldableDockWidget(QDockWidget):
        """
        A simple Qt Widget that adds a 'minimise' button that vertically reduces the dock widget to just the titlebar to
        allow the dock widget to still take up minimal screen real estate
        """
    
        class TitleBarWidget(QWidget):
        """Create a custom title bar using :py:class:`~PySide6.QtWidgets.QWidget` as the base.
        The title bar has to be wrapped in another widget so that its background can be styled
        easier, otherwise it's impossible to style
    
        :ivar title: the title to appear in the title bar
        :vartype title: str
        :ivar parent: Default None. Identify parent widget
        :vartype parent: PySide6.QtWidgets.QWidget | None
        """
    
            def __init__(self, title: str, parent: QWidget = None) -> None:
                """class constructor"""
    

    typing matters. Normally separate typing into stub files. The Sphinx in-code documentation includes typing, so the signatures can be simplified and easier to read

    def __init__(self, title, parent=None):

    • 0101100101@programming.devOP
      link
      fedilink
      English
      arrow-up
      2
      ·
      edit-2
      14 小时前

      Thanks for your response.

      should never embed classes within other classes)

      Why is this? I have to admit that coming from other languages, it feels dirty, but is there a pythonic good reason for this? The class ‘belongs’ to the FoldableDockWidget class, so I figure it’s the best place to put it.

      • logging_strict@programming.dev
        link
        fedilink
        arrow-up
        2
        ·
        11 小时前

        Arguing for modularity. Which isn’t likely in a gist (or a script), but is normal for a package.

        By embedding the class, creates a limitation that prevents abstractions or other implementations of each component. Imagine every suggestion in this conversation thread is another variation with a separate implementation.

        The widget class belongs to the FoldableDockWidget class until it doesn’t. Then a refactor is needed.

        There should be four modules. The entrypoint (and cli options parsing), the application, the dockwidget, and the widget. Each should be testable by itself.

        A widget is not a container. An application is not a container component (avoiding the word widget). Hardwiring a particular implementation of the Windowing Python wrapper is also unnecessary (PySide6). What about PySide2, pyQt5, pyQt6, and whatever else comes next?

        As a side note

        Why is there code in the process guard, besides main() (or a async equivalent)? Only multiprocessing applications have code within the process guard. Code within the process guard is unreachable; can’t be imported. For example, testing just the cli option parsing.