Meticulous Data Validation with Pydantic

Prerequisites

To get the most out of this tutorial, you should have a solid grasp of Python 3.10+ and type hints. Familiarity with JSON structures and basic object-oriented programming concepts like class inheritance will help you understand how Pydantic models are structured.

Key Libraries & Tools

• Pydantic: The core library for data validation and settings management.
• FastAPI: A modern web framework that natively integrates with Pydantic for request validation.
• HTTPX: A next-generation HTTP client for testing API endpoints.

Code Walkthrough

Defining a model starts with inheriting from BaseModel. This provides the foundation for Pydantic's validation engine.

from pydantic import BaseModel, EmailStr, Field, SecretStr

class User(BaseModel):
    name: str = Field(..., examples=["Ariel"], description="The user's full name")
    email: EmailStr
    password: SecretStr
    role: str

In this snippet, EmailStr automatically validates the format of an email address. The Field function adds metadata like descriptions, which FastAPI uses to generate documentation. SecretStr is a security feature; when you print the object, the password shows as asterisks rather than plain text.

For complex logic, use the @field_validator decorator:

from pydantic import field_validator

@field_validator("name")
@classmethod
def validate_name(cls, value: str):
    if len(value) < 2:
        raise ValueError("Name must be at least 2 characters")
    return value

Syntax Notes

Notice the use of classmethod for field validators. When using mode='before', the validator runs before Pydantic's internal coercion, allowing you to handle raw input like strings that need conversion to Enums. For cross-field validation, use @model_validator(mode='after'), which gives you access to the entire instance data as a dictionary.

Practical Examples

Beyond simple scripts, Pydantic is the backbone of FastAPI. When you define a route, FastAPI uses your model to validate incoming JSON request bodies automatically. If the client sends a malformed email, the API returns a 422 Unprocessable Entity error before your function even executes.

Tips & Gotchas

Avoid over-complicating your models. If you don't need validation, standard Python dataclasses are more lightweight. However, always use model_dump() or model_dump_json() for serialization rather than manually converting objects to dictionaries to ensure your exclude and alias settings are respected.