请求文件

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

File 用于定义客户端的上传文件。因为上传文件以「表单数据」形式发送。所以接收上传文件，要预先安装 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）参数。
File 是直接继承自 Form 的类。
从 fastapi 导入的 Query、Path、File 等项，实际上是返回特定类的函数。

文件作为「表单数据」上传。

如果把路径操作函数参数的类型声明为 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 操作完成。

表单数据

HTML 表单（<form></form>）向服务器发送数据通常使用「特殊」的编码。FastAPI 要确保从正确的位置读取数据，而不是读取 JSON。

不包含文件时，表单数据一般用 application/x-www-form-urlencoded「媒体类型」编码。
但表单包含文件时，编码为 multipart/form-data。使用了 File，FastAPI 就知道要从请求体的正确位置获取文件。

可在一个路径操作中声明多个 File 和 Form 参数，但不能同时声明要接收 JSON 的 Body 字段。因为此时请求体的编码是 multipart/form-data，不是 application/json。这不是 FastAPI 的问题，而是 HTTP 协议的规定。

多文件上传

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 调用。

代码示例

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

main.py

# -*- coding: UTF-8 -*-
from typing import List
from starlette.requests import Request
from fastapi import FastAPI, Form, File, UploadFile
from starlette.templating import Jinja2Templates

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


@app.post("/files/")
async def files(
        request: Request,
        files_list: List[bytes] = File(...),
        files_name: List[UploadFile] = File(...),
):
    return templates.TemplateResponse("index.html",
                                      {
                                          "request": request,
                                          "file_sizes": [len(file) for file in files_list],
                                          "filenames": [file.filename for file in files_name],
                                      })


@app.post("/create_file/")
async def create_file(
        request: Request,
        file: bytes = File(...),
        fileb: UploadFile = File(...),
        notes: str = Form(...),
):
    return templates.TemplateResponse("index.html",
                                      {
                                          "request": request,
                                          "file_size": len(file),
                                          "notes": notes,
                                          "fileb_content_type": fileb.content_type,
                                      })


@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>

<form action="/files/" enctype="multipart/form-data" method="post">
    <input name="files_list" type="file" multiple><br><br>
    <input name="files_name" type="file" multiple><br><br>
    <input type="submit" value="点击这里显示文件名字与大小">
</form>
<br><br><br>


<form action="/create_file/" enctype="multipart/form-data" method="post">
    <input name="file" type="file" multiple><br><br>
    <input name="fileb" type="file" multiple><br><br>
    <input name="notes" type="text" multiple><br><br>
    <input type="submit" value="点击这里显示文件属性">
</form>

<!--multiple参数支持一次性传多个文件-->
</body>
</html>

本地保存上传的文件代码示例

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

app = FastAPI()
# 挂载模板文件夹
tmp = Jinja2Templates(directory='templates')

@app.get('/')  # 接受get请求
async def get_file(request: Request):
    return tmp.TemplateResponse('file.html', {'request': request})

# 单个文件
@app.post('/file/')  # 接受post请求
async def get_user(request: Request,
                   file: bytes = File(...),       # # 把文件对象转为bytes类型,这种类型的文件无法保存
                   file_obj: UploadFile = File(...),    # UploadFile转为文件对象，可以保存文件到本地
                   info: str = Form(...)    # 获取普通键值对
                   ):

    # 保存上传的文件
    contents = await file_obj.read()
    with open("static/file/" + file_obj.filename, "wb") as f:
        f.write(contents)

    return tmp.TemplateResponse('index.html', {
        'request': request,
        'file_size': len(file),
        'file_name': file_obj.filename,
        'info':info,
        'file_content_type':file_obj.content_type
    })

# 多个文件
@app.post('/files/')
async def get_files(request:Request,    
                    files_list:List[bytes] = File(...),  # [文件1的二进制数据,文件2的二进制数据]
                    files_obj_list:List[UploadFile]=File(...)  # [file_obj1,file_obj2,....] # 文件框里可以同时上传多个文件
                    ):

    # 保存上传的多个文件
    for file in files_obj_list:
        contents = await file.read()
        filename = file.filename
        with open("static/file/" + filename, "wb") as f:
            f.write(contents)

    return tmp.TemplateResponse('index.html',
                                {'request':request,
                                 'file_sizes':[len(file) for file in files_list],
                                 'file_names':[file_obj.filename for file_obj in files_obj_list]
                                 }
                                )

if __name__ == '__main__':
    import uvicorn

    uvicorn.run(app, host='127.0.0.1', port=8080)

# html页面文件内容，有俩html文件
{#  file.html  #}
<body>
<h1>单个文件</h1>
<form action="/file/" method="post" enctype="multipart/form-data">
    <input type="file" name="file">
    <input type="file" name="file_obj">
    <input type="text" name="info">
    <input type="submit">
</form>

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

{#  index.html  #}
<body>
<h2>单个文件</h2>
<h1>{{ file_size }}</h1>
<h1>{{ file_name }}</h1>
<h1>{{ info }}</h1>
<h1>{{ file_content_type }}</h1>

<h2>多个文件</h2>
<h1>{{ file_sizes }}</h1>
<h1>{{ file_names }}</h1>
</body>
</html>

posted @ 2022-02-21 10:42 哈喽哈喽111111 阅读(217) 评论(0) 编辑收藏举报

刷新页面返回顶部