上传文件

官方地址：https://fastapi.tiangolo.com/zh/tutorial/request-files/

因为上传文件以「表单数据」形式发送, 要预先安装 python-multipart：pip install python-multipart

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):
    return {"filename": file.filename}

声明文件体必须使用 File，否则，FastAPI 会把该参数当作查询参数或请求体（JSON）参数。

文件作为「表单数据」上传。
如果把路径操作函数参数的类型声明为 bytes，FastAPI 将以 bytes 形式读取和接收文件内容。这种方式把文件的所有内容都存储在内存里，适用于小型文件。
不过，很多情况下，UploadFile 更好用。

UploadFile 与 bytes 相比有更多优势：

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

UploadFile 的属性如下：

  • filename：上传文件名字符串（str），例如， myimage.jpg；
  • content_type：内容类型（MIME 类型 / 媒体类型）字符串（str），例如，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()

使用 async 方法时，FastAPI 在线程池中执行文件方法，并 awiat 操作完成。

多文件上传

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]):
    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）。

注意，截至 2019 年 4 月 14 日，Swagger UI 不支持在同一个表单字段中上传多个文件。不过，FastAPI 已通过 OpenAPI 标准与之兼容。因此，只要 Swagger UI 或任何其他支持 OpenAPI 的工具支持多文件上传，都将与 FastAPI 兼容。

也可以使用 from starlette.responses import HTMLResponse。fastapi.responses 其实与 starlette.responses 相同，只是为了方便开发者调用。实际上，大多数 FastAPI 的响应都直接从 Starlette 调用。

示例代码(使用html文件)

具体可以看这篇文章：https://www.cnblogs.com/sanduzxcvbnm/p/12781125.html

├── main.py
└── templates
    └── index.html
    └── post.html

main.py

# -*- coding: UTF-8 -*-

from typing import List
from fastapi import FastAPI, File, UploadFile, Request
from fastapi.templating import Jinja2Templates

app = FastAPI()
templates = Jinja2Templates(directory="templates")


@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(request: Request):
    return templates.TemplateResponse('post.html', {'request': request})


if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

templates/index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
    <meta name="description" content="">
    <meta name="author" content="">
    <!-- <link rel="icon" href="../../favicon.ico"> -->

    <!-- <title>Signin Template for Bootstrap</title> -->

    <!-- Bootstrap core CSS -->
    <!-- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous"> -->


    <!-- Custom styles for this template -->
    <!-- <link href="../static/css/signin.css" rel="stylesheet"> -->

  </head>

  <body>

    <div class="container">
      <h1>NO.1</h1>
      <h2>File Name：{{ filenames }}</h2>
      <h2>File Size：{{ file_sizes }}</h2>

      <h1>NO.2</h1>
      <h2>File Size：{{ file_size }}</h2>
      <h2>File Notes：{{ notes }}</h2>
      <h2>File Type：{{ fileb_content_type }}</h2>
    </div> <!-- /container -->


  </body>
</html>

templates/post.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>单个文件</h1>
<form action="/files/" enctype="multipart/form-data" method="post">
<input name="files" type="file"> <!--multiple参数支持一次性传多个文件，若添加multiple参数则就变成多文件上传了-->
<input type="submit">
</form>

<h1>多个文件</h1>
<form action="/uploadfiles/" method="post" enctype="multipart/form-data">
    <input type="file" name="files" multiple> <!--multiple参数支持一次性传多个文件-->
    <input type="submit">
</form>

</body>
</html>
posted @   哈喽哈喽111111  阅读(279)  评论(0)  编辑  收藏  举报
相关博文：
· 静态文件：Static Files
· Form表单数据
· FastAPI 请求文件
· FastAPI（24）- 详解 File，上传文件
· 表单数据、请求文件
阅读排行：
· 分享4款.NET开源、免费、实用的商城系统
· 全程不用写代码，我用AI程序员写了一个飞机大战
· MongoDB 8.0这个新功能碉堡了，比商业数据库还牛
· 白话解读 Dapr 1.15：你的「微服务管家」又秀新绝活了
· 上周热点回顾（2.24-3.2）
点击右上角即可分享
微信分享提示