A request parameter checking and parsing library based on pydantic under the sanic framework
Project description
sanic-dantic
sanic-dantic is a request parameter checking and parsing library based on pydantic under the sanic framework
sanic-dantic is a request parameter checking and parsing library based on pydantic under the sanic framework
It is based on pydantic, which can facilitate developers to quickly check and obtain request parameters
Documentation
If you want more usage, please click here
Installation
pip install sanic-dantic
Why use it
Do you have to get the request parameters first every time you process them ?
from sanic import Sanic
from sanic.response import json
app = Sanic("SanicDanticExample")
@app.route('/example')
async def path_param_examples(request):
name = request.get("name")
age = request.get("age")
if not isinstance(name, str) or not isinstance(age, int):
return json({"error":"parameter type error"})
return json({"message": f"hello {name} are you {age} years old ?"})
How terrible, and there is no good experience for developers at all.
Therefore, sanic-dantic is to help you improve your development efficiency and experience.
It allows you to skip the process of type checking and parameter acquisition.
How to use
It is based on pydantic, which can facilitate developers to quickly check and obtain request parameters
In sanic-dantic, you can pass the pydantic model to different formal parameters in parse_params to check and parse the values of different types of request parameters
You can get all the parsed parameters by appending the formal parameter , and get the value of the parameter through the attribute params
from sanic import Sanic
from sanic.response import json
from sanic_dantic import parse_params, BaseModel
class Person(BaseModel):
name: str
age: int
app = Sanic("SanicDanticExample")
@app.route('/example')
@parse_params(path=Person)
async def path_param_examples(request, params):
print( params.ctx.name, params.ctx.age)
return json({"message": f"hello {params.name} are you {params.age} years old ?"})
Do you have a crush? Come and experience it!
more usage please read the documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sanic-dantic-1.1.9.tar.gz
.
File metadata
- Download URL: sanic-dantic-1.1.9.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13801a6185bc2ddf4a7c11fec06d62f46cf3706cb90a04f29170a75350c719c8 |
|
MD5 | 8cd3a5517138352ca59b4904b52104f1 |
|
BLAKE2b-256 | fb696e05f5a3d2060cdd274912d253518342c77a5097c00480927c1af2a93986 |