Pydantic: 수동 검증의 끝! ✨

Pydantic은 Python용 데이터 검증 및 설정 관리 라이브러리입니다. Python 유형 힌트를 사용하여 데이터의 유효성을 검사하고 구문 분석하여 코드가 적절하게 구조화되고 유형이 지정된 데이터와 작동하는지 확인합니다. Python의 데이터 클래스와 유사한 모델 구조를 활용함으로써 Pydantic은 복잡한 데이터에 대한 스키마를 쉽게 정의하고 깔끔한 Python 방식으로 데이터를 자동으로 검증하고 직렬화/역직렬화할 수 있게 해줍니다. 주요 기능을 살펴보겠습니다:

데이터 검증

Python의 유형 힌트를 사용하여 스키마에 대해 입력 데이터를 자동으로 검증합니다.

from pydantic import BaseModel, ValidationError

class User(BaseModel):
    id: int
    name: str
    email: str

# Valid input
user = User(id=1, name="John Doe", email="john@example.com")
print(user)

# Invalid input
try:
    user = User(id="not-an-integer", name="Jane", email="jane@example.com")
except ValidationError as err:
    print(err)

데이터 모델을 정의하고 싶을 때마다 pydantic.BaseModel을 사용하세요!

기능 검증

Pydantic은 데이터 모델뿐만 아니라 함수의 입력과 출력도 검증할 수 있는 강력한 도구를 제공합니다. 이는 @validate_call 데코레이터를 사용하여 수행되며 함수 인수 및 반환 값에 대해 엄격한 데이터 유효성 검사를 적용할 수 있습니다. 제공된 인수 또는 반환 유형이 예상 유형과 일치하지 않으면 ValidationError가 발생합니다.

from pydantic import validate_call

@validate_call
def greet(name: str, age: int) -> str:
    return f"Hello {name}, you are {age} years old."

# Valid input
print(greet("Alice", 30))  # Output: Hello Alice, you are 30 years old.

# Invalid input
try:
    greet("Bob", "not-a-number")
except Exception as e:
    print(e)

@validate_call에서 verify_return 플래그를 활성화함으로써 Pydantic은 주석이 달린 반환 유형에 대해 함수의 반환 값을 검증합니다. 이렇게 하면 함수가 예상되는 출력 스키마를 준수하게 됩니다.

from pydantic import validate_call

@validate_call(validate_return=True)
def calculate_square(number: int) -> int:
    return number ** 2  # Correct return type

# Valid input and return
print(calculate_square(4))  # Output: 16

# Invalid return value
@validate_call(validate_return=True)
def broken_square(number: int) -> int:
    return str(number ** 2)  # Incorrect return type

try:
    broken_square(4)
except Exception as e:
    print(e)

파싱

Pydantic은 JSON 데이터를 포함한 복잡한 중첩 구조를 모델 객체로 구문 분석할 수 있습니다.

from pydantic import BaseModel
from typing import List

class Item(BaseModel):
    name: str
    price: float

class Order(BaseModel):
    items: List[Item]
    total: float

# JSON-like data
data = {
    "items": [
        {"name": "Apple", "price": 1.2},
        {"name": "Banana", "price": 0.8}
    ],
    "total": 2.0
}

order = Order(**data) 
print(order) # items=[Item(name='Apple', price=1.2), Item(name='Banana', price=0.8)] total=2.0

직렬화 및 역직렬화

Pydantic 모델은 JSON이나 사전으로 직렬화하고 다시 재구성할 수 있습니다.

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    email: str

# Create a model instance
user = User(id=1, name="Alice", email="alice@example.com")

# Serialize to dictionary and JSON
user_dict = user.model_dump()
user_json = user.model_dump(mode='json')

print("Dictionary:", user_dict)
print("JSON:", user_json)

# Deserialize back to the model
new_user = User.model_validate(user_json)
print("Parsed User:", new_user)

유연한 검증

데이터 검증은 강제형 검증이 아닙니다. 예를 들어 각각 int, bool 및 datetime 유형의 id, Due_date 및 우선순위 필드를 사용하여 모델을 정의하는 경우 다음을 전달할 수 있습니다.

