반응형
File 클래스를 이용하면 클라이언트가 업로드하는 file을 다룰 수 있다.
사용법은 다음과 같다.
File클래스를 import하고 UploadFile로 type 지정해준다.
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 = File(...)):
return {"filename": file.filename}async def create_file(file: bytes = File(...)):
File클래스는 앞서배운 Form 클래스를 상속한다.
(그러나 Query, Path, File 그리고 다른 fastapi 클래스를 임포트할때, 이들은 사실 클래스를 리턴하는 함수임을 기억!)
그러므로 file들은 form data로 업로드 된다.
File클래스를 사용하지 않고 path parameter로 bytes를 선언했다면, FastAPI는 파일을 읽고 bytes형태로 제공해준다.
그리고 이것들은 전부다 메모리에 저장된다. 작은파일에는 이게 효율적이다.
하지만 UploadFile type을 사용하는데 몇가지 이점이 있다.
File parameters with UploadFile
UploadFile을 사용하는건 bytes에 대비하여 아래와 같은 장점이 있다.
- 스풀링 파일을 사용한다. 메모리에 저장되는 파일의 사이즈는 제한되어있고, 사이즈의 제한이 넘으면 disk에 파일을 저장한다. 스풀링에 대한 자세한설명은 이곳을 참조하자.(https://namu.wiki/w/%EC%8A%A4%ED%92%80%EB%A7%81)
- 스풀링을 사용함으로서 이미지나 비디오혹은 큰사이즈의 파일들을 메모리를 전부다 사용하지 않고 처리할 수 있다
- 업로드된 파일로부터 metadata를 받을 수 있다
- file-like async interface를 가지고 있다
- 실제로 파이썬으 SpooledTemporaryFile 을 노출한다. file-like 오브젝트처럼 다른 라이브러리에 넘길 수 있다
반응형
UploadFile은 다음과 같은 attributes를 가진다.
- filename : str자료형이고 파일이름을 담는다
- content_type : str자료형이고 content type을 담는다. e.g image/jpeg
- file : SpooledTemporaryFile(file-like object) 실제 파일 데이터이고 file-like를 expect하는 다른 함수나 라이브러리에 전달 할 수 있다
UploadFile은 하기의 async 메소드들을 가지고 있다
- write(data) : data(str 또는 bytes)를 write한다
- read(size) : size(int) 만큼 bytes/character 를 읽어드린다.
- seek(offset) : 파일의 offset(int) 만큼 위치 이동한다
- close() : 파일을 종료한다
위 함수들은 모두 async이므로 사용할 때 await를 해주어야 한다
contents = await myfile.read()
Multiple file uploads
여러개의 파일을 동시에 업로드할 때는 List[bytes]나 List[UploadFile]을 이용한다
여러개의 파일들은 form data로 전달되며 같은 form field로 묶인다.
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] = File(...)):
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)
반응형
'Fast API > fastapi배우기' 카테고리의 다른 글
| Fast API 배우기 17부 - Path Operation Configuration (0) | 2021.11.03 |
|---|---|
| Fast API 배우기 16부 - Handling Errors (1) | 2021.11.02 |
| Fast API 배우기 14부 - Form Data (0) | 2021.11.02 |
| Fast API 배우기 13부 - Response Status Code (0) | 2021.11.01 |
| Fast API 배우기 12부 - Extra Model (1) | 2021.11.01 |
댓글