Python利用fastapi實現上傳檔案

2022-06-23 14:00:53

使用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實現檔案上傳

對於大檔案，不適合將檔案內容全部讀取到記憶體中，此時使用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 FastAPI

app = 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上傳檔案內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！