AgentSkillsCN

pydantic-models-py

按照多模型模式，使用 Base、Create、Update、Response 以及 InDB 等变体来定义 Pydantic 模型。当需要在 Python 应用中使用 Pydantic v2 定义 API 请求/响应模式、数据库模型，或进行数据校验时，可选用此方案。

SKILL.md
--- frontmatter
name: pydantic-models-py
description: Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response schemas, database models, or data validation in Python applications using Pydantic v2.

Pydantic Models

Create Pydantic models following the multi-model pattern for clean API contracts.

Quick Start

Copy the template from assets/template.py and replace placeholders:

  • •{{ResourceName}} → PascalCase name (e.g., Project)
  • •{{resource_name}} → snake_case name (e.g., project)

Multi-Model Pattern

ModelPurpose
BaseCommon fields shared across models
CreateRequest body for creation (required fields)
UpdateRequest body for updates (all optional)
ResponseAPI response with all fields
InDBDatabase document with doc_type

camelCase Aliases

python
class MyModel(BaseModel):
    workspace_id: str = Field(..., alias="workspaceId")
    created_at: datetime = Field(..., alias="createdAt")
    
    class Config:
        populate_by_name = True  # Accept both snake_case and camelCase

Optional Update Fields

python
class MyUpdate(BaseModel):
    """All fields optional for PATCH requests."""
    name: Optional[str] = Field(None, min_length=1)
    description: Optional[str] = None

Database Document

python
class MyInDB(MyResponse):
    """Adds doc_type for Cosmos DB queries."""
    doc_type: str = "my_resource"

Integration Steps

  1. •Create models in src/backend/app/models/
  2. •Export from src/backend/app/models/__init__.py
  3. •Add corresponding TypeScript types