Skip to main content

Pydantic

Data validation, parsing, and settings management using Python type hints. Seriously fast.

Overview​

Pydantic is a library for data validation, serialization, and settings management that leverages Python's type annotations to define data structures. At its core, Pydantic guarantees that data conforms to a specific shape and type, making your code more robust, readable, and less prone to errors. Simply define your data as a class with type hints, and Pydantic handles the rest.

It intelligently parses and validates complex, nested data structures from sources like JSON, dictionaries, and API requests. When validation fails, you get clear, human-readable error messages that pinpoint exactly what's wrong. Under the hood, Pydantic is powered by a high-performance Rust core, ensuring that your data validation is not only reliable but also incredibly fast.

While Pydantic is a cornerstone of the API ecosystem (most famously with FastAPI), its use cases extend far beyond. It's perfect for managing application settings, building reliable data processing pipelines, or creating any application that depends on a well-defined data structure.

Key Concepts​

  • Data Models Models and Dataclasses: The primary way to define the structure of your data. By creating a class that inherits from BaseModel or uses the @dataclass decorator, you use standard Python type hints to declare fields, their types, and validation rules.

  • Validation and Parsing Scalar and Primitive Types: Pydantic doesn't just check types; it intelligently parses and coerces input data. It can convert strings to numbers, parse ISO 8601 strings into datetime objects, and much more, all while enforcing your defined constraints.

  • Serialization Serialization Fundamentals: The process of converting your complex model instances back into standard data formats like dictionaries and JSON. Pydantic gives you fine-grained control over this process, allowing you to customize output with aliases, exclude fields, and more.

  • Core Schemas Overview: The powerful engine that drives Pydantic. While you'll often work with high-level models, understanding the underlying schema system allows for advanced customization, letting you build complex validation pipelines and define intricate data types.

  • Configuration The CoreConfig Object: Tweak Pydantic's behavior to fit your needs. Validation and serialization can be fine-tuned globally or on a per-model basis, controlling everything from strictness and handling of extra fields to JSON output formatting.

Common Use Cases​

  • Building robust and type-safe APIs for web applications.
  • Managing application settings from environment variables or configuration files.
  • Parsing and validating complex, nested data from JSON or YAML.
  • Creating reliable data transformation and ETL (Extract, Transform, Load) pipelines.
  • Developing command-line interfaces (CLIs) with validated inputs.

Getting Started​

New to Pydantic? Start with the Getting Started guide to grasp the fundamentals. Once you're ready, explore how to define Models and Dataclasses and then learn about advanced customization with Custom Validation Functions and Serialization.