• ID로 숫자 문자열
• ISO-8601, UTC 또는 기타 날짜 형식의 문자열(기한_날짜)
• '예'/'아니요', '켜기'/'끄기', '참'/'거짓', 1/0 등 우선순위

from sensei import APIModel
from datetime import datetime


class Task(APIModel):
    id: int
    due_date: datetime
    priority: bool


task = Task(due_date='2024-10-15T15:30:00',>



<p>The result will be<br>
</p>

<pre class="brush:php;toolbar:false">Task(id=1, due_date=datetime.datetime(2024, 10, 15, 15, 30), priority=True)

맞춤형 검증

검증기를 사용하여 모델에 사용자 지정 검증 논리를 정의할 수도 있습니다. 기본 제공 유형이나 필드 제약 조건을 사용하여 쉽게 표현할 수 없는 보다 복잡한 유효성 검사 규칙을 적용할 수 있습니다. 유효성 검사기는 field_validator 데코레이터 또는 Field 개체를 통해 정의됩니다. 하나 이상의 필드 이름을 field_validator에 전달하여 어떤 필드가 이 유효성 검사기를 사용할지 결정하거나 '*'를 사용하여 모든 필드에 유효성 검사기를 적용할 수 있습니다.

import Any 입력에서
pydantic import Field, field_validator, EmailStr, BaseModel에서

클래스 사용자(BaseModel):
    아이디: 정수
    사용자 이름: str = Field(pattern=r'^w $')
    이메일: EmailStr
    age: int = Field(18, ge=14)
    is_active: 부울 = 참
    역할: 목록[str]

    # 내부 구문 분석 '전에' 실행되는 유효성 검사기를 정의합니다.
    @field_validator('역할', 모드='이전')
    def _validate_roles(cls, 값: 모두):
        return value.split(',') if isinstance(value, str) else value

user = 사용자(id=1, 사용자 이름='john', 이메일='john@example.com', 역할='학생,가수')
인쇄(사용자) #>



<h2>
  
  
  오픈 소스 프로젝트
</h2>

<p>Pydantic을 기반으로 하는 오픈소스 프로젝트가 많이 있습니다. 그 중 최고의 장점을 살펴보겠습니다.</p>

<h3>
  
  
  FastAPI
</h3>

<p>Pydantic의 가장 눈에 띄는 사용 사례 중 하나는 Python으로 API를 구축하기 위한 최신 웹 프레임워크인 FastAPI입니다. FastAPI는 요청 본문 검증, 쿼리 매개변수 및 응답 스키마를 위해 Pydantic 모델을 광범위하게 사용합니다.</p>

• 출처: https://github.com/fastapi/fastapi
• 문서: https://fastapi.tiangolo.com

선생님

FastAPI는 API 구축용으로 설계된 반면 Sensei는 이러한 API를 빠르고 쉽게 래핑하도록 설계되었습니다. Sensei가 제공하는 API 클라이언트는 사용자가 관련 데이터 모델을 얻고 혼란스러운 오류가 발생하지 않도록 보장합니다.

• 출처: https://github.com/CrocoFactory/sensei
• 문서: https://sensei.crocofactory.dev

SQLModel 및 Typer

SQLModel과 Typer는 FastAPI의 창시자인 Sebastián Ramírez가 개발한 두 가지 주목할만한 프로젝트입니다.

SQLModel은 Python 애플리케이션에서 데이터베이스 상호 작용을 간소화하도록 설계된 라이브러리입니다. SQLAlchemy 및 Pydantic을 기반으로 구축된 SQLModel은 ORM의 강력한 기능과 데이터 검증 및 직렬화의 편리함을 결합합니다.

• 출처: https://github.com/fastapi/sqlmodel
• 문서: https://sqlmodel.tiangolo.com

Typer는 Python을 사용하여 명령줄 인터페이스(CLI) 애플리케이션을 만들기 위한 프레임워크입니다. Python의 유형 힌트를 사용하여 사용자에게 친숙한 CLI 명령과 도움말 텍스트를 자동으로 생성함으로써 프로세스를 단순화합니다.

• 출처: https://github.com/fastapi/typer
• 문서: https://typer.tiangolo.com

위 내용은 Pydantic: 수동 검증의 끝! ✨의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!