pait 1.0.0a1

Pait is a Python api tool. Pait enables your Python web framework to have type checking, parameter type conversion, interface document generation and can display your documents through Redoc or Swagger (power by inspect, pydantic)

Python Modern API Tools, fast to code

---

Documentation: https://so1n.me/pait/

中文文档: https://so1n.me/pait-zh-doc/

---

pait

Pait is an api tool that can be used in any python web framework (currently only flask, starlette, sanic, tornado are supported, other frameworks will be supported once Pait is stable).

Note:

mypy check 100%

test coverage 95%+ (exclude api_doc)

python version >= 3.7 (support postponed annotations)

The following code does not specify, all default to use the starlette framework.

Warning

There are changes between the current version and the 0.8 version of the API, For more information, please refer to 0.9.0version change

Feature

• Parameter checksum automatic conversion (parameter check depends on Pydantic)
• Parameter dependency verification
• Automatically generate openapi files
• Swagger, Redoc route
• gRPC Gateway route
• TestClient support, support response result verification
• Support for plugin extensions, such as the Mock plugin

Installation

pip install pait

Simple Example

from typing import Type
import uvicorn  # type: ignore
from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route

from pait.app.starlette import pait, add_doc_route
from pait.field import Body
from pait.model.response import PaitResponseModel
from pydantic import BaseModel, Field


class DemoResponseModel(PaitResponseModel):
    class ResponseModel(BaseModel):
        uid: int = Field()
        user_name: str = Field()

    description: str = "demo response"
    response_data: Type[BaseModel] = ResponseModel


@pait(response_model_list=[DemoResponseModel])
async def demo_post(
    uid: int = Body.i(description="user id", gt=10, lt=1000),
    user_name: str = Body.i(description="user name", min_length=2, max_length=4)
) -> JSONResponse:
    return JSONResponse({'uid': uid, 'user_name': user_name})


app = Starlette(routes=[Route('/api', demo_post, methods=['POST'])])
add_doc_route(app)
uvicorn.run(app)

How to used in other web framework?

If the web framework is not supported, which you are using.

Can be modified sync web framework according to pait.app.flask

Can be modified async web framework according to pait.app.starlette

IDE Support

While pydantic will work well with any IDE out of the box.

• PyCharm plugin
• Mypy plugin

Full example

For more complete examples, please refer to example