使用File實現文件上傳
使用UploadFile實現文件上傳
UploadFile的屬性
設置上傳文件是可選的
上傳多個文件
知識點補充
使用File實現文件上傳使用Form表單上傳文件,fastapi使用File
獲取上傳的文件。
指定了參數類型是bytes:file: bytes = File()
,此時會將文件內容全部讀取到內存,比較適合小文件。
使用File
需要提前安裝 python-multipart
from fastapi import FastAPI, File app = FastAPI() @app.post("/files/")async def create_file(file: bytes = File()): return {"file_size": len(file)}
只要在路徑操作函數中聲明了變量的類型是bytes
且使用了File,
則fastapi會將上傳文件的內容全部去讀到參數中。
對於大文件,不適合將文件內容全部讀取到內存中,此時使用UploadFile
from fastapi import FastAPI, UploadFile app = FastAPI() @app.post("/uploadfile/")async def create_upload_file(file: UploadFile): return {"filename": file.filename}
和bytes
相比,使用UploadFile
有如下好處:
不需要在使用File()
作為路徑操作函數中參數的默認值
不會把文件內容全部加載到內存中,而是批量讀取一定量的數據,邊讀邊存硬盤。
可以獲取文件的元數據。
該類型的變量可以像文件變量一樣操作。
UploadFile的屬性filename:類型是str,用來獲取文件的名字,比如:myimage.png
content_type: 類型是str, 用來獲取文件的類型,比如:image/png
file: 類文件對象,是一個標准的python文件對象
除了這四個基礎屬性外,UploadFile還有三個async
方法:
write, 將str或者bytes寫到文件中
read: 讀文件
seek: 移動光標
close: 關閉文件
# 獲取文件內容 contents = await myfile.read()
設置上傳文件是可選的設置默認值是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
from typing import List from fastapi import FastAPI, File, UploadFile 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]}
知識點補充1.FastAPI簡介
FastAPI是什麼
FastAPI是一個現代的,快速(高性能)python web框架。基於標准的python類型提示,使用python3.6+構建API的Web框架。
FastAPI的主要特點如下:
快速:非常高的性能,與NodeJS和Go相當(這個要感謝Starlette和Pydantic),是最快的Python框架之一。
快速編碼:將開發速度提高約200%到300%。
更少的bug:減少大約40%的開發人員人為引起的錯誤。
直觀:強大的編輯器支持,調試時間更短。
簡單:易於使用和學習。減少閱讀文檔的時間。
代碼簡潔:盡量減少代碼重復。每個參數可以聲明多個功能,減少程序的bug。
健壯:生產代碼會自動生成交互式文檔。
基於標准:基於並完全兼容API的開放標准:OpenAPI和JSON模式。
FastAPI 站在巨人的肩膀上:
Starlette 用於構建 Web 部件。
Pydantic 用於數據部分。
環境准備
安裝fastapi
pip install fastapi
對於生產環境,還需要一個ASGI服務器,如Uvicorn或Hypercorn
pip install "uvicorn[standard]"
入門示例程序
新建一個main.py,編寫如下程序:
from fastapi import FastAPIapp = FastAPI()@app.get("/")def read_root():return {"Hello": "World"}@app.get("/items/{item_id}")def read_item(item_id: int, q: str = None):return {"item_id": item_id, "q": q}
運行程序:
uvicorn main:app --reload
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [28720]
INFO: Started server process [28722]
INFO: Waiting for application startup.
INFO: Application startup complete.
到此這篇關於Python利用fastapi實現上傳文件的文章就介紹到這了,更多相關Python fastapi上傳文件內容請搜索軟件開發網以前的文章或繼續浏覽下面的相關文章希望大家以後多多支持軟件開發網!