跳转至

包速查

1 fastapi​ 包

1.1 FastAPI​

创建 FastAPI 应用实例

1.2 Query()​

校验查询参数

1
q: str | None = Query(default=None, max_length=50)

还有 min_length​ gt​ ge​ lt​ le​ 参数

  • gt​：greater than

  • ge​：greater than or equal

其余同理

  • alias​ 参数使用别名来指定查询参数的名称。 例如，可以将查询参数命名为 item-query​，但在函数中使用 q​。
  • ​title​ 和 description​ 用于在生成的 OpenAPI 文档中为查询参数添加标题和描述。

1.3 Path()​

校验路径参数

参数有 max_length​ min_length​ title​ gt​ ge​等，与Query​相同

1.4 Body()​

用在路径操作函数中，如对请求体示例的声明

1.5 HTTPException​ 类

定义了一些 Http 错误

标识 Cookie​ 参数

1.7 Header()​

标识 Header​ 请求头

1.8 Form()​

标识 Form​ 表单

1.9 Depends()​

用于依赖项注入。

1.10 fastapi.middleware.cors​

1.10.1 CORSMiddleware​ 类

用于跨域资源共享（CORS）

1
2
3
4
5
6
7
app.add_middleware(
    CORSMiddleware,
    allow_origins=["*"],  # 允许的源
    allow_credentials=True,  # 允许的凭证
    allow_methods=["*"],  # 允许的方法
    allow_headers=["*"],  # 允许的请求头
)

2 enum​ 包

2.1 Enum​ 类

Python 的 Enum 类

3.5.1 创建 Enum​ 类

3 typing​ 包

3.1 Annotated[]​

注解。

1
Annotated[数据类型, Query()/Path()]

3.2 Any​ 类型

Any 是一种特殊的类型。静态类型检查器将所有类型视为与 Any 兼容，反之亦然， Any 也与所有类型相兼容。

4 pydantic​ 包

4.1 BaseModel​ 类

自定义请求体的父类

4.2 Field()​

主要用在 Pydantic 模型（如请求体）中定义字段及属性

4.3 EmailStr​ 类

需要额外安装

1
pip install pydantic[email]

专门储存邮件地址的格式

5 pandas​ 包

文件处理包

5.1 额外安装 openpyxl​

用于处理 Excel 表格

6 sqlmodel​ 包

6.1 SQLModel​ 类

是数据库模型，继承自 Pydantic​ 类

6.2 Session​ 类

允许用户通过一些方法来访问数据库。

6.3 create_engine()​

该函数用于创建 Engine​ 引擎对象。

​Engine​ 是一个处理与数据库通信的对象。

如果您有服务器数据库（例如 PostgreSQL 或 MySQL），则引擎将保存到该数据库的网络连接。

7 python-multipart​ 包

使用表单的时候必须安装的一个包