معرفی شرکت ها
drf-pydantic-0.4.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Use pydantic with the Django REST framework
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | drf-pydantic-0.4.1 |
| نام | drf-pydantic |
| نسخه کتابخانه | 0.4.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | George Bocharov |
| ایمیل نویسنده | bocharovgeorgii@gmail.com |
| آدرس صفحه اصلی | https://github.com/georgebv/drf-pydantic |
| آدرس اینترنتی | https://pypi.org/project/drf-pydantic/ |
| مجوز | MIT |
<p align="center">
<a href="https://github.com/georgebv/drf-pydantic/actions/workflows/test.yml" target="_blank">
<img src="https://github.com/georgebv/drf-pydantic/actions/workflows/test.yml/badge.svg?event=pull_request" alt="Test Status">
</a>
<a href="https://codecov.io/gh/georgebv/drf-pydantic" target="_blank">
<img src="https://codecov.io/gh/georgebv/drf-pydantic/branch/main/graph/badge.svg?token=GN9rxzIFMc" alt="Test Coverage"/>
</a>
<a href="https://badge.fury.io/py/drf-pydantic" target="_blank">
<img src="https://badge.fury.io/py/drf-pydantic.svg" alt="PyPI version" height="20">
</a>
</p>
<p align="center">
<i>
Use pydantic with Django REST framework
</i>
</p>
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [General](#general)
- [Existing Models](#existing-models)
- [Nested Models](#nested-models)
- [Roadmap](#roadmap)
# Introduction
[Pydantic](https://pydantic-docs.helpmanual.io) is a Python library used to perform
data serialization and validation.
[Django REST framework](https://www.django-rest-framework.org) is a framework built
on top of [Django](https://www.djangoproject.com/) which allows writing REST APIs.
If like me you develop DRF APIs and you like pydantic , `drf-pydantic` is for you 😍.
# Installation
```shell
pip install drf-pydantic
```
# Usage
## General
Use `drf_pydantic.BaseModel` instead of `pydantic.BaseModel` when creating your
models:
```python
from drf_pydantic import BaseModel
class MyModel(BaseModel):
name: str
addresses: list[str]
```
Whenever you need a DRF serializer you can get it from the model like this:
```python
MyModel.drf_serializer
```
> ℹ️ **INFO**<br>
> Models created using `drf_pydantic` are fully idenditcal to those created by
> `pydantic`. The only change is the addition of the `drf_serializer` attribute
> during class creation (not instance).
## Existing Models
If you have an existing code base and you would like to use the `drf_serializer`
attribute to only specific models, then great news 🥳 - you can easily extend
your existign `pydantic` models by adding `drf_pydantic.BaseModel` to the list
of parent classes.
Your existing pydantic models:
```python
from pydantic import BaseModel
class Pet(BaseModel):
name: str
class Dog(Pet):
breed: str
```
Update your `Dog` model and get serializer via the `drf_serializer`:
```python
from drf_pydantic import BaseModel as DRFBaseModel
from pydantic import BaseModel
class Pet(BaseModel):
name: str
class Dog(DRFBaseModel, Pet):
breed: str
Dog.drf_serializer
```
> ⚠️ **ATTENTION**<br>
> Inheritance order is important: `drf_pydantic.BaseModel` must always go before
> the `pydantic.BaseModel` class.
## Nested Models
If you have nested models and you want to generate serializer only from one of them,
you don't have to update all models - only update the model you need, `drf_pydantic`
will generate serializers for all normal nested `pydantic` models for free 🐱👤.
```python
from drf_pydantic import BaseModel as DRFBaseModel
from pydantic import BaseModel
class Apartment(BaseModel):
floor: int
tenant: str
class Building(BaseModel):
address: str
aparments: list[Apartment]
class Block(DRFBaseModel):
buildings: list[Buildind]
Block.drf_serializer
```
# Roadmap
- Add `ENUM` support
- Add option to create custom serializer for complex models
- Add support for constraints (max, min, regex, etc.)
نیازمندی
| مقدار | نام |
|---|---|
| >=1.9.0,<2.0.0 | pydantic[email] |
| >=3.13.0,<4.0.0 | djangorestframework |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.9,<4.0 | Python |
نحوه نصب
نصب پکیج whl drf-pydantic-0.4.1:
pip install drf-pydantic-0.4.1.whl
نصب پکیج tar.gz drf-pydantic-0.4.1:
pip install drf-pydantic-0.4.1.tar.gz