Pythonのデータ型を賢く扱う！「pydantic」で堅牢なアプリケーションを開発しよう

pip install pydantic

from pydantic import BaseModel, ValidationError
from typing import List, Optional

# データモデルの定義
class User(BaseModel):
    id: int
    name: str = "名無しさん" # デフォルト値
    email: Optional[str] = None # オプションフィールド
    age: int
    is_active: bool = True
    tags: List[str] = []

# 有効なデータの例
try:
    user1 = User(id=1, name="Alice", age=30, email="alice@example.com")
    print(f"ユーザー1: {user1.model_dump_json(indent=2)}")

    user2 = User(id=2, age=25) # name, is_active, tagsはデフォルト値が適用される
    print(f"ユーザー2: {user2.model_dump_json(indent=2)}")
except ValidationError as e:
    print(e.json())

# 無効なデータの例
print("\n--- 無効なデータ ---")
try:
    # idが文字列、ageが負の値
    invalid_user = User(id="abc", name="Bob", age=-5)
except ValidationError as e:
    print(f"検証エラーが発生しました:\n{e.json(indent=2)}")

# さらに、外部から受け取ったデータをパースする例
json_data = '''
{
    "id": 3,
    "name": "Charlie",
    "email": "charlie@example.com",
    "age": "28",
    "is_active": false
}
'''
import json
try:
    data_dict = json.loads(json_data)
    user3 = User.model_validate(data_dict) # pydantic v2ではparse_objからmodel_validateに変更
    print(f"ユーザー3 (JSONから): {user3.model_dump_json(indent=2)}")
except ValidationError as e:
    print(f"JSONデータからの検証エラー:\n{e.json(indent=2)}")

ユーザー1: {
  "id": 1,
  "name": "Alice",
  "email": "alice@example.com",
  "age": 30,
  "is_active": true,
  "tags": []
}
ユーザー2: {
  "id": 2,
  "name": "名無しさん",
  "email": null,
  "age": 25,
  "is_active": true,
  "tags": []
}

--- 無効なデータ ---
検証エラーが発生しました:
[
  {
    "type": "int_parsing",
    "loc": [
      "id"
    ],
    "msg": "Input should be a valid integer, unable to parse string as an integer",
    "input": "abc",
    "url": "https://errors.pydantic.dev/2.13/v/int_parsing"
  }
]
ユーザー3 (JSONから): {
  "id": 3,
  "name": "Charlie",
  "email": "charlie@example.com",
  "age": 28,
  "is_active": false,
  "tags": []
}