pyngo 2.2.0

Description:

pyngo 2.2.0

Pyngo :snake:

Utils to help integrate pydantic into Django projects



















Installation
You can add pyngo in a few easy steps. First of all, install the dependency:
$ pip install pyngo

---> 100%

Successfully installed pyngo


Features 🎉

Using Pydantic to Build your Models in Django Project.
Using OpenAPI utilities to build params from a basic model.
using QueryDictModel to build Pydantic models from a QueryDict object.
propagate any errors from Pydantic in Django Rest Framework.
Tested in Python 3.10 and up.

Examples 📚
OpenAPI

pyngo.openapi_params() can build params from a basic model

from pydantic import BaseModel
from pyngo import openapi_params

class Model(BaseModel):
bingo: int

print(openapi_params(Model))


pyngo.ParameterDict.required is set according to the type of the variable

from typing import Optional
from pydantic import BaseModel
from pyngo import openapi_params

class Model(BaseModel):
required_param: int
optional_param: Optional[int]

print(openapi_params(Model))

Other fields can be set through the field’s info:
from pydantic import BaseModel, Field
from pyngo import openapi_params

class WithDescription(BaseModel):
described_param: str = Field(
description="Hello World Use Me!"
)

class InPath(BaseModel):
path_param: str = Field(location="path")

class WithDeprecated(BaseModel):
deprecated_field: bool = Field(deprecated=True)

class WithNoAllowEmpty(BaseModel):
can_be_empty: bool = Field(allowEmptyValue=False)

print(openapi_params(WithDescription)[0]["description"])
print(openapi_params(InPath)[0]["in"])
print(openapi_params(WithDeprecated)[0]["deprecated"])
print(openapi_params(WithNoAllowEmpty)[0]["allowEmptyValue"])

Django

pyngo.querydict_to_dict() and pyngo.QueryDictModel are conveniences for building a pydantic.BaseModel from a django.QueryDict.

from typing import List
from django.http import QueryDict
from pydantic import BaseModel
from pyngo import QueryDictModel, querydict_to_dict

class Model(BaseModel):
single_param: int
list_param: List[str]

class QueryModel(QueryDictModel):
single_param: int
list_param: List[str]

query_dict = QueryDict("single_param=20&list_param=Life")

print(Model.model_validate(querydict_to_dict(query_dict, Model)))
print(QueryModel.model_validate(query_dict))


Note: Don't forget to Setup the Django Project.

Django Rest Framework

pyngo.drf_error_details() will propagate any errors from Pydantic.

from pydantic import BaseModel, ValidationError
from pyngo import drf_error_details

class Model(BaseModel):
foo: int
bar: str

data = {"foo": "Cat"}

try:
Model.parse_obj(data)
except ValidationError as e:
print(drf_error_details(e))

Errors descend into nested fields:
from typing import List
from pydantic import BaseModel, ValidationError
from pyngo import drf_error_details

class Framework(BaseModel):
frm_id: int

class Language(BaseModel):
framework: List[Framework]

data = {"framework": [{"frm_id": "not_a_number"}, {}]}
expected_details = {
"framework": {
"0": {"frm_id": ["value is not a valid integer"]},
"1": {"frm_id": ["field required"]},
}
}

try:
Language.model_validate(data)
except ValidationError as e:
print(drf_error_details(e))

Development 🚧
Setup environment 📦
You should create a virtual environment and activate it:
python -m venv venv/

source venv/bin/activate

And then install the development dependencies:
# Install dependencies
pip install -e .[test,lint]

Run tests 🌝
You can run all the tests with:
bash scripts/test.sh


Note: You can also generate a coverage report with:

bash scripts/test_html.sh

Format the code 🍂
Execute the following command to apply pre-commit formatting:
bash scripts/format.sh

Execute the following command to apply mypy type checking:
bash scripts/lint.sh

License 🍻
This project is licensed under the terms of the MIT license.