qpuiq 0.10__tar.gz

qpuiq-0.10/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 buganini@b612.tw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qpuiq-0.10/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.1
+Name: qpuiq
+Version: 0.10
+Summary: "PUI" Python Declarative UI Framework
+Home-page: https://github.com/buganini/PUI
+Author: Buganini Chiu
+Author-email: buganini@b612.tw
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# What is PUI
+PUI is a reactive/declarative UI framework with two-way data binding.
+PUI doesn't do UI itself, it turns imperative UI libraries into reactive/declarative flavor with virtual DOM and aims to maintain interoperability.
+
+[Slides for SciWork 2023](https://speakerdeck.com/buganini/pui-declarative-ui-framework-for-python)
+
+[CPPUI: Experimental C++ Version](https://github.com/buganini/CPPUI)
+
+# Installation
+```
+pip install QPUIQ
+```
+
+# Get Started
+## Hello World
+```python
+# example/hello_world.py
+from PUI.PySide6 import *
+
+@PUIApp
+def Example():
+    with Window(title="test", size=(320,240)):
+        Label("Hello world")
+
+root = Example()
+root.run()
+```
+![Hello World](screenshots/hello_world.png)
+
+## State & Data Binding
+```python
+# example/generic_textfield.py
+from PUI.PySide6 import *
+
+data = State()
+class Example(Application):
+    def __init__(self):
+        super().__init__()
+        data.var = 0
+
+    def content(self):
+        with Window(title="blah"):
+            with VBox():
+                with HBox():
+                    Button("-").click(self.on_minus)
+                    Label(f"{data.var}")
+                    Button("+").click(self.on_plus)
+
+                TextField(data("var")) # binding
+
+    def on_minus(self):
+        data.var -= 1
+
+    def on_plus(self):
+        data.var += 1
+
+root = Example()
+root.run()
+```
+![State & Data Binding](screenshots/pyside6_textfield.png)
+
+## View Component
+```python
+# example/bleak_list.py
+
+....
+
+@PUI # View Component
+def DeviceView(device, advertising_data):
+    Label(f"{device.address} {device.name} {advertising_data.rssi}")
+
+class GUI(Application):
+    def __init__(self, state):
+        super().__init__()
+        self.state = state
+
+    def content(self):
+        with Window(title="BLE List"):
+            with VBox():
+                Label(f"Found {len(self.state.scanned_devices)} devices")
+                for device, advertising_data in self.state.scanned_devices:
+                    DeviceView(device, advertising_data)
+
+....
+```
+![View Component](screenshots/bleak_list.png)
+
+## Layout & Styling
+```python
+# example/pyside6_feedparser.py
+
+...
+with VBox():
+    Label(title).qt(StyleSheet={"font-weight":"bold"}) # QT-specific
+
+    with HBox():
+        with Scroll():
+            with VBox():
+                for i,e in enumerate(entries):
+                    Label(e.title).click(self.entry_selected, i)
+                Spacer()
+
+        with Scroll().layout(weight=1): # Generic Layout Parameter
+            if 0 <= selected and selected < len(entries):
+                (Text(entries[selected].description)
+                    .layout(padding=10) # Generic Layout Parameter
+                    .qt(StyleSheet={"background-color":"white", "color":"black"})) # QT-specific
+...
+```
+![Layout & Styling](screenshots/feed_parser_padding.png)
+
+
+## Canvas
+```python
+# example/generic_canvas.py
+
+from PUI.PySide6 import *
+
+data = State()
+class Example(Application):
+    def __init__(self):
+        super().__init__()
+        data.var = 50
+
+    def content(self):
+        with Window(title="blah", size=(640,480)):
+            with VBox():
+                Canvas(self.painter, data.var)
+                with HBox():
+                    Button("-").click(self.on_minus)
+                    Label(f"{data.var}").layout(weight=1)
+                    Button("+").click(self.on_plus)
+
+    @staticmethod
+    def painter(canvas, var):
+        canvas.drawText(var, var/2, f"blah {var}")
+        canvas.drawLine(var, var, var*2, var*3, color=0xFFFF00)
+
+    def on_minus(self):
+        data.var -= 1
+
+    def on_plus(self):
+        data.var += 1
+
+root = Example()
+root.run()
+```
+![Canvas](screenshots/pyside6_canvas.gif)
+
+## Cookbook
+`python -m cookbook PySide6` (requires pygments for syntax highlight)
+
+![Cookbook 1](screenshots/cookbook1.png)
+![Cookbook 2](screenshots/cookbook2.png)
+
+`python -m cookbook textual`
+![Cookbook textual](screenshots/cookbook_textual.png)
+
+`python -m cookbook flet`
+![Cookbook flet](screenshots/cookbook_flet.png)
+
+`python -m cookbook tkinter`
+![Cookbook tkinter](screenshots/cookbook_tkinter.png)
+
+# Hot Reload
+``` shell
+pip install jurigged
+```
+Then PUI will take care of view update [(code)](https://github.com/buganini/PUI/blob/main/PUI/__init__.py#L11)
+
+
+# Backends
+## Tier-1
+* PySide6
+## Lower Priority
+* wx
+* tkinter
+    * or https://github.com/rdbende/Sun-Valley-ttk-theme
+* flet
+* textual (Text Mode)
+    * no canvas
+
+# Components
+[Reference](REFERENCE.md)
+
+# Used by
+* https://github.com/buganini/kikit-ui
+* https://github.com/solvcon/modmesh
+
+# TODO
+* Merge node and view
+* Dump with layout parameters and add test cases
+* [Toga](https://beeware.org/project/projects/libraries/toga/)
+* [ISSUE] textual layout sizing (cookbook scroll example)
+* [ISSUE] flet layout sizing (cookbook scroll example)
+* nested state trigger
+    * set state in PUIView __init__
+    * set state in setup() ?
+* Tabs(`tabposition`)
+* Lazy List
+* StateObject decorator
+* UI Flow
+    * Navigation Stack
+    * View Router
+    * Model Window/Dialog
+* Layout
+    * ZBox
+    * SwiftUI style overlay ??
+* Canvas
+    * Rect
+    * Arc
+    * Image
+    * ...
+* Table
+* Tree
+* Dialog
+* State with Pydantic support?

qpuiq-0.10/PUI/PySide6/__init__.py

@@ -0,0 +1,49 @@
+from PySide6.QtWidgets import QSizePolicy, QLayout
+
+from .application import *
+from .button import *
+from .canvas import *
+from .checkbox import *
+from .combobox import *
+from .dialog import *
+from .divider import *
+from .image import *
+from .label import *
+from .layout import *
+from .modal import *
+from .matplotlib import *
+from .progressbar import *
+from .radiobutton import *
+from .scroll import *
+from .splitter import *
+from .table import *
+from .tab import *
+from .text import *
+from .textfield import *
+from .tree import *
+from .window import *
+from .mdi import *
+from .toolbar import *
+
+PUIView = QtPUIView
+
+def PUI(func):
+    """
+    PUI.PySide6.PUI triggers update() by signal/slot
+    """
+    def func_wrapper(*args, **kwargs):
+        class PUIViewWrapper(QtPUIView):
+            pui_virtual = True
+            def __init__(self, name):
+                self.name = name
+                super().__init__()
+
+            def content(self):
+                return func(*args, **kwargs)
+
+        ret = PUIViewWrapper(func.__name__)
+        return ret
+
+    return func_wrapper
+
+PUI_BACKEND = "PySide6"

qpuiq-0.10/PUI/PySide6/application.py

@@ -0,0 +1,58 @@
+from .. import *
+from .base import *
+
+class QtApplicationSignal(QtCore.QObject):
+    quit = QtCore.Signal()
+
+class Application(QtPUIView):
+    def __init__(self, icon=None):
+        super().__init__()
+        self.ui = None
+        self.icon = icon
+        self._qtappsignal = QtApplicationSignal()
+        self._qtappsignal.quit.connect(self._quit, QtCore.Qt.ConnectionType.QueuedConnection) # Use QueuedConnection to prevent nested trigger
+
+    def redraw(self):
+        if self.ui:
+            super().redraw()
+        else:
+            self.sync()
+
+    def update(self, prev=None):
+        if not self.ui:
+            from PySide6 import QtWidgets
+            self.ui = QtWidgets.QApplication([])
+            if self.icon:
+                self.ui.setWindowIcon(QtGui.QIcon(self.icon))
+
+        super().update(prev)
+
+    def addChild(self, idx, child):
+        child.outer.show()
+
+    def removeChild(self, idx, child):
+        child.outer.close()
+
+    def start(self):
+        self.ui.exec()
+
+    def quit(self):
+        self._qtappsignal.quit.emit()
+
+    def _quit(self):
+        self.ui.quit()
+
+def PUIApp(func):
+    def func_wrapper(*args, **kwargs):
+        class PUIAppWrapper(Application):
+            def __init__(self, name):
+                self.name = name
+                super().__init__()
+
+            def content(self):
+                return func(*args, **kwargs)
+
+        ret = PUIAppWrapper(func.__name__)
+        return ret
+
+    return func_wrapper

qpuiq-0.10/PUI/PySide6/base.py

@@ -0,0 +1,222 @@
+from .. import *
+from PySide6 import QtCore, QtWidgets, QtGui
+
+class QtViewSignal(QtCore.QObject):
+    redraw = QtCore.Signal()
+
+def _apply_params(ui, node):
+    styles = {}
+    if node.style_fontsize:
+        styles["font"] = f"{node.style_fontsize}pt"
+    if node.style_fontfamily:
+        styles["font-family"] = node.style_fontfamily
+    if node.style_color:
+        styles["color"] = f"#{node.style_color:06X}"
+    if node.style_bgcolor:
+        styles["background-color"] = f"#{node.style_bgcolor:06X}"
+
+    style = node.qt_params.get("Style")
+    if not style is None:
+        ui.setStyle(style)
+
+    HorizontalPolicy = node.qt_params.get("HorizontalPolicy")
+    if not HorizontalPolicy is None:
+        ui.sizePolicy().setHorizontalPolicy(HorizontalPolicy)
+
+    VerticalPolicy = node.qt_params.get("VerticalPolicy")
+    if not VerticalPolicy is None:
+        ui.sizePolicy().setVerticalPolicy(VerticalPolicy)
+
+    SizeConstraint = node.qt_params.get("SizeConstraint")
+    if not SizeConstraint is None:
+        ui.setSizeConstraint(SizeConstraint)
+
+    StyleSheet = node.qt_params.get("StyleSheet", {})
+    for k,v in StyleSheet.items():
+        styles[k] = v
+
+    if hasattr(ui, "setStyleSheet"):
+        ui.setStyleSheet("".join([f"{k}:{v};" for k,v in styles.items()]))
+
+    if node.layout_padding:
+        ui.setContentsMargins(*trbl2ltrb(node.layout_padding))
+
+class QtPUIView(PUIView):
+    pui_virtual = True
+    def __init__(self):
+        super().__init__()
+        self.qt_params = {}
+        self._qtsignal = QtViewSignal()
+        self._qtsignal.redraw.connect(self.sync, QtCore.Qt.ConnectionType.QueuedConnection) # Use QueuedConnection to prevent nested trigger
+
+    def destroy(self, direct):
+        if direct:
+            if self.ui: # PUIView doesn't have ui
+                self.ui.deleteLater()
+        self.ui = None
+        super().destroy(direct)
+
+    def redraw(self):
+        self.dirty = True
+        if self.updating:
+            return
+        self.updating = True
+        self._qtsignal.redraw.emit()
+
+    def update(self, prev=None):
+        super().update(prev)
+        _apply_params(self.ui, self)
+
+    def qt(self, **kwargs):
+        for k,v in kwargs.items():
+            self.qt_params[k] = v
+        return self
+
+class QtBaseWidget(PUINode):
+    pui_terminal = True
+
+    def __init__(self):
+        super().__init__()
+        self.qt_params = {}
+
+    def destroy(self, direct):
+        if direct:
+            if self.ui:
+                self.ui.deleteLater()
+        self.ui = None
+        super().destroy(direct)
+
+    def update(self, prev=None):
+        super().update(prev)
+
+        sizePolicy = self.ui.sizePolicy()
+        if self.layout_width is not None:
+            sizePolicy.setHorizontalPolicy(QtWidgets.QSizePolicy.Preferred)
+        if self.layout_height is not None:
+            sizePolicy.setVerticalPolicy(QtWidgets.QSizePolicy.Preferred)
+        self.ui.setSizePolicy(sizePolicy)
+
+        if not hasattr(self.ui, "origSizeHint"):
+            self.ui.origSizeHint = self.ui.sizeHint
+        self.ui.sizeHint = self.qtSizeHint
+
+        _apply_params(self.ui, self)
+
+    def qtSizeHint(self):
+        node = self.get_node()
+        if not node.ui:
+            return QtCore.QSize(0, 0)
+        sh = node.ui.origSizeHint()
+        w = sh.width()
+        h = sh.height()
+        if not node.layout_width is None:
+            w = node.layout_width
+        if not node.layout_height is None:
+            h = node.layout_height
+        return QtCore.QSize(w, h)
+
+    def qt(self, **kwargs):
+        for k,v in kwargs.items():
+            self.qt_params[k] = v
+        return self
+
+class QtBaseLayout(PUINode):
+    def __init__(self):
+        super().__init__()
+        self.qt_params = {}
+        if not isinstance(self.non_virtual_parent, QtBaseLayout):
+            self.layout_padding = (11,11,11,11)
+
+    @property
+    def outer(self):
+        return self.ui
+
+    @property
+    def inner(self):
+        return self.layout
+
+    def destroy(self, direct):
+        if direct:
+            if self.ui:
+                self.ui.deleteLater()
+        self.layout = None
+        self.ui = None
+        super().destroy(direct)
+
+    def update(self, prev=None):
+        super().update(prev)
+        _apply_params(self.ui, self)
+
+    def addChild(self, idx, child):
+        from .modal import Modal
+        from .layout import Spacer
+        if isinstance(child, Spacer):
+            self.layout.insertItem(idx, child.outer)
+        elif isinstance(child, Modal):
+            pass
+        elif isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            params = {}
+            if not child.layout_weight is None:
+                params["stretch"] = child.layout_weight
+            self.layout.insertWidget(idx, child.outer, **params)
+
+    def removeChild(self, idx, child):
+        from .modal import Modal
+        from .layout import Spacer
+        if isinstance(child, Spacer):
+            self.layout.removeItem(child.outer)
+        elif isinstance(child, Modal):
+            pass
+        elif isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            child.outer.setParent(None)
+
+    def qt(self, **kwargs):
+        for k,v in kwargs.items():
+            self.qt_params[k] = v
+        return self
+
+class QtBaseFrame(QtBaseWidget):
+    pui_terminal = False
+
+    def destroy(self, direct):
+        if direct:
+            if self.ui:
+                self.ui.deleteLater()
+                self.ui = None
+
+    def addChild(self, idx, child):
+        if idx != 0:
+            return
+        if isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            self.ui.setWidget(child.outer)
+        elif child.children:
+            self.addChild(idx, child.children[0])
+
+    def removeChild(self, idx, child):
+        if idx != 0:
+            return
+        if isinstance(child, QtBaseWidget) or isinstance(child, QtBaseLayout):
+            child.outer.setParent(None)
+        elif child.children:
+            self.removeChild(idx, child.children[0])
+
+class QtInPui(QtBaseWidget):
+    def __init__(self, widget, *args):
+        self._internal_tag = str(id(widget))
+        super().__init__(*args)
+        self.ui = widget
+
+    def destroy(self, direct):
+        pass
+
+class PuiInQt(QtPUIView):
+    def __init__(self, ui):
+        super().__init__()
+        self.ui = ui
+        self.ui.update()
+
+    def addChild(self, idx, child):
+        self.ui.addChild(idx, child)
+
+    def removeChild(self, idx, child):
+        self.ui.removeChild(idx, child)

qpuiq-0.10/PUI/PySide6/button.py

@@ -0,0 +1,21 @@
+from .. import *
+from .base import *
+
+class Button(QtBaseWidget):
+    def __init__(self, text):
+        super().__init__()
+        self.text = text
+
+    def update(self, prev):
+        if prev and prev.ui:
+            self.ui = prev.ui
+            self.ui.setText(self.text)
+            try:
+                self.ui.clicked.disconnect()
+            except:
+                pass
+            prev.callback = None
+        else:
+            self.ui = QtWidgets.QPushButton(text=self.text)
+        self.ui.clicked.connect(self._clicked)
+        super().update(prev)