معرفی شرکت ها
dataclass2PySide6-1.8.4
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Package to construct PySide6 widgets from dataclass
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | dataclass2PySide6-1.8.4 |
| نام | dataclass2PySide6 |
| نسخه کتابخانه | 1.8.4 |
| نگهدارنده | ['Jisoo Song'] |
| ایمیل نگهدارنده | ['jeesoo9595@snu.ac.kr'] |
| نویسنده | Jisoo Song |
| ایمیل نویسنده | jeesoo9595@snu.ac.kr |
| آدرس صفحه اصلی | https://github.com/JSS95/dataclass2PySide6 |
| آدرس اینترنتی | https://pypi.org/project/dataclass2PySide6/ |
| مجوز | LGPL |
Python package to dynamically create PySide6 widgets from dataclass
> :warning: This package no longer actively maintained. Use [DaWiQ](https://pypi.org/project/dawiq/) instead.
# Introduction
dataclass2PySide6 is a package which provides widgets to represent `dataclass` instance as `PySide6` GUI.
For example, here is a simple dataclass:
```python
from dataclasses import dataclass
from typing import Tuple
@dataclass
class DataClass:
a: int
b: Tuple[float, bool] = (4.2, True)
```
Dataclass widget can be dynamically created as follows.
```python
from PySide6.QtWidgets import QApplication
import sys
from dataclass2PySide6 import DataclassWidget
app = QApplication(sys.argv)
widget = DataclassWidget.fromDataclass(DataClass)
widget.show()
app.exec()
app.quit()
```
<div align="center">
<img src="https://github.com/JSS95/dataclass2PySide6/raw/master/imgs/example.jpg"/><br>
</div>
# Installation
Before you install, be careful for other Qt-dependent packages installed in your environment.
For example, non-headless `OpenCV-Python` module modifies the Qt dependency thus making PySide6 unavailable.
`dataclass2PySide6` can be installed using `pip`.
```
$ pip install dataclass2PySide6
```
# How to use
`DataclassWidget` is a widget for single dataclass type.
For multiple dataclass types in one widget, `StackedDataclassWidget` and `TabDataclassWidget` are provided.
## Single dataclass
`DataclassWidget` is the core object of `dataclass2PySide6`. It contains subwidgets which represent each fields of the dataclass.
User may subclass `DataclassWidget` to define own datclass widget. Refer to the docstring for detailed description.
### Creating widget
To construct `DataclassWidget`, pass dataclass type to `DataclassWidget.fromDataclass()` method.
To construct suitable widget for each field, `DataclassWidget` searches for `Qt_typehint` [metadata](https://docs.python.org/3/library/dataclasses.html#dataclasses.field).
Its value must be the type annotation, not necessarily identical to `type` attribute of the field. See [Dataclass example](#Dataclass-example) for the use case of `Qt_typehint`.
If `Qt_typehint` does not exist, it uses `type` attribute of the field as a fallback.
Currently supported types are:
1. `Enum` : converted to combo box
2. `bool` : converted to check box (`Union` with `None` allowed)
3. `int` and `float` : converted to line edit with validator (`Union` with `None` allowed)
4. `str` : converted to line edit
5. `Tuple` : converted to group box if element types are supported
### Getting data value
When data from any subwidget change, `DataclassWidget.dataValueChanged` signal emits the new dataclass instance with current value.
For check box or combo box, this is when the current selection changes. For line edit, this is when editing is finished.
`DataclassWidget.dataValue()` method returns the new dataclass instance with current data value.
If fields of the dataclass which constructed the widget defined `fromQt_converter` metadata, they are used to preprocess the data before dataclass construction.
Its value must be a unary function which converts the widget data to field value.
See [Dataclass example](#Dataclass-example) for the use case of `fromQt_converter`.
### Setting data value
`DataclassWidget.setDataValue()` method updates the subwidget data with new dataclass instance.
If fields of the dataclass which constructed the widget defined `toQt_converter` metadata,
they are used to convert the value to the form which is updatable to the widget.
Its value must be a unary function which converts the field value to widget data.
See [Dataclass example](#Dataclass-example) for the use case of `toQt_converter`.
## Multiple dataclasses
`StackedDataclassWidget` and `TabDataclassWidget` provide multiple `DataclassWidget` in one widget.
Both classes provide `addDataclass()` method to add new widget for dataclass, and `indexOfDataclass()` method to search widget for dataclass.
When current widget's value is changed, `dataValuechanged` signal emits the new dataclass instance with current value.
Note that changing the current index (or current widget) does not emit `dataValuechanged` signal.
Listen to standard `currentChanged` signal to detect it.
# Dataclass example
This is the example of dataclass which includes custom object.
Widget is constructed by `Tuple[int, int]` type annotation to represent two parameters of `MyObj`.
Conversion from `tuple` to `MyObj` and vice versa are defined.
```python
from dataclasses import field
from typing import Tuple
class MyObj:
def __init__(self, x: int, y: int):
self.x = x
self.y = y
@dataclass
class DataClass:
my_obj: MyObj = field(
metadata=dict(
Qt_typehint=Tuple[int, int],
fromQt_converter=lambda tup: MyObj(*tup),
toQt_converter=lambda obj: (obj.x, obj.y)
)
)
```
This is the widget constructed from `DataClass`.
<div align="center">
<img src="https://github.com/JSS95/dataclass2PySide6/raw/master/imgs/example2.jpg"/><br>
</div>
نیازمندی
| مقدار | نام |
|---|---|
| !=6.2.2,!=6.2.2.1 | PySide6 |
| - | pytest-qt |
| - | mypy |
| - | pytest-xvfb |
| - | flake8 |
| - | black |
| - | pytest |
| - | black |
| - | flake8 |
| - | mypy |
| - | pytest |
| - | pytest-qt |
| - | black |
| - | flake8 |
| - | mypy |
| - | pytest |
| - | pytest-qt |
| - | pytest-xvfb |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.9 | Python |
نحوه نصب
نصب پکیج whl dataclass2PySide6-1.8.4:
pip install dataclass2PySide6-1.8.4.whl
نصب پکیج tar.gz dataclass2PySide6-1.8.4:
pip install dataclass2PySide6-1.8.4.tar.gz