|
| 1 | +# Prompt |
| 2 | + |
| 3 | +``` |
| 4 | +Please convert all pydantic model fields that use `Field()` with default values to use the Annotated pattern instead. |
| 5 | +Follow these guidelines: |
| 6 | +
|
| 7 | +1. Move default values outside of `Field()` like this: `field_name: Annotated[field_type, Field(description="")] = default_value`. |
| 8 | +2. Keep all other parameters like validation_alias and descriptions inside `Field()`. |
| 9 | +3. For fields using default_factory, keep that parameter as is in the `Field()` constructor, but set the default value outside to DEFAULT_FACTORY from common_library.basic_types. Example: `field_name: Annotated[dict_type, Field(default_factory=dict)] = DEFAULT_FACTORY`. |
| 10 | +4. Add the import: `from common_library.basic_types import DEFAULT_FACTORY` if it's not already present. |
| 11 | +5. If `Field()` has no parameters (empty), don't use Annotated at all. Just use: `field_name: field_type = default_value`. |
| 12 | +6. Leave any model validations, `model_config` settings, and `field_validators` untouched. |
| 13 | +``` |
| 14 | +## Examples |
| 15 | + |
| 16 | +### Before: |
| 17 | + |
| 18 | +```python |
| 19 | +from pydantic import BaseModel, Field |
| 20 | + |
| 21 | +class UserModel(BaseModel): |
| 22 | + name: str = Field(default="Anonymous", description="User's display name") |
| 23 | + age: int = Field(default=18, ge=0, lt=120) |
| 24 | + tags: list[str] = Field(default_factory=list, description="User tags") |
| 25 | + metadata: dict[str, str] = Field(default_factory=dict) |
| 26 | + is_active: bool = Field(default=True) |
| 27 | +``` |
| 28 | + |
| 29 | +- **After** |
| 30 | + |
| 31 | +```python |
| 32 | +from typing import Annotated |
| 33 | +from pydantic import BaseModel, Field |
| 34 | +from common_library.basic_types import DEFAULT_FACTORY |
| 35 | + |
| 36 | +class UserModel(BaseModel): |
| 37 | + name: Annotated[str, Field(description="User's display name")] = "Anonymous" |
| 38 | + age: Annotated[int, Field(ge=0, lt=120)] = 18 |
| 39 | + tags: Annotated[list[str], Field(default_factory=list, description="User tags")] = DEFAULT_FACTORY |
| 40 | + metadata: Annotated[dict[str, str], Field(default_factory=dict)] = DEFAULT_FACTORY |
| 41 | + is_active: bool = True |
| 42 | +``` |
| 43 | + |
| 44 | +## Another Example with Complex Fields |
| 45 | + |
| 46 | +### Before: |
| 47 | + |
| 48 | +```python |
| 49 | +from pydantic import BaseModel, Field, field_validator |
| 50 | +from datetime import datetime |
| 51 | + |
| 52 | +class ProjectModel(BaseModel): |
| 53 | + id: str = Field(default_factory=uuid.uuid4, description="Unique project identifier") |
| 54 | + name: str = Field(default="Untitled Project", min_length=3, max_length=50) |
| 55 | + created_at: datetime = Field(default_factory=datetime.now) |
| 56 | + config: dict = Field(default={"version": "1.0", "theme": "default"}) |
| 57 | + |
| 58 | + @field_validator("name") |
| 59 | + def validate_name(cls, v): |
| 60 | + if v.isdigit(): |
| 61 | + raise ValueError("Name cannot be only digits") |
| 62 | + return v |
| 63 | +``` |
| 64 | + |
| 65 | +### After: |
| 66 | + |
| 67 | +```python |
| 68 | +from typing import Annotated |
| 69 | +from pydantic import BaseModel, Field, field_validator |
| 70 | +from datetime import datetime |
| 71 | +from common_library.basic_types import DEFAULT_FACTORY |
| 72 | + |
| 73 | +class ProjectModel(BaseModel): |
| 74 | + id: Annotated[str, Field(default_factory=uuid.uuid4, description="Unique project identifier")] = DEFAULT_FACTORY |
| 75 | + name: Annotated[str, Field(min_length=3, max_length=50)] = "Untitled Project" |
| 76 | + created_at: Annotated[datetime, Field(default_factory=datetime.now)] = DEFAULT_FACTORY |
| 77 | + config: dict = {"version": "1.0", "theme": "default"} |
| 78 | + |
| 79 | + @field_validator("name") |
| 80 | + def validate_name(cls, v): |
| 81 | + if v.isdigit(): |
| 82 | + raise ValueError("Name cannot be only digits") |
| 83 | + return v |
| 84 | +``` |
0 commit comments