Skip to main content

Use decorators to simplify using UI creation flow for PySide

Project description

pyside-callbacks

Actions status pdm-managed pre-commit

GitHub repository: https://github.com/schang412/pyside-callbacks

A small library that provides utility decorators for simplifying the creation of PySide6 UI. This package also contains a mypy plugin to assist in the type-checking the signals according to the parameters.

The QT Designer workflow with Python would look like this:

  1. Use QT Designer to create main_win.ui file.
  2. Use uic to compile main_win.ui into main_win.py
  3. Sub-Class the class defined in main_win.py.
  4. Connect the signals to their handlers.
import main_win
from PySide6 import QtWidgets

class MyQtApp(main_win.Ui_MainWindow, QtWidgets.QMainWindow):
    def __init__(self) -> None:
        super().__init__()
        self.setupUi(self)
        self.pushButton.clicked.connect(self.line_edit_return_pressed)
        self.lineEdit.returnPressed.connect(self.line_edit_return_pressed)

    def line_edit_return_pressed(self) -> None:
        cmd = self.lineEdit.text()
        if not cmd:
            return
        self.lineEdit.setText("")
        self.display.appendPlainText(cmd)

However, this connection method does not inherently offer type-checking and could be improved using decorators:

import main_win
from PySide6 import QtWidgets

import pyside_callbacks


@pyside_callbacks.pyside_callbacks
class MyQtApp(main_win.Ui_MainWindow, QtWidgets.QMainWindow):
    def __init__(self) -> None:
        super().__init__()
        self.setupUi(self)

    @pyside_callbacks.widget_event("pushButton", "clicked")
    @pyside_callbacks.widget_event("lineEdit", "returnPressed")
    def line_edit_return_pressed(self) -> None:
        cmd = self.lineEdit.text()
        if not cmd:
            return
        self.lineEdit.setText("")
        self.display.appendPlainText(cmd)

Note that we need to decorate both the class and the method because we need to add a hook to the __init__ method in order to register the callback to the class instance. The way that we keep track of the callbacks requires that the widget_event decorator is the outermost decorator. However, currently, the mypy plugin expects only widget_event callbacks on functions that use it.

In other words, we cannot mix @widget_event with other decorators (for example, @staticmethod).

We can also include a mypy plugin to ensure that our signals are correct. We add the pyside_callbacks_mypy plugin and suppress the errors from the uic generated file.

[tool.mypy]
plugins = [
    "pyside_callbacks_mypy.plugin"
]
[[tool.mypy.overrides]]
module = "main_win"
ignore_errors = true

Adding the following lines to the example application:

    @pyside_callbacks.widget_event("lineEdit", "cursorPositionChanged")
    def curpos_changed(self, b: str) -> None:
        print("changed cursor position!")

Then, running mypy we will find the errors:

example/my_app/app.py:34: error: Argument 2 to "curpos_changed" has incompatible type "str"; Emitted signal will expect type "int".  [arg-type]
example/my_app/app.py:34: error: Too many arguments for "curpos_changed"; Emitted signal will supply ["int", "int"]  [call-arg]
Found 2 errors in 1 file (checked 2 source files)

Note that we have to add a type-hint to main_win.Ui_MainWindow.setupUi otherwise dynamic types (typing.Any) will be inferred for all the widgets.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyside-callbacks-0.1.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

pyside_callbacks-0.1.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file pyside-callbacks-0.1.1.tar.gz.

File metadata

  • Download URL: pyside-callbacks-0.1.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.4.9 CPython/3.10.10

File hashes

Hashes for pyside-callbacks-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8fc329da3c1707dd60ba2a24b8fdd4b96e0495dfa3dc1c80ea4dd8107b867c14
MD5 d9c4bfddfc363f64e5f7eeacfc8701f9
BLAKE2b-256 35fe66d5ba944d52e1a6af93826f5c03ee4cc036ca98ef39c9468533a55eaf6a

See more details on using hashes here.

File details

Details for the file pyside_callbacks-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pyside_callbacks-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8dd5f8ce00b7d2a289675d216c70ebb0500503abff35cff3e9418bd37a56b96a
MD5 15f0789b1c5723e594ddcf239493170a
BLAKE2b-256 074eb8ead624f68c1c505e7caa5a23c2e4f86b0503aeccfdc7aa7e8c8b21c252

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page