【Python开发】FastAPI 05:表单与文件

news/2024/7/5 2:52:17

类似之前的路径参数、查询参数和请求参数,表单与文件也可以算是请求参数中的一员,不过表单与文件更为特殊一些,表单是处理键值对数据、文件则是处理文件数据(图片、音频、视频等文件)。

目录

1 请求表单数据

1.1 表单字段

1.2 Form 使用

2 请求文件

2.1 File 使用

2.2 UploadFile 使用

2.3 更多方式

① 可选文件上传

② 多文件上传


📌源码地址:

https://gitee.com/yinyuu/fast-api_study_yinyu

1 请求表单数据

1.1 表单字段

HTML 表单(<form></form>)向服务器发送数据通常使用「特殊」的编码。

比如👇,包含一个普通输入框和一个密码输入框:

<form action="">
Username: <input type="text" name="username"><br>
Password: <input type="password" name="password">
</form>

FastAPI 的目的是要确保从正确的位置读取数据,而不是读取 JSON

表单数据的「媒体类型」编码一般为 application/x-www-form-urlencoded

HTTP 协议规定:可在一个路径操作中声明多个 Form 参数,但不能同时声明接收 JSON 的 Body 字段,此时请求体的编码是 application/x-www-form-urlencoded,而不是不是 application/json。 

1.2 Form 使用

如果接口接收的不是 JSON,而是表单字段时,要使用 Form。

预先安装:pip install python-multipart

from fastapi import FastAPI, Form #从 fastapi 导入 Form

app = FastAPI()


@app.post("/login/")
async def login(username: str = Form(), password: str = Form()): #定义 Form 参数
    return {"username": username}

创建表单(Form)参数的方式与 Body Query 一样,也可以使用 default、description、title、gt 等元数据和验证!

OAuth2 规范的 "密码流" 模式规需要通过表单字段发送 username password。 该规范要求字段必须命名为 username password,并通过表单字段发送,不能用 JSON

2 请求文件

2.1 File 使用

File 用于定义客户端的上传文件。

预先安装:pip install python-multipart

from fastapi import FastAPI, File, UploadFile #从 fastapi 导入 File

app = FastAPI()


@app.post("/files/")
async def create_file(file: bytes = File()): #定义 File 参数
    return {"file_size": len(file)}

创建文件(File参数的方式与 Body Query 一样,也可以使用 default、description、title、gt 等元数据和验证!

此时路径操作函数参数的类型声明为 bytesFastAPI 将以 bytes 形式读取和接收文件内容。这种方式把文件的所有内容都存储在内存里,适用于小型文件

上传文件以「表单数据」形式发送,表单包含文件时,编码为 multipart/form-data。使用了 FileFastAPI 就知道要从请求体的正确位置获取文件。

2.2 UploadFile 使用

很多情况下,UploadFile 更好用。

from fastapi import FastAPI, UploadFile #从 fastapi 导入 UploadFile

app = FastAPI()

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile): #定义文件参数时使用 UploadFile
    return {"filename": file.filename}

📌 UploadFile 与 bytes 相比:

  • 使用 spooled 文件:存储在内存的文件超出最大上限时,FastAPI 会把文件存入磁盘;
  • 这种方式更适于处理图像、视频、二进制文件等大型文件,好处是不会占用所有内存;
  • 可获取上传文件的元数据;

📌 UploadFile 属性如下:

  • filename:上传文件名字符串(str),例如, myimage.jpg
  • content_type:内容类型(MIME 类型 / 媒体类型)字符串(str),例如,image/jpeg
  • fileSpooledTemporaryFilefile-like 对象)。其实就是 Python文件,可直接传递给其他预期 file-like 对象的函数或支持库。

2.3 更多方式

① 可选文件上传

如果熟悉其他请求参数的话,你可以通过 None 作为默认值将一个文件参数设为可选:

from typing import Union

from fastapi import FastAPI, File, UploadFile

app = FastAPI()

@app.post("/files/")
async def create_file(file: Union[bytes, None] = File(default=None)):
    if not file:
        return {"message": "No file sent"}
    else:
        return {"file_size": len(file)}

@app.post("/uploadfile/")
async def create_upload_file(file: Union[UploadFile, None] = None):
    if not file:
        return {"message": "No upload file sent"}
    else:
        return {"filename": file.filename}

② 多文件上传

可用同一个「表单字段」发送含多个文件的「表单数据」

