首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >FastAPI(11)- 函数参数类型是列表,但不使用 typing 中的 List,而使用 list,会怎么样?

FastAPI(11)- 函数参数类型是列表,但不使用 typing 中的 List,而使用 list,会怎么样?

作者头像
小菠萝测试笔记
发布2021-09-27 15:46:39
发布2021-09-27 15:46:39
4.2K00
代码可运行
举报
运行总次数:0
代码可运行
使用 typing 中的 List、Set、Tuple 的栗子
代码语言:javascript
代码运行次数:0
运行
复制
from typing import Optional

import uvicorn
from fastapi import FastAPI, Body
from typing import List, Tuple, Set

app = FastAPI()


@app.put("/items/{item_id}")
async def update_item(
        list_: List[int] = Body(...),
        tuple_: Tuple[int] = Body(...),
        set_: Set[int] = Body(...),
):
    results = {"list_": list_, "tuple_": tuple_, "set_": set_}
    return results


if __name__ == "__main__":
    uvicorn.run(app="9_typing:app", host="127.0.0.1", port=8080, reload=True, debug=True)
期望得到的请求体
代码语言:javascript
代码运行次数:0
运行
复制
{
    "list_": [
        0,
        1
    ],
    "tuple_": [
        0,
        2
    ],
    "set_": [
        0,
        3
    ]
}
假设里面的元素传了非 int 且无法自动转换成 int
  • typing 的 List、Set、Tuple 都会指定里面参数的数据类型
  • 而 FastAPI 会对声明了数据类型的数据进行数据校验,所以会针对序列里面的参数进行数据校验
  • 如果校验失败,会报一个友好的错误提示

使用 list、set、tuple 的栗子

用 Python 自带的 list、set、tuple 类,是无法指定序列里面参数的数据类型,所以 FastAPI 并不会针对里面的参数进行数据校验

代码语言:javascript
代码运行次数:0
运行
复制
@app.put("/items/{item_id}")
async def update_item(
        list_: list = Body(...),
        tuple_: tuple = Body(...),
        set_: set = Body(...),
):
    results = {"list_": list_, "tuple_": tuple_, "set_": set_}
    return results

变成传啥类型的值都可以

总结

要充分利用 FastAPI 的优势,强烈建议用 typing 的 List、Set、Tuple 来表示列表、集合、元组类型

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2021-09-19 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 使用 typing 中的 List、Set、Tuple 的栗子
  • 期望得到的请求体
  • 假设里面的元素传了非 int 且无法自动转换成 int
  • 使用 list、set、tuple 的栗子
  • 总结
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档