Skip to main content

A request parameter checking and parsing library

Project description

sanic-dantic

Travis (.com) Codecov Downloads PyPI - Python Version PyPI PyPI - License Docs

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sanic-dantic-1.2.2.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

sanic_dantic-1.2.2-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file sanic-dantic-1.2.2.tar.gz.

File metadata

  • Download URL: sanic-dantic-1.2.2.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for sanic-dantic-1.2.2.tar.gz
Algorithm Hash digest
SHA256 5a527baf2b2e86a885236912756a73f9dd21e5d72d65c8322f25f95d2a36a868
MD5 6e219c2d70432fc34e7287fef662954f
BLAKE2b-256 0e458e527f075f2ff923dde29917d3a2f0a7eedfe669fa978bb7648b8807f468

See more details on using hashes here.

File details

Details for the file sanic_dantic-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sanic_dantic-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 850568f8c046ec6643e96aa7152ae46fafe225f3a969aa1e2e4702a52ec26db5
MD5 d631fd7dc054de96f2d33e1eb61ce37c
BLAKE2b-256 0b48526cca2369ff566aab69a881d214b30d9a40e95cf5f3dfce8b156c605b09

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page