Files
instructor/docs/concepts/enums.md
T
Jason Liu dcb84b1301 Test all of our documentation. (#404)
Co-authored-by: grit-app[bot] <grit-app[bot]@users.noreply.github.com>
2024-02-05 16:42:57 -05:00

35 lines
824 B
Markdown

To prevent data misalignment, we can use Enums for standardized fields. Always include an "Other" option as a fallback so the model can signal uncertainty.
```python hl_lines="7 12"
from pydantic import BaseModel, Field
from enum import Enum
class Role(Enum):
PRINCIPAL = "PRINCIPAL"
TEACHER = "TEACHER"
STUDENT = "STUDENT"
OTHER = "OTHER"
class UserDetail(BaseModel):
age: int
name: str
role: Role = Field(
description="Correctly assign one of the predefined roles to the user."
)
```
If you're having a hard time with `Enum` and alternative is to use `Literal` instead.
```python hl_lines="4"
from typing import Literal
from pydantic import BaseModel
class UserDetail(BaseModel):
age: int
name: str
role: Literal["PRINCIPAL", "TEACHER", "STUDENT", "OTHER"]
```