FastAPI 请求文件

2022-05-05 19:04:31 阅读：210 来源： 互联网

标签：文件请求 UploadFile FastAPI bytes file async

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

from fastapi import FastAPI, File, UploadFile

app = FastAPI()


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


@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile = File(...)):
    return {"filename": file.filename}

如果把路径操作函数参数的类型声明为 bytes，FastAPI 将以 bytes 形式读取和接收文件内容。

这种方式把文件的所有内容都存储在内存里，适用于小型文件。

不过，很多情况下，UploadFile 更好用。

UploadFile 与 bytes 相比有更多优势：

使用 spooled 文件：
- 存储在内存的文件超出最大上限时，FastAPI 会把文件存入磁盘
这种方式更适于处理图像、视频、二进制文件等大型文件，好处是不会占用所有内存
可获取上传文件的元数据
自带 file-like async 接口
暴露的 Python SpooledTemporaryFile 对象，可直接传递给其它预期file-like对象的库

`UploadFile`¶

UploadFile 的属性如下：

filename：上传文件名字符串，例如， myimage.jpg
content_type：内容类型（MIME 类型 / 媒体类型）字符串，例如，image/jpeg
file： SpooledTemporaryFile（ file-like 对象）。这个对象其实就是 Python文件，可直接传递给其它预期 file-like 对象的函数或支持库

UploadFile 支持以下 async 方法，（使用内部 SpooledTemporaryFile）可调用相应的文件方法。

write(data)：把 data （str 或 bytes）写入文件
read(size)：按指定数量的字节或字符（size (int)）读取文件内容
seek(offset)：移动至文件 offset （int）字节处的位置
- 例如，await myfile.seek(0) 移动到文件开头
- 执行 await myfile.read() 后，需再次读取已读取内容时，这种方法特别好用
close()：关闭文件

上述方法都是 async 方法，要搭配 await 使用。

例如，在 async 路径操作函数 内，要用以下方式读取文件内容：

contents = await myfile.read()

在普通 def 路径操作函数 内，则可以直接访问 UploadFile.file，例如：

contents = myfile.file.read()

多文件上传

FastAPI 支持同时上传多个文件。

使用同一个表单字段可以发送含多个文件的表单数据。

上传多个文件时，要声明含 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] = File(...)):
    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 的列表。

标签：文件,请求,UploadFile,FastAPI,bytes,file,async
来源： https://www.cnblogs.com/litianming/p/16225910.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

FastAPI 请求文件

UploadFile¶

多文件上传

`UploadFile`¶