上传多个文件时,要声明含 bytes UploadFile 的列表(List):

from typing import List

from fastapi import FastAPI, File, UploadFile
from fastapi.responses import HTMLResponse

app = FastAPI()

@app.post("/files/")
async def create_files(files: List[bytes] = File()):
    return {"file_sizes": [len(file) for file in files]}

@app.post("/uploadfiles/")
async def create_upload_files(files: List[UploadFile]):
    return {"filenames": [file.filename for file in files]}

@app.get("/")
async def main():
    content = """
<body>
<form action="/files/" enctype="multipart/form-data" method="post">
<input name="files" type="file" multiple>
<input type="submit">
</form>
<form action="/uploadfiles/" enctype="multipart/form-data" method="post">
<input name="files" type="file" multiple>
<input type="submit">
</form>
</body>
    """
    return HTMLResponse(content=content)

接收的也是含 bytes UploadFile 的列表(list)。


http://lihuaxi.xjx100.cn/news/1202215.html

相关文章

I.MX RT1170加密启动详解(4):OTFAD XIP加密运行代码

本节将介绍基于AES加密的OTFAD引擎&#xff0c;它可以在不影响AES-128-CTR性能的情况下实时解密数据。OTFAD包括对AES密钥展开机制的完整硬件支持&#xff0c;它可以解密最多4个唯一的AES上下文。每个上下文都有一个用户定义的128位的Image Encryption Key(IEK)、一个64位的计数…

centos8安装部署Oracle Database Free

前言 centos8安装部署Oracle Database Free 安装部署 服务器安装 下载centos8镜像(选择镜像&#xff1a;CentOS-Stream-8-20230523.0-x86_64-dvd1.iso)并安装系统&#xff0c;具体细节不再赘述关闭centos8服务器的防火墙与selinux&#xff0c;并配置ip 部署oracle 注&…

用于ECharts的全国省市区县乡镇街道级的行政区划边界数据(GeoJSON格式)

https://map.vanbyte.com 提供了免费的省市县3级行政边界数据(GeoJSON格式)、省市县乡4级联动数据。 至于行政区划边界数据的来源&#xff0c;网络上有各种教程。授人以鱼不如授人以渔&#xff0c;下面记录一下各类方法的具体步骤。 来源1&#xff1a;阿里云的数据可视化平台…

编程的未来 - 还有未来么?

缘起 唐门教主上个月某天深夜写了一篇博客 --《编程的未来》&#xff0c;要我谈谈感想。 这也是最近软件工程师们聊得比较多的问题&#xff0c;上周&#xff0c;在上海的 “关东小磨” 和十多位 CSDN 博主聚会的时候&#xff0c;大家也稍微谈了一下这个话题&#xff0c;但是谈…

华为OD机试 - 数据最节约的备份方法(Java JS Python)

题目描述 有若干个文件,使用刻录光盘的方式进行备份,假设每张光盘的容量是500MB,求使用光盘最少的文件分布方式 所有文件的大小都是整数的MB,且不超过500MB;文件不能分割、分卷打包 输入描述 一组文件大小的数据 输出描述 使用光盘的数量 备注 不用考虑输入数据不合法…

bat脚本代码,一键修改网卡的dns地址和恢复为DHCP获取的方式

echo off REM 指定为 Unicode 编码&#xff08;65001&#xff09;来解决中文乱码的问题 chcp 65001 >nul REM 脚本以管理员身份运行 %1 mshta vbscript:CreateObject("Shell.Application").ShellExecute("cmd.exe","/c %~s0 ::","&quo…

Gradio的web界面演示与交互机器学习模型,Blocks的事件侦听《7》

在第一篇文章我们就熟悉了Blocks的用法&#xff0c;使用Blocks比Interface更加灵活&#xff0c;这节重点关注Blocks里面的相关操作。 1、Blocks标准例子 import gradio as grdef greet(name):return "你好 " name "!"with gr.Blocks() as demo:name g…

竞赛中常用的Python 标准库

对竞赛中常用得标准库进行解析和给出代码模板 目录 1.functools 1.1 cmp_to_key 1.2 lru_cache&#xff08;记忆化存储&#xff0c;加快递归速度&#xff09; 2.collections 2.1 deque 2.1.1 单调对列实现 2.1.2 BFS广搜 3.sys 3.1 sys.maxsize 3.2 sys.exit() 3.…