Дом
pydantic-models-py
microsoft/skills
Создавайте модели Pydantic по шаблону с несколькими моделями, включающему варианты Base, Create, Update, Response и InDB, для чистых контрактов API в приложениях на Python с использованием Pydantic v2.
...Расширить всеМодели Pydantic
Создавайте модели Pydantic, следуя многомодельному шаблону для чистых контрактов API.
Быстрый старт
Скопируйте шаблон из assets/template.py и замените заполнители:
{{ResourceName}}→ имя в PascalCase (например,Project){{resource_name}}→ имя в snake_case (например,project)
Многомодельный шаблон
| Модель | Назначение |
|---|---|
| `Base` | Общие поля, общие для всех моделей |
| `Create` | Тело запроса для создания (обязательные поля) |
| `Update` | Тело запроса для обновлений (все необязательные) |
| `Response` | Ответ API со всеми полями |
| `InDB` | Документ базы данных с `doc_type` |
Псевдонимы camelCase
class MyModel(BaseModel):
workspace_id: str = Field(..., alias="workspaceId")
created_at: datetime = Field(..., alias="createdAt")
class Config:
populate_by_name = True # Принимать как snake_case, так и camelCase
Необязательные поля для обновления
class MyUpdate(BaseModel):
"""Все поля необязательны для запросов PATCH."""
name: Optional[str] = Field(None, min_length=1)
description: Optional[str] = None
Документ базы данных
class MyInDB(MyResponse):
"""Добавляет doc_type для запросов Cosmos DB."""
doc_type: str = "my_resource"
Шаги интеграции
- Создайте модели в
src/backend/app/models/ - Экспортируйте из
src/backend/app/models/__init__.py - Добавьте соответствующие типы TypeScript
---
name: pydantic-models-py
description: Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants for clean API contracts in Python applications using Pydantic v2.
license: MIT
---
# Pydantic Models
Create Pydantic models following the multi-model pattern for clean API contracts.
## Quick Start
Copy the template from [assets/template.py](assets/template.py) and replace placeholders:
- `{{ResourceName}}` → PascalCase name (e.g., `Project`)
- `{{resource_name}}` → snake_case name (e.g., `project`)
## Multi-Model Pattern
| Model | Purpose |
|-------|---------|
| `Base` | Common fields shared across models |
| `Create` | Request body for creation (required fields) |
| `Update` | Request body for updates (all optional) |
| `Response` | API response with all fields |
| `InDB` | Database 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
Все файлы
0 файловУстановить pydantic-models-py
Скачайте и извлеките файлы навыков в вашу директорию .claude/skills/.
Скачать ZIPКлонируйте репозиторий и скопируйте файлы навыка в свой проект.
git clone https://github.com/microsoft/skills/tree/main/.github/plugins/azure-sdk-python/skills/pydantic-models-py # Copy SKILL.md to your .claude/skills/ directory
Копировать
