qt-pydantic 0.1.0__tar.gz

qt_pydantic-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Beat Reichenbach
+
+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.

qt_pydantic-0.1.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.2
+Name: qt-pydantic
+Version: 0.1.0
+Summary: Pydantic BaseModel Annotations for Qt
+Author: Beat Reichenbach
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: qtpy<3,>=2.0
+Requires-Dist: pydantic<3,>=2.0
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: python-semantic-release>=9.0; extra == "dev"
+Requires-Dist: PySide6; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Provides-Extra: pyside2
+Requires-Dist: PySide2; extra == "pyside2"
+Provides-Extra: pyside6
+Requires-Dist: PySide6; extra == "pyside6"
+
+# qt-pydantic
+
+The `qt-pydantic` package adds support for Qt types in Pydantic BaseModels.
+Using these annotations allows for easy serialization and deserialization of Qt types.
+
+
+## Installation
+
+Install using pip:
+```shell
+pip install qt-pydantic
+```
+
+## Usage
+
+```python
+from PySide6 import QtCore, QtGui
+from pydantic import BaseModel
+from qt_pydantic import QSize, QColor, QDate
+
+
+# Define a model with Qt types
+class Settings(BaseModel):
+    size: QSize
+    date: QDate
+    color: QColor
+
+
+# Parse json string into model
+json_data = '{"size": [720, 480], "date": "2021-01-01", "color": [255, 95, 135]}'
+settings = Settings.model_validate_json(json_data)
+
+# Model types are actual Qt types
+assert isinstance(settings.size, QtCore.QSize)
+assert isinstance(settings.date, QtCore.QDate)
+assert isinstance(settings.color, QtGui.QColor)
+
+# Turn model into json string
+data = settings.model_dump_json(indent=2)
+```
+
+## Contributing
+
+To contribute please refer to the [Contributing Guide](CONTRIBUTING.md).
+
+## License
+
+MIT License. Copyright 2024 - Beat Reichenbach.
+See the [License file](LICENSE) for details.

qt_pydantic-0.1.0/README.md

@@ -0,0 +1,49 @@
+# qt-pydantic
+
+The `qt-pydantic` package adds support for Qt types in Pydantic BaseModels.
+Using these annotations allows for easy serialization and deserialization of Qt types.
+
+
+## Installation
+
+Install using pip:
+```shell
+pip install qt-pydantic
+```
+
+## Usage
+
+```python
+from PySide6 import QtCore, QtGui
+from pydantic import BaseModel
+from qt_pydantic import QSize, QColor, QDate
+
+
+# Define a model with Qt types
+class Settings(BaseModel):
+    size: QSize
+    date: QDate
+    color: QColor
+
+
+# Parse json string into model
+json_data = '{"size": [720, 480], "date": "2021-01-01", "color": [255, 95, 135]}'
+settings = Settings.model_validate_json(json_data)
+
+# Model types are actual Qt types
+assert isinstance(settings.size, QtCore.QSize)
+assert isinstance(settings.date, QtCore.QDate)
+assert isinstance(settings.color, QtGui.QColor)
+
+# Turn model into json string
+data = settings.model_dump_json(indent=2)
+```
+
+## Contributing
+
+To contribute please refer to the [Contributing Guide](CONTRIBUTING.md).
+
+## License
+
+MIT License. Copyright 2024 - Beat Reichenbach.
+See the [License file](LICENSE) for details.

qt_pydantic-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "qt-pydantic"
+version = "0.1.0"
+description = "Pydantic BaseModel Annotations for Qt"
+authors = [
+    {name = "Beat Reichenbach"}
+]
+dependencies = [
+    "qtpy>=2.0,<3",
+    "pydantic>=2.0,<3",
+]
+requires-python = ">=3.9"
+license = {text = "MIT"}
+readme = "README.md"
+
+[project.optional-dependencies]
+dev = [
+    "black>=24.0",
+    "python-semantic-release>=9.0",
+    "PySide6",
+    "pytest>=8.0",
+]
+pyside2 = ["PySide2"]
+pyside6 = ["PySide6"]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["qt_pydantic"]
+
+[tool.semantic_release]
+version_variables = ["qt_pydantic/__init__.py:__version__"]
+version_toml  = ["pyproject.toml:project.version"]
+
+[tool.semantic_release.remote]
+ignore_token_for_push = true
+
+[tool.black]
+skip-string-normalization = true

