معرفی شرکت ها
django-dataclass-autoserialize-1.0.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
-
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-dataclass-autoserialize-1.0.1 |
| نام | django-dataclass-autoserialize |
| نسخه کتابخانه | 1.0.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Piti Ongmongkolkul |
| ایمیل نویسنده | o.piti@thegang.tech |
| آدرس صفحه اصلی | https://github.com/thegangtechnology/django-dataclass-autoserialize |
| آدرس اینترنتی | https://pypi.org/project/django-dataclass-autoserialize/ |
| مجوز | BSD |
# django-dataclass-autoserialize
An extension of slightly modified
oxan's [django-dataclass-serialize](https://github.com/oxan/djangorestframework-dataclasses)
(Temporary hosted [here](https://github.com/piti118/djangorestframework-dataclasses)). Making it much more enjoyable to
use with [drf-yasg](https://github.com/axnsan12/drf-yasg).
The goal of this package is to make the APIView code as succinctly as possible. The main pain point it is trying to solve is
1) Having to define the param class and serialize separately.
2) Having it nicely integrate with drf-yasg without having to duplicate information.
# Install
```
pip install django-dataclass-autoserialize
```
# Documentation
## Simple Usage
Here is an example of a typical usage. Pull straight from
[Example Project](https://github.com/thegangtechnology/django_dataclass_autoserialize_example)
```python
from __future__ import annotations
from django_dataclass_autoserialize import AutoSerialize, swagger_post_schema, swagger_get_schema
from dataclasses import dataclass
from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework.views import APIView
@dataclass
class InputParam(AutoSerialize):
a: int
b: int
@classmethod
def example(cls) -> InputParam:
# this is actually optional but it will show up
# in swagger doc
return cls(a=3, b=2)
@dataclass
class ComputeResponse(AutoSerialize):
msg: str
result: int
@classmethod
def example(cls) -> ComputeResponse:
return cls(msg='hello world', result=5)
class AddView(APIView):
@swagger_post_schema(
body_type=InputParam,
response_types={200: ComputeResponse}
)
def post(self, request: Request) -> Response:
param = InputParam.from_post_request(request)
return ComputeResponse(msg='add successfully',
result=param.a + param.b).to_response()
class SubtractView(APIView):
@swagger_get_schema(
query_type=InputParam,
response_types={200: ComputeResponse}
)
def get(self, request: Request) -> Response:
param = InputParam.from_get_request(request)
return ComputeResponse(msg='subtract successfully',
result=param.a - param.b).to_response()
```
Then the swagger will shows up like the following
## Customization
Under the hood it uses [djangorestframework-dataclasses](https://github.com/oxan/djangorestframework-dataclasses). So
all the customization that can be done for dataclass is applied here as well. For example, you can
add `serializer_kwargs` like so
```python
@dataclasses.dataclass
class Person:
email: str = dataclasses.field(metadata={'serializer_field': fields.EmailField()})
age: int = dataclasses.field(metadata={'serializer_kwargs': {'min_value': 0}})
```
## Validation
The validation of the object can be done by overiding
`validate_data(cls, obj)` method. For example
```python
class Numbers(AutoSerialize):
a: int
b: int
@classmethod
def validate_data(cls, obj: Numbers) -> Numbers:
from rest_framework.exceptions import ValidationError
if obj.a + obj.b > 1000:
raise ValidationError('too big')
return obj
```
## Swagger
drg-yasg integration is done through `swagger_get_schema` and `swagger_get_schema`
decorator. See simple example for the usage. keywords other than `query_type/body_type` and `response_types`
are forwarded to drf-yasg's `swagger_auto_schema`.
نیازمندی
| مقدار | نام |
|---|---|
| - | djangorestframework-dataclasses |
| - | drf-yasg |
| - | mypy |
| - | autopep8 |
| - | pytest |
| - | pytest-cov |
نحوه نصب
نصب پکیج whl django-dataclass-autoserialize-1.0.1:
pip install django-dataclass-autoserialize-1.0.1.whl
نصب پکیج tar.gz django-dataclass-autoserialize-1.0.1:
pip install django-dataclass-autoserialize-1.0.1.tar.gz