Téléversement de fichiers avec FastAPI
FastAPI fournitFileetUploadFileDeux façons de gérer les téléversements de fichiers, prenant en charge les téléversements de fichiers autonomes et les téléversements mixtes de formulaire et de fichier.
Installer les dépendances
Le téléversement de fichiers dépend également depython-multipart:
pip install python-multipart
Utilisation de UploadFile
UploadFileest l'approche recommandée, elle fournit une interface plus riche pour accéder aux informations du fichier :
Exemple
app = FastAPI()
@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):
# Propriétés et méthodes fournies par UploadFile
return {
"filename": file.filename, # Nom du fichier
"content_type": file.content_type, # Type MIME du fichier
"size": file.size, # Taille du fichier (bytes)
}
UploadFilepropriétés et méthodes :
| Attributs/Méthodes | Type | Description |
|---|---|---|
filename | str | None | Le nom de fichier d'origine du fichier téléversé |
content_type | str | None | Le type MIME du fichier (par ex.image/png) |
file | SpooledTemporaryFile | Un objet de type fichier qui peut lire le contenu du fichier |
size | int | None | Taille du fichier (bytes) |
read() | Méthodes | Lire le contenu du fichier en tant quebytes |
write() | Méthodes | Écrire le contenu dans un fichier |
seek() | Méthodes | Déplacer la position du pointeur de fichier |
close() | Méthodes | Fermer un fichier |
UploadFileUtilise "SpooledTemporaryFile" pour stocker le contenu du fichier. Lorsque le fichier est petit, il est conservé en mémoire ; lorsqu'il est volumineux, il est automatiquement écrit sur le disque, donc il est plusbytesPlus économe en mémoire.
Utiliser File pour recevoir le contenu du fichier
FileLire directement le contenu du fichier en tant quebytes, adapté aux petits fichiers :
Exemple
app = FastAPI()
@app.post("/files/")
async def create_file(file: bytes = File()):
# file correspond aux données brutes en octets du fichier
return {"file_size": len(file)}
FileetUploadFilecomparaison :
| Élément de comparaison | File | UploadFile |
|---|---|---|
| Types de données | bytes | Objet File |
| Utilisation de la mémoire | Charger l'intégralité du fichier en mémoire | Les fichiers volumineux sont automatiquement écrits sur le disque |
| Informations sur le fichier | Aucune (uniquement le contenu) | Possède un nom de fichier, un type, une taille |
| Scénarios applicables | petit fichier | Scénarios avec des fichiers volumineux ou nécessitant des informations sur le fichier |
Téléversement de fichier facultatif
Utiliser la valeur par défautNoneRendre le téléversement de fichier facultatif :
Exemple
app = FastAPI()
@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile | None = Aucune):
if not file:
return {"message": "Aucun fichier téléversé"}
return {"filename": file.filename}
Téléversement de plusieurs fichiers
Utilisez une liste pour recevoir plusieurs fichiers :
Exemple
app = FastAPI()
@app.post("/uploadfiles/")
async def create_upload_files(files: list[UploadFile]):
return {"filenames": [file.filename for file in files]}
Téléversement mixte de formulaire et de fichier
Vous pouvez recevoir des données de formulaire et des fichiers simultanément dans la même route :
Exemple
app = FastAPI()
@app.post("/items/")
async def create_item(
# Champs de formulaire
name: str = Form(...),
description: str | None = Form(None),
# Téléversement de fichier
file: UploadFile | None = None,
):
result = {"name": name, "description": description}
if file:
result["filename"] = file.filename
return result
Enregistrer le fichier téléversé
L'exemple suivant montre comment enregistrer les fichiers téléversés sur le disque :
Exemple
from fastapi import FastAPI, UploadFile
app = FastAPI()
@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):
# Enregistrer le fichier téléversé dans le chemin spécifié
with open(f"uploads/{file.filename}", "wb") as buffer:
shutil.copyfileobj(file.file, buffer)
return {"filename": file.filename, "message": "Fichier téléversé avec succès"}
Dans les projets réels, lors du téléversement de fichiers, notez : 1) Validez le type et la taille du fichier ; 2) Utilisez des noms de fichiers sûrs (évitez les attaques par traversée de chemin) ; 3) Restreignez les permissions sur le répertoire de téléversement ; 4) Pour les fichiers volumineux, utilisez le streaming au lieu de tout lire d'un coup.
Résumé
- Recommandé
UploadFile, cela économise davantage de mémoire et fournit des informations riches sur le fichier FileAdapté aux scénarios de petits fichiers, lu directement commebytes- Utilisation
list[UploadFile]Recevoir plusieurs téléversements de fichiers - formulaire (
Form) et fichier (UploadFile) peut être utilisé dans la même route - Faites attention à la sécurité lors du téléversement de fichiers : validez les types de fichiers, utilisez des noms de fichiers sûrs et limitez les tailles