[FastAPI] Form

728x90

🐰 FastAPI 공식문서를 보면서 개인적으로 정리한 글 입니다.

응답상태

HTTP에서는 응답상태에 따라 상태코드를 반환한다.

FastAPI에서는 status_code 매개변수를 사용하여 응답에 대한 HTTP 상태 코드를 선언할 수 있다.

그리고 모든 상태코드를 외울 필요 없이 fastapi의 하위 클래스 status에서 변수를 찾아 사용할 수 있다.

from fastapi import FastAPI, status

app = FastAPI()


@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

Form

Form 클래스를 사용하여 Form 필드의 동작을 제어하고 유효성 검사를 수행할 수 있다.

주요 매개변수는 다음과 같다.

default : 필드의 기본값을 설정합니다. 사용자가 해당 필드의 값을 입력하지 않은 경우 이 값이 사용됩니다.
title : 필드의 제목이나 라벨을 설정합니다. 이 값은 폼 요소에 레이블로 표시됩니다.
description : 필드에 대한 추가 설명을 설정합니다. 이 값은 폼 요소의 설명으로 표시됩니다.
min_length 및 max_length : 입력 값의 최소 길이와 최대 길이를 설정합니다.
regex : 입력 값의 형식을 정규식으로 제한합니다. 입력 값은 이 정규식과 일치해야 합니다.
deprecated : 필드가 사용되지 않도록 표시할지 여부를 설정합니다. 기본값은 False입니다.
alias : 필드의 별칭을 설정합니다. 이 값을 사용하면 필드의 이름을 다른 이름으로 사용할 수 있습니다.
ge와 le : 숫자 형식의 필드에서 사용되며, 최소값 (ge)과 최대값 (le)을 설정합니다.

from typing import Union
from fastapi import FastAPI, Form
from fastapi.responses import HTMLResponse
from pydantic import BaseModel, EmailStr
app = FastAPI()


class UserIn(BaseModel):
    username: str
    password: str
    email: EmailStr
    nickname: str


class UserOut(BaseModel):
    username: str
    email: EmailStr
    nickname: str


forms = {
    'username': {'min_length': 5, 'max_length': 15, 'title': 'Username', 'description': 'ID'},
    'password': {'min_length': 8, 'max_length': 15, 'title': 'Password', 'description': '패스워드'},
    'email': {'min_length': 5, 'max_length': 20, 'title': 'Email', 'description': '이메일'},
    'nickname': {'min_length': 2, 'max_length': 8, 'title': 'Nick_Name', 'description': '닉네임'}
}


@app.post("/user/", response_model=UserOut)
async def createUser(
    username: str = Form(..., **forms['username']),
    password: str = Form(..., **forms['password']),
    email: str = Form(..., **forms['email']),
    nickname: str = Form(..., **forms['nickname'])
):
    user = UserIn(username=username, password=password,
                  email=email, nickname=nickname)
    return user
context = """
<body>
    <form method="post" action="/user">
        ID : <input type="text" name="username"><br>
        PW : <input type="password" name="password"><br>
        Email : <input type="email" name="email"><br>
        Nickname : <input type="text" name="nickname"><br>
        <input type='submit'>
    </form>
</body>
"""


@app.get('/')
async def main():
    return HTMLResponse(context)

File

File을 사용하여 클라이언트가 업로드할 파일을 정의할 수 있다.

File 매개변수를 사용하여 파일을 받을 수 있다.(File은 Form을 상속한 자식 클래스이다.)

from fastapi import FastAPI, File

app = FastAPI()

@app.post("/file/")
async def createFile(file: bytes = File()):
    return {"file_size": len(file)}

File 대신 UploadFile을 사용할 수 있다.

스풀 파일 사용(최대 크기 제한까지만 메모리에 저장되고, 초과하는 경우 디스크에 저장)
이미지, 동영상, 큰 이진코드와 같은 대용량 파일들을 많은 메모리를 소모하지 않고 처리 가능
업로드 된 파일의 메타데이터를 얻을 수 있음
file-like async 인터페이스를 갖고 있음
file-like object를 필요로하는 다른 라이브러리에 직접적으로 전달할 수 있는 파이썬 SpooledTemporaryFile 객체 반환

UploadFile의 속성은 다음과 같다.

filename : 문자열(str)로 된 업로드된 파일의 파일명 (예: myimage.jpg).
content_type : 문자열(str)로 된 파일 형식(MIME type / media type)이다 (예: image/jpeg).
file : SpooledTemporaryFile (파일류 객체)입니다. 이것은 "파일류" 객체를 필요로하는 다른 라이브러리에 직접적으로 전달할 수 있는 실질적인 파이썬 파일이다.

UploadFile 에는 다음의 async 메소드들이 있다. 내부적인 SpooledTemporaryFile 을 사용하여 해당하는 파일 메소드를 호출한다.

write(data): data(str 또는 bytes)를 파일에 작성한다.
read(size): 파일의 바이트 및 글자의 size(int)를 읽는다.
close(): 파일을 닫는다.

from fastapi import FastAPI, UploadFile

app = FastAPI()

@app.post("/file/")
async def createFile(file: UploadFile):
    return {"file": file}

List를 사용하여 여러개의 파일을 전달할 수 있다.

from typing import List
from fastapi import FastAPI, UploadFile

app = FastAPI()

@app.post("/file/")
async def createFile(files: List[UploadFile]):
    return {"files": [f for f in files]}

from fastapi import FastAPI, UploadFile
from fastapi.responses import HTMLResponse
import pandas as pd

app = FastAPI()


@app.post("/file/")
async def createFile(file: UploadFile):
    contents = await file.read()
    df = pd.read_excel(contents)
    print(df.head(5))
    return {"msg": "success"}
context = """
<body>
    <form method="post" action="/file" enctype="multipart/form-data">
        file : <input type="file" name="file"><br>
        <input type='submit'>
    </form>
</body>
"""


@app.get('/')
async def main():
    return HTMLResponse(context)

728x90

저작자표시 변경금지

'Back-end & Server > FastAPI' 카테고리의 다른 글

[FastAPI] 미들웨어 (0)	2024.02.20
[FastAPI] 경로 작동 설정 (0)	2024.02.20
[FastAPI] 모델 (0)	2024.02.20
[FastAPI] 매개변수 (0)	2024.02.20
[FastAPI] 동시성과 async / await (0)	2024.02.19

Pupbani's Lab

[FastAPI] Form

응답상태

Form

File

'Back-end & Server > FastAPI' 카테고리의 다른 글

티스토리툴바

[FastAPI] Form

응답상태

Form

File

'Back-end & Server > FastAPI' 카테고리의 다른 글

'Back-end & Server/FastAPI' Related Articles

티스토리툴바