[FastAPI] 타입 지정, Pydantic

 

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

 

 

Type

FastAPI는 파이썬의 Type Annotation의 기반을 두고 있다. 

이를 통해 파이썬 변수를 선언하거나 함수의 값을 리턴할 때 타입을 지정할 수 있다.

이러한 Type Annotation은 ":"을 사용하여 명시할 수 있다.

(반환 타입은 "->" 로 지정)

 

Simple Type

• int
• float
• str
• bool 등의 파이썬 표준타입

def getItem(a:int,b:float)->int:
	return a+int(b)

result:int = getItem(1,1.5)
print(result)

 

 

 

타입 매개변수를 활용한 Generic(제네릭) 타입

• list, dict, set, tuple 같은 값을 저장할 수 있는 데이터 구조의 내부는 각자의 타입을 가질 수 있다.
• typing을 이용해 내부 Type Annotation을 지정할 수 있다. (List, Dict, Set, Tuple)

from typing import List

def getItems(items: List[str]) -> None:
    for item in items:
        print(item)
        
getItems(["1", "2", "3", "4"])

 

from typing import Set, Tuple, Dict

def getItems1(it1: Tuple[int, int, float], it2: Set[int]) -> None:
    for item in zip(it1, it2):
        print(item)

def getItems2(dic: Dict[str, int]) -> None:
    for k, v in dic.items():
        print(k, v)

getItems1((1, 2, 1.0), {1, 2, 3})
getItems2({"h": 1, "b": 3, "e": 2})

 

 

Optional 타입을 사용해서 "선택적"으로 타입을 지정할 수 있다.

from typing import Optional

def getItems(items: Optional[int] = None) -> None:
    # 항상 int가 아니라 None이 될 수도 있음
    for item in items:
        print(item)

getItems([1, 2, 3, None])

 

 

Union[X,Y] 타입으로 X 또는 Y 타입을 지정할 수 있다.

from typing import Union

def getItems(items: list) -> Union[int, list]:
    return items[:2]

d: Union[int, list] = None
d = getItems([1, 2, 3, 4])
print(d)

 

 

Pydantic

데이터 검증(Validation)을 위한 라이브러리이다.

• ex) 복잡한 서비스 로직에서 개발자가 원하는 방향으로 흐르게 만들어야 하나, 사용자들의 잘못된 입력으로 인한 문제를 방지하기 위해 특정 유형과 제약조건을 통해 데이터 검증을 한다.

 

타입의 제약조건 보장과 출력 모델의 유형과 제약조건을 보장한다.

 

FastAPI에서 API 호출 시 출력 모델의 유형과 제약조건을 보장시키기 위해 사용한다 생각하면 된다.

 

pip install pydantic

 

from pydantic import BaseModel
from typing import Union

class Item(BaseModel):
    name: str
    desc: Union[str, None] = None
    price: float
    tax: Union[float, None] = None


if __name__ == "__main__":
    data = {
        'name': 'toy',
        'desc': '장난감',
        'price': 4.7,
        'tax': 0.2
    }
    toy = Item(**data)
    print(toy)
    print()
    data = {
        'name': 'toy',
        'desc': '장난감',
        'price': 'dd',
        'tax': 0.2
    }
    toy = Item(**data)
    print(toy)

 

타입에 맞지 않은 값을 전달시 에러 발생

🥑 정의되지 않은 값이 들어가거나 변환 가능한 경우 정의된 필드에 맞도록 처리해줌.

 

 

Constrained types을 사용해 자신의 제한을 적용할 수 있다.

from pydantic import BaseModel, constr, conint


class Person(BaseModel):
    f_name: str
    # 3 <= 문자열 길이 <= 4 
    l_name: constr(min_length=3, max_length=4)
    # 1 <= 값 <= 25
    age: conint(ge=1, le=25)


if __name__ == "__main__":
    data = {
        'f_name': "Pupba",
        'l_name': "Jung",
        'age': 25
    }

    p = Person(**data)
    print(p)

 

 

Validator decorator를 사용해서 자체적인 규칙을 만들어 데이터 검사를 할 수 있다.

from pydantic import BaseModel, validator, ValidationError
from typing import Union

class Person(BaseModel):
    name: str
    age: int

    # 이름 검사
    @validator('name')
    def name_must_english(cls, v):
        assert v.encode().isalpha(), ValidationError('Name Must be english')
        return v
    # 나이 검사

    @validator('age')
    def is_adult(cls, v):
        if v <= 19:
            raise ValidationError('애송이 구만')
        return v

if __name__ == "__main__":
    data = {
        'name': "pupba",
        'age': 15
    }
    try:
        pupba = Person(**data)
        print(pupba)
    except ValidationError as e:
        print(e)

 

Model로부터 JSON을 만드는 것도 가능하다.

from pydantic import BaseModel

class Person(BaseModel):
    f_name: str
    l_name: str
    age: int


if __name__ == "__main__":
    data = {
        'f_name': "Pupba",
        'l_name': "Jung",
        'age': 25
    }

    json = Person(**data).model_dump_json()
    print(json)

 

완성된 모델을 model_dump_json()로 JSON으로 변환할 수 있다.