Дополнительные типы данных¶
До сих пор вы использовали распространённые типы данных, такие как:
intfloatstrbool
Но вы также можете использовать более сложные типы данных.
И у вас по-прежнему будут все те же возможности, что были показаны до сих пор:
- Отличная поддержка редактора.
- Преобразование данных из входящих запросов.
- Преобразование данных для ответа.
- Валидация данных.
- Автоматическая аннотация и документация.
Другие типы данных¶
Вот некоторые из дополнительных типов данных, которые вы можете использовать:
UUID:- Стандартный «универсально уникальный идентификатор», часто используемый как ID во многих базах данных и системах.
- В запросах и ответах будет представлен как
str.
datetime.datetime:- Python
datetime.datetime. - В запросах и ответах будет представлен как
strв формате ISO 8601, например:2008-09-15T15:53:00+05:00.
- Python
datetime.date:- Python
datetime.date. - В запросах и ответах будет представлен как
strв формате ISO 8601, например:2008-09-15.
- Python
datetime.time:- Python
datetime.time. - В запросах и ответах будет представлен как
strв формате ISO 8601, например:14:23:55.003.
- Python
datetime.timedelta:- Python
datetime.timedelta. - В запросах и ответах будет представлен как
floatобщего количества секунд. - Pydantic также позволяет представлять его как «ISO 8601 time diff encoding», см. документацию для получения дополнительной информации.
- Python
frozenset:- В запросах и ответах обрабатывается так же, как
set:- В запросах будет прочитан список, удалены дубликаты и преобразован в
set. - В ответах
setбудет преобразован вlist. - Сгенерированная схема укажет, что значения
setуникальны (используяuniqueItemsиз JSON Schema).
- В запросах будет прочитан список, удалены дубликаты и преобразован в
- В запросах и ответах обрабатывается так же, как
bytes:- Стандартный Python
bytes. - В запросах и ответах будет обрабатываться как
str. - Сгенерированная схема укажет, что это
strс «форматом»binary.
- Стандартный Python
Decimal:- Стандартный Python
Decimal. - В запросах и ответах обрабатывается так же, как
float.
- Стандартный Python
- Вы можете проверить все допустимые типы данных Pydantic здесь: типы данных Pydantic.
Пример¶
Вот пример операции пути с параметрами, использующими некоторые из вышеперечисленных типов.
from datetime import datetime, time, timedelta
from typing import Annotated
from uuid import UUID
from fastapi import Body, FastAPI
app = FastAPI()
@app.put("/items/{item_id}")
async def read_items(
item_id: UUID,
start_datetime: Annotated[datetime, Body()],
end_datetime: Annotated[datetime, Body()],
process_after: Annotated[timedelta, Body()],
repeat_at: Annotated[time | None, Body()] = None,
):
start_process = start_datetime + process_after
duration = end_datetime - start_process
return {
"item_id": item_id,
"start_datetime": start_datetime,
"end_datetime": end_datetime,
"process_after": process_after,
"repeat_at": repeat_at,
"start_process": start_process,
"duration": duration,
}
🤓 Другие версии и варианты
Совет
По возможности предпочитайте версию с Annotated.
from datetime import datetime, time, timedelta
from uuid import UUID
from fastapi import Body, FastAPI
app = FastAPI()
@app.put("/items/{item_id}")
async def read_items(
item_id: UUID,
start_datetime: datetime = Body(),
end_datetime: datetime = Body(),
process_after: timedelta = Body(),
repeat_at: time | None = Body(default=None),
):
start_process = start_datetime + process_after
duration = end_datetime - start_process
return {
"item_id": item_id,
"start_datetime": start_datetime,
"end_datetime": end_datetime,
"process_after": process_after,
"repeat_at": repeat_at,
"start_process": start_process,
"duration": duration,
}
Обратите внимание, что параметры внутри функции имеют свой естественный тип данных, и вы можете, например, выполнять обычные манипуляции с датами, такие как:
from datetime import datetime, time, timedelta
from typing import Annotated
from uuid import UUID
from fastapi import Body, FastAPI
app = FastAPI()
@app.put("/items/{item_id}")
async def read_items(
item_id: UUID,
start_datetime: Annotated[datetime, Body()],
end_datetime: Annotated[datetime, Body()],
process_after: Annotated[timedelta, Body()],
repeat_at: Annotated[time | None, Body()] = None,
):
start_process = start_datetime + process_after
duration = end_datetime - start_process
return {
"item_id": item_id,
"start_datetime": start_datetime,
"end_datetime": end_datetime,
"process_after": process_after,
"repeat_at": repeat_at,
"start_process": start_process,
"duration": duration,
}
🤓 Другие версии и варианты
Совет
По возможности предпочитайте версию с Annotated.
from datetime import datetime, time, timedelta
from uuid import UUID
from fastapi import Body, FastAPI
app = FastAPI()
@app.put("/items/{item_id}")
async def read_items(
item_id: UUID,
start_datetime: datetime = Body(),
end_datetime: datetime = Body(),
process_after: timedelta = Body(),
repeat_at: time | None = Body(default=None),
):
start_process = start_datetime + process_after
duration = end_datetime - start_process
return {
"item_id": item_id,
"start_datetime": start_datetime,
"end_datetime": end_datetime,
"process_after": process_after,
"repeat_at": repeat_at,
"start_process": start_process,
"duration": duration,
}