qt_pydantic-0.1.0/qt_pydantic/__init__.py

@@ -0,0 +1,15 @@
+from .annotations import (
+    QSize,
+    QSizeF,
+    QPoint,
+    QPointF,
+    QRect,
+    QRectF,
+    QDate,
+    QDateTime,
+    QTime,
+    QUuid,
+    QColor,
+)
+
+__version__ = '0.1.0'

qt_pydantic-0.1.0/qt_pydantic/annotations.py

@@ -0,0 +1,168 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import Any
+
+from qtpy import QtCore, QtGui
+from pydantic import GetCoreSchemaHandler, GetJsonSchemaHandler
+from pydantic.json_schema import JsonSchemaValue
+from pydantic_core import core_schema
+
+
+class QAnnotation:
+    qtype: type
+    schema: core_schema.CoreSchema
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls,
+        _source_type: Any,
+        _handler: GetCoreSchemaHandler,
+    ) -> core_schema.CoreSchema:
+        chain_schema = core_schema.chain_schema(
+            [cls.schema, core_schema.no_info_plain_validator_function(cls.validate)]
+        )
+        python_schema = core_schema.union_schema(
+            [core_schema.is_instance_schema(cls.qtype), chain_schema]
+        )
+        serialization = core_schema.plain_serializer_function_ser_schema(cls.serialize)
+        return core_schema.json_or_python_schema(
+            json_schema=chain_schema,
+            python_schema=python_schema,
+            serialization=serialization,
+        )
+
+    @classmethod
+    def __get_pydantic_json_schema__(
+        cls, _core_schema: core_schema.CoreSchema, handler: GetJsonSchemaHandler
+    ) -> JsonSchemaValue:
+        return handler(cls.schema)
+
+    @classmethod
+    def validate(cls, value: Any) -> QAnnotation.qtype:
+        if isinstance(value, Sequence) and not isinstance(value, str):
+            return cls.qtype(*value)
+        return cls.qtype(value)
+
+    @staticmethod
+    def serialize(value: Any) -> Any: ...
+
+
+# QtCore
+
+
+class QSize(QAnnotation):
+    qtype = QtCore.QSize
+    schema = core_schema.tuple_schema([core_schema.int_schema()] * 2)
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.width(), value.height()
+
+
+class QSizeF(QSize):
+    qtype = QtCore.QSizeF
+    schema = core_schema.tuple_schema([core_schema.float_schema()] * 2)
+
+
+class QPoint(QAnnotation):
+    qtype = QtCore.QPoint
+    schema = core_schema.tuple_schema([core_schema.int_schema()] * 2)
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.x(), value.y()
+
+
+class QPointF(QPoint):
+    qtype = QtCore.QPointF
+    schema = core_schema.tuple_schema([core_schema.float_schema()] * 2)
+
+
+class QRect(QAnnotation):
+    qtype = QtCore.QRect
+    schema = core_schema.tuple_schema([core_schema.int_schema()] * 4)
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.x(), value.y(), value.width(), value.height()
+
+
+class QRectF(QRect):
+    qtype = QtCore.QRectF
+    schema = core_schema.tuple_schema([core_schema.float_schema()] * 4)
+
+
+class QDate(QAnnotation):
+    qtype = QtCore.QDate
+    schema = core_schema.date_schema()
+
+    @classmethod
+    def validate(cls, value: Any) -> QAnnotation.qtype:
+        return cls.qtype(value.year, value.month, value.day)
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.toString(QtCore.Qt.DateFormat.ISODate)
+
+
+class QDateTime(QAnnotation):
+    qtype = QtCore.QDateTime
+    schema = core_schema.datetime_schema()
+
+    @classmethod
+    def validate(cls, value: Any) -> QAnnotation.qtype:
+        msecs = int(value.timestamp() * 1000)
+        return cls.qtype.fromMSecsSinceEpoch(msecs)
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.toString(QtCore.Qt.DateFormat.ISODate)
+
+
+class QTime(QAnnotation):
+    qtype = QtCore.QTime
+    schema = core_schema.time_schema()
+
+    @classmethod
+    def validate(cls, value: Any) -> QAnnotation.qtype:
+        return cls.qtype(
+            value.hour, value.minute, value.second, value.microsecond // 1000
+        )
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.toString(QtCore.Qt.DateFormat.ISODate)
+
+
+class QUuid(QAnnotation):
+    qtype = QtCore.QUuid
+    schema = core_schema.str_schema()
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.toString()
+
+
+# QColor
+
+
+class QColor(QAnnotation):
+    qtype = QtGui.QColor
+    schema = core_schema.union_schema(
+        [
+            # name
+            core_schema.str_schema(),
+            # rgb(a)
+            core_schema.tuple_schema(
+                [core_schema.int_schema(ge=0, le=255)],
+                variadic_item_index=0,
+                min_length=3,
+                max_length=4,
+            ),
+        ]
+    )
+
+    @staticmethod
+    def serialize(value: Any) -> Any:
+        return value.getRgb()

