FastAPI-Dateiupload

FastAPI bietetFileundUploadFileZwei Möglichkeiten, Dateiuploads zu verarbeiten, mit Unterstützung für eigenständige Dateiuploads und gemischte Formular- und Dateiuploads.


Abhängigkeiten installieren

Dateiupload hängt auch vonpython-multipart:

pip install python-multipart

Verwendung von UploadFile

UploadFileist der empfohlene Ansatz, er bietet eine reichhaltigere Schnittstelle für den Zugriff auf Dateiinformationen:

Beispiel

from fastapi import FastAPI, UploadFile

app = FastAPI()


@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):
    # Von UploadFile bereitgestellte Eigenschaften und Methoden
    return {
        "filename": file.filename,          # Dateiname
        "content_type": file.content_type,  # MIME-Typ der Datei
        "size": file.size,                  # Dateigröße (Bytes)
    }

UploadFileEigenschaften und Methoden:

Attribute/MethodenTypeBeschreibung
filenamestr | NoneDer ursprüngliche Dateiname der hochgeladenen Datei
content_typestr | NoneDer MIME-Typ der Datei (z. B.image/png)
fileSpooledTemporaryFileEin dateiähnliches Objekt, das Dateiinhalte lesen kann
sizeint | NoneDateigröße (Bytes)
read()MethodenDateiinhalt lesen alsbytes
write()MethodenInhalt in Datei schreiben
seek()MethodenDateizeigerposition verschieben
close()MethodenEine Datei schließen

UploadFileVerwendet "SpooledTemporaryFile", um Dateiinhalte zu speichern. Wenn die Datei klein ist, wird sie im Speicher gehalten; wenn die Datei groß ist, wird sie automatisch auf die Festplatte geschrieben, daher ist siebytesspeichereffizienter.


File verwenden, um Dateiinhalt zu empfangen

FileDateiinhalt direkt lesen alsbytes, geeignet für kleine Dateien:

Beispiel

from fastapi import FastAPI, File

app = FastAPI()


@app.post("/files/")
async def create_file(file: bytes = File()):
    # file enthält die rohen Byte-Daten der Datei
    return {"file_size": len(file)}

FileundUploadFileVergleich:

VergleichspunktFileUploadFile
DatentypenbytesDateiobjekt
SpeicherverbrauchDie gesamte Datei in den Speicher ladenGroße Dateien werden automatisch auf die Festplatte geschrieben
DateiinformationenKeine (nur Inhalt)Hat Dateiname, Typ, Größe
Anwendbare Szenarienkleine DateiSzenarien mit großen Dateien oder wenn Dateiinformationen benötigt werden

Optionaler Datei-Upload

Standardwert verwendenNoneDatei-Upload optional machen:

Beispiel

from fastapi import FastAPI, UploadFile

app = FastAPI()


@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile | None = Keine):
    if not file:
        return {"message": "Keine Datei hochgeladen"}
    return {"filename": file.filename}

Multi-Datei-Upload

Verwenden Sie eine Liste, um mehrere Dateien zu empfangen:

Beispiel

from fastapi import FastAPI, UploadFile

app = FastAPI()


@app.post("/uploadfiles/")
async def create_upload_files(files: list[UploadFile]):
    return {"filenames": [file.filename for file in files]}

Gemischter Formular- und Datei-Upload

Sie können Formulardaten und Dateien gleichzeitig in derselben Route empfangen:

Beispiel

from fastapi import FastAPI, File, UploadFile, Form

app = FastAPI()


@app.post("/items/")
async def create_item(
    # Formularfelder
    name: str = Form(...),
    description: str | None = Form(None),
    # Datei-Upload
    file: UploadFile | None = None,
):
    result = {"name": name, "description": description}
    if file:
        result["filename"] = file.filename
    return result

Hochgeladene Datei speichern

Das folgende Beispiel zeigt, wie hochgeladene Dateien auf der Festplatte gespeichert werden:

Beispiel

import shutil
from fastapi import FastAPI, UploadFile

app = FastAPI()


@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):
    # Speichere die hochgeladene Datei unter dem angegebenen Pfad
    with open(f"uploads/{file.filename}", "wb") as buffer:
        shutil.copyfileobj(file.file, buffer)
    return {"filename": file.filename, "message": "Datei erfolgreich hochgeladen"}

In echten Projekten beim Hochladen von Dateien beachten: 1) Dateityp und -größe validieren; 2) Sichere Dateinamen verwenden (Path-Traversal-Angriffe vermeiden); 3) Berechtigungen für das Upload-Verzeichnis einschränken; 4) Bei großen Dateien Streaming verwenden, anstatt alles auf einmal zu lesen.


Zusammenfassung

  • EmpfohlenUploadFile, es spart mehr Arbeitsspeicher und bietet umfangreiche Dateiinformationen
  • FileFür Szenarien mit kleinen Dateien geeignet, direkt gelesen alsbytes
  • Nutzunglist[UploadFile]Mehrere Datei-Uploads empfangen
  • form (Form) und file (UploadFile) kann in derselben Route verwendet werden
  • Achten Sie beim Hochladen von Dateien auf die Sicherheit: Validieren Sie Dateitypen, verwenden Sie sichere Dateinamen und begrenzen Sie Größen
Weitere Erweiterungen