pythonasyncioapiasyncfastapiframeworkjsonjson-schemaopenapiopenapi3pydanticpython-typespython3redocreststarletteswaggerswagger-uiuvicornweb
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
122 lines
2.9 KiB
122 lines
2.9 KiB
from datetime import datetime, timezone
|
|
from enum import Enum
|
|
|
|
import pytest
|
|
from fastapi.encoders import jsonable_encoder
|
|
from pydantic import BaseModel, ValidationError
|
|
|
|
try:
|
|
from pydantic import Field
|
|
except ImportError: # pragma: nocover
|
|
# TODO: remove when removing support for Pydantic < 1.0.0
|
|
from pydantic import Schema as Field
|
|
|
|
|
|
class Person:
|
|
def __init__(self, name: str):
|
|
self.name = name
|
|
|
|
|
|
class Pet:
|
|
def __init__(self, owner: Person, name: str):
|
|
self.owner = owner
|
|
self.name = name
|
|
|
|
|
|
class DictablePerson(Person):
|
|
def __iter__(self):
|
|
return ((k, v) for k, v in self.__dict__.items())
|
|
|
|
|
|
class DictablePet(Pet):
|
|
def __iter__(self):
|
|
return ((k, v) for k, v in self.__dict__.items())
|
|
|
|
|
|
class Unserializable:
|
|
def __iter__(self):
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def __dict__(self):
|
|
raise NotImplementedError()
|
|
|
|
|
|
class ModelWithCustomEncoder(BaseModel):
|
|
dt_field: datetime
|
|
|
|
class Config:
|
|
json_encoders = {
|
|
datetime: lambda dt: dt.replace(
|
|
microsecond=0, tzinfo=timezone.utc
|
|
).isoformat()
|
|
}
|
|
|
|
|
|
class RoleEnum(Enum):
|
|
admin = "admin"
|
|
normal = "normal"
|
|
|
|
|
|
class ModelWithConfig(BaseModel):
|
|
role: RoleEnum = None
|
|
|
|
class Config:
|
|
use_enum_values = True
|
|
|
|
|
|
class ModelWithAlias(BaseModel):
|
|
foo: str = Field(..., alias="Foo")
|
|
|
|
|
|
def test_encode_class():
|
|
person = Person(name="Foo")
|
|
pet = Pet(owner=person, name="Firulais")
|
|
assert jsonable_encoder(pet) == {"name": "Firulais", "owner": {"name": "Foo"}}
|
|
|
|
|
|
def test_encode_dictable():
|
|
person = DictablePerson(name="Foo")
|
|
pet = DictablePet(owner=person, name="Firulais")
|
|
assert jsonable_encoder(pet) == {"name": "Firulais", "owner": {"name": "Foo"}}
|
|
|
|
|
|
def test_encode_unsupported():
|
|
unserializable = Unserializable()
|
|
with pytest.raises(ValueError):
|
|
jsonable_encoder(unserializable)
|
|
|
|
|
|
def test_encode_custom_json_encoders_model():
|
|
model = ModelWithCustomEncoder(dt_field=datetime(2019, 1, 1, 8))
|
|
assert jsonable_encoder(model) == {"dt_field": "2019-01-01T08:00:00+00:00"}
|
|
|
|
|
|
def test_encode_model_with_config():
|
|
model = ModelWithConfig(role=RoleEnum.admin)
|
|
assert jsonable_encoder(model) == {"role": "admin"}
|
|
|
|
|
|
def test_encode_model_with_alias_raises():
|
|
with pytest.raises(ValidationError):
|
|
model = ModelWithAlias(foo="Bar")
|
|
|
|
|
|
def test_encode_model_with_alias():
|
|
model = ModelWithAlias(Foo="Bar")
|
|
assert jsonable_encoder(model) == {"Foo": "Bar"}
|
|
|
|
|
|
def test_custom_encoders():
|
|
class safe_datetime(datetime):
|
|
pass
|
|
|
|
class MyModel(BaseModel):
|
|
dt_field: safe_datetime
|
|
|
|
instance = MyModel(dt_field=safe_datetime.now())
|
|
|
|
encoded_instance = jsonable_encoder(
|
|
instance, custom_encoder={safe_datetime: lambda o: o.isoformat()}
|
|
)
|
|
assert encoded_instance["dt_field"] == instance.dt_field.isoformat()
|
|
|