Add type hints support to Falcon with Pydantic and Marshmallow integration
Project description
Falcon typing
Use type hints to specify request parameters with Marshmallow and Pydantic support.
**Uses typedjson
Example
"""API."""
from typing import Optional, Union
from pydantic import BaseModel as PydanticModel
from falcontyping import TypedAPI, TypedResource
class UserV1(PydanticModel):
username: str
class UserV2(PydanticModel):
username: str
balance: float
class UsersResource(TypedResource):
def on_post(self, request, response, user: Union[UserV2, UserV1]) -> Union[UserV2, UserV1]:
if isinstance(user, UserV2):
return UserV2(username=user.username, balance=user.balance)
else:
return UserV1(username=user.username)
class UserDetailsResource(TypedResource):
def on_get(self, request, response, user_id: int) -> Optional[Union[UserV2, UserV1]]:
if user_id == 2:
return UserV2(username='user', balance=0.0)
if user_id == 1:
return UserV1(username='user')
return None
API = TypedAPI()
API.add_route('/users', UserResource())
API.add_route('/users/{user_id}', UserDetailsResource())
How to install
pip install falcontyping
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
falcontyping-0.3.3.tar.gz
(9.4 kB
view hashes)
Built Distribution
Close
Hashes for falcontyping-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7c02c0b380b818668d134ea63db5dda603d214a3fb671c0be707d9d79c8e902 |
|
MD5 | 0a00a59b7c244eddef46207e3c613132 |
|
BLAKE2b-256 | e75a38ae0c24ef122f3a0202abd337498d71aad3c3c5ffe7cc3c31e4cbfa7b6d |