qt_pydantic-0.1.0/qt_pydantic.egg-info/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.2
+Name: qt-pydantic
+Version: 0.1.0
+Summary: Pydantic BaseModel Annotations for Qt
+Author: Beat Reichenbach
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: qtpy<3,>=2.0
+Requires-Dist: pydantic<3,>=2.0
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: python-semantic-release>=9.0; extra == "dev"
+Requires-Dist: PySide6; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Provides-Extra: pyside2
+Requires-Dist: PySide2; extra == "pyside2"
+Provides-Extra: pyside6
+Requires-Dist: PySide6; extra == "pyside6"
+
+# qt-pydantic
+
+The `qt-pydantic` package adds support for Qt types in Pydantic BaseModels.
+Using these annotations allows for easy serialization and deserialization of Qt types.
+
+
+## Installation
+
+Install using pip:
+```shell
+pip install qt-pydantic
+```
+
+## Usage
+
+```python
+from PySide6 import QtCore, QtGui
+from pydantic import BaseModel
+from qt_pydantic import QSize, QColor, QDate
+
+
+# Define a model with Qt types
+class Settings(BaseModel):
+    size: QSize
+    date: QDate
+    color: QColor
+
+
+# Parse json string into model
+json_data = '{"size": [720, 480], "date": "2021-01-01", "color": [255, 95, 135]}'
+settings = Settings.model_validate_json(json_data)
+
+# Model types are actual Qt types
+assert isinstance(settings.size, QtCore.QSize)
+assert isinstance(settings.date, QtCore.QDate)
+assert isinstance(settings.color, QtGui.QColor)
+
+# Turn model into json string
+data = settings.model_dump_json(indent=2)
+```
+
+## Contributing
+
+To contribute please refer to the [Contributing Guide](CONTRIBUTING.md).
+
+## License
+
+MIT License. Copyright 2024 - Beat Reichenbach.
+See the [License file](LICENSE) for details.

qt_pydantic-0.1.0/qt_pydantic.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+qt_pydantic/__init__.py
+qt_pydantic/annotations.py
+qt_pydantic.egg-info/PKG-INFO
+qt_pydantic.egg-info/SOURCES.txt
+qt_pydantic.egg-info/dependency_links.txt
+qt_pydantic.egg-info/requires.txt
+qt_pydantic.egg-info/top_level.txt

qt_pydantic-0.1.0/qt_pydantic.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

qt_pydantic-0.1.0/qt_pydantic.egg-info/requires.txt

@@ -0,0 +1,14 @@
+qtpy<3,>=2.0
+pydantic<3,>=2.0
+
+[dev]
+black>=24.0
+python-semantic-release>=9.0
+PySide6
+pytest>=8.0
+
+[pyside2]
+PySide2
+
+[pyside6]
+PySide6

qt_pydantic-0.1.0/qt_pydantic.egg-info/top_level.txt

@@ -0,0 +1 @@
+qt_pydantic

qt_pydantic-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+