FastAPI 및 Pydantic을 사용하여 강력한 구성 요소 구축-파이썬 튜토리얼-php.cn

FastAPI 및 Pydantic을 사용하여 강력한 구성 요소 구축

DDD

풀어 주다： 2024-10-07 16:12:29

원래의

923명이 탐색했습니다.

Building Robust Components with FastAPI and Pydantic

효율적인 데이터 검증을 위해 잘 정의된 객체 활용

객체는 구성 요소의 진입점과 종료점 역할을 하며 데이터 흐름의 기본 게이트웨이 역할을 합니다. 강력하고 유지 관리가 가능한 구성 요소를 만들려면 이러한 개체 내에서 명확하고 잘 구조화된 필드를 정의하는 것이 필수적입니다. 이를 통해 다양한 시스템 부품 간의 데이터 무결성과 안정적인 상호 작용이 보장됩니다. 개인적으로 저는 최신 고성능 API를 개발하기 위해 FastAPI 프레임워크와 함께 Python을 사용하는 것을 선호합니다. 데이터 검증을 위해 제가 선택한 라이브러리는 FastAPI와 완벽하게 통합되어 필드 제약 조건을 우아하게 적용하고 시스템 전체에서 일관성을 유지하는 Pydantic입니다.


from fastapi import FastAPI, HTTPException
from pydantic import BaseModel, EmailStr, Field, ValidationError, conint

# FastAPI instance
app = FastAPI()

# Pydantic model for request body validation
class User(BaseModel):
    name: str = Field(..., min_length=3, max_length=50, description="Name must be between 3 and 50 characters")
    age: conint(gt=0, le=120) = Field(..., description="Age must be between 1 and 120")  # Constrained integer type
    email: EmailStr = Field(..., description="Must be a valid email address")

# API route to handle user data submission
@app.post("/create-user/")
async def create_user(user: User):
    try:
        # If validation passes, this will run
        return {"message": f"User {user.name} created successfully!"}
    except ValidationError as e:
        # Catch and return validation errors
        raise HTTPException(status_code=400, detail=e.errors())

# Sample invalid data
invalid_data = {"name": "A", "age": -5, "email": "invalid_email"}

# Simulate calling the route with invalid data
@app.get("/test-invalid-data/")
async def test_invalid_data():
    try:
        user = User(**invalid_data)  # Validation will fail here
    except ValidationError as e:
        return {"error": e.errors()}

# Run the server using: uvicorn <filename>:app --reload

로그인 후 복사

이 예에서는 FastAPI와 Pydantic이 어떻게 협력하여 데이터 검증을 효율적으로 처리하는지 보여줍니다. Pydantic의 BaseModel을 사용하여 들어오는 요청 데이터에 대한 유효성 검사 규칙을 정의합니다. 예를 들어, 우리는 EmailStr을 활용하여 이메일 형식을 자동으로 검증하므로 맞춤 정규식 없이 프로세스를 단순화합니다. 마찬가지로 conint(제약된 정수 유형)를 사용하여 age가 1에서 120 사이의 특정 범위 내에 포함되도록 합니다. 이 접근 방식은 가독성과 안전성을 향상시킵니다.

예제 코드에서 사용자 모델은 이름, 나이, 이메일과 같은 필드로 정의되며 각 필드에는 유효성 검사 기준이 있습니다. 사용자가 /create-user/ 경로를 통해 데이터를 제출하면 FastAPI는 자동으로 이러한 규칙에 따라 입력의 유효성을 검사합니다. 유효한 경우 사용자가 성공적으로 생성된 것입니다. 그렇지 않은 경우 FastAPI는 자세한 오류 메시지와 함께 400 잘못된 요청을 발생시킵니다. 이는 부정확하거나 악의적인 데이터를 처리할 위험을 크게 줄여주므로 FastAPI는 안전한 API 개발을 위한 강력한 선택이 됩니다.

Pydantic을 사용한 사용자 정의 필드/모델 검증

Pydantic v2에는 모델 수준 유효성 검사가 도입되어 @model_validator 데코레이터를 사용하여 서로 관련된 여러 필드의 유효성을 검사할 수 있습니다. 이 유효성 검사는 필드 유효성 검사 후에 실행되며 특히 필드 간의 특정 조건이 충족되는지 확인하는 데 유용합니다. 예를 들어 이벤트 모델에서 start_date가 end_date보다 먼저 발생하는지 확인할 수 있습니다.


from pydantic import BaseModel, model_validator
from datetime import date

class Event(BaseModel):
    name: str
    start_date: date
    end_date: date

    @model_validator(mode='after')
    def check_dates(cls, values):
        start, end = values.get('start_date'), values.get('end_date')
        if start and end and start >= end:
            raise ValueError('start_date must be before end_date')
        return values

로그인 후 복사

이 예에서 @model_validator는 start_date가 end_date보다 이전인지 확인합니다. 이 조건이 충족되지 않으면 Pydantic은 유효성 검사 오류를 발생시킵니다. 이 모델 수준 검증은 여러 필드 간의 관계가 정확하게 적용되는지 확인하는 데 유용합니다.

Pydantic의 사용자 정의 직렬화

Pydantic은 dict() 또는 json() 메서드를 재정의하여 모델 필드의 사용자 정의 직렬화를 허용합니다. 이는 출력 형식을 수정하거나 직렬화 중에 특정 필드를 제외하려는 경우에 유용합니다. @property 데코레이터를 사용하여 직렬화에는 포함되지만 모델의 원시 데이터에는 포함되지 않는 계산된 필드를 추가할 수도 있습니다.

다음은 직렬화된 출력에서 비밀번호 필드를 제외하고 전체 이름이 반환되는 방식을 수정하는 사용자 정의 직렬화의 예입니다.


from pydantic import BaseModel

class User(BaseModel):
    first_name: str
    last_name: str
    password: str

    # Custom serialization to return the full name
    @property
    def full_name(self):
        return f"{self.first_name} {self.last_name}"

    # Overriding dict() to exclude the password
    def dict(self, **kwargs):
        result = super().dict(**kwargs)
        result['full_name'] = self.full_name  # Add computed field
        result.pop('password', None)  # Remove password from serialization
        return result

# Example usage
user = User(first_name="John", last_name="Doe", password="secret123")
print(user.dict())

로그인 후 복사

이 예에서 full_name은 계산된 속성이므로 비밀번호가 출력에서 제외되도록 dict() 메서드를 재정의합니다. 이와 같은 사용자 정의 직렬화를 통해 모델 데이터가 API 또는 응답에 노출되는 방식을 세밀하게 제어할 수 있습니다.

FastAPI 및 Pydantic 통합

Pydantic은 FastAPI와 원활하게 통합되어 요청 페이로드, 쿼리 매개변수 및 경로 매개변수에 대한 자동 데이터 검증을 제공합니다. FastAPI 엔드포인트에서 Pydantic 모델을 정의하면 FastAPI는 모델 규칙에 따라 들어오는 데이터의 구문 분석 및 유효성 검사를 자동으로 처리합니다. 데이터가 유효하지 않은 경우 FastAPI는 명확한 오류 메시지와 함께 자세한 422 Unprocessable Entity 응답을 반환합니다.

다음은 간단한 예입니다.


from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    username: str
    age: int

@app.post("/users/")
async def create_user(user: User):
    return {"message": f"User {user.username} created successfully!"}

로그인 후 복사

이 예에서 POST 요청이 /users/로 전송되면 FastAPI는 Pydantic을 사용하여 수신 JSON 데이터의 유효성을 검사합니다. 데이터가 사용자 모델을 따르지 않는 경우(예: 사용자 이름 누락 또는 유효하지 않은 연령) FastAPI는 자동으로 오류 응답을 반환하여 입력 유효성 검사 및 오류 처리를 단순화합니다.

요약

요약하자면, FastAPI와 함께 Pydantic을 활용하면 명확한 검증을 통해 데이터 무결성을 보장함으로써 강력하고 유지 관리가 가능한 애플리케이션을 만드는 능력이 향상됩니다. 이 강력한 조합은 개발 프로세스를 단순화하는 동시에 보안과 안정성을 향상시켜 최신 API 구축에 선호되는 선택이 됩니다.