Pydantic model definition in FastAPI

Introduction

Pydantic models help you define clear and simple data shapes. They check data automatically so your app gets the right info.

When you want to make sure user input has the right form.

When you need to send data between parts of your app safely.

When you want to convert data from JSON to Python objects easily.

When you want to add simple rules to data like 'age must be a number'.

When building APIs that need clear data formats.

Syntax

FastAPI

from pydantic import BaseModel

class ModelName(BaseModel):
    field_name: field_type
    another_field: another_type = default_value

Models inherit from BaseModel.

Fields are defined with type hints and optional default values.

Examples

A simple model with two fields: name and age.

FastAPI

from pydantic import BaseModel

class User(BaseModel):
    name: str
    age: int

Model with a default value for price.

FastAPI

from pydantic import BaseModel

class Product(BaseModel):
    id: int
    price: float = 0.0

Field that can be missing or None using Optional.

FastAPI

from pydantic import BaseModel
from typing import Optional

class Item(BaseModel):
    description: Optional[str] = None

Sample Program

This example shows how to define a Pydantic model and create an instance. It prints the whole object and each field.

FastAPI

from pydantic import BaseModel

class Person(BaseModel):
    name: str
    age: int

# Create a person instance
person = Person(name="Alice", age=30)

print(person)
print(person.name)
print(person.age)

Important Notes

Pydantic automatically checks that data types match.

If data is wrong, it raises clear errors to help fix it.

Models can be nested to build complex data shapes.

Summary

Pydantic models define data shapes with types.

They validate data automatically.

Use them to keep your app data clean and safe.

Practice

1. What is the main purpose of defining a Pydantic model in FastAPI?

easy

A. To specify the expected data structure and validate incoming data automatically

B. To create database tables automatically

C. To style the API responses with CSS

D. To handle user authentication

Solution

1. Step 1: Understand Pydantic model role

   Pydantic models define the shape and types of data expected in requests or responses.

2. Step 2: Identify validation feature

   They automatically check if incoming data matches the defined types and structure.

3. Final Answer:

   To specify the expected data structure and validate incoming data automatically -> Option A

4. Quick Check:

   Data validation = C [OK]

Hint: Pydantic models shape and check data automatically [OK]

Common Mistakes:

• Confusing Pydantic models with database models
• Thinking Pydantic handles styling or authentication
• Assuming Pydantic models run code logic

2. Which of the following is the correct way to define a Pydantic model with a required string field name and an optional integer field age?

easy

A. class User(BaseModel): name: str; age: int = None

B. class User(BaseModel): name: str; age: Optional[int] = None

C. class User(BaseModel): name = str; age = int = None

D. class User(BaseModel): name: str = None; age: int

Solution

1. Step 1: Check required and optional fields syntax

   Required fields have type only, optional fields use Optional[type] with default None.

2. Step 2: Identify correct syntax

   class User(BaseModel): name: str; age: Optional[int] = None uses name: str (required) and age: Optional[int] = None (optional), which is correct.

3. Final Answer:

   class User(BaseModel): name: str; age: Optional[int] = None -> Option B

4. Quick Check:

   Optional fields use Optional[type] = None [OK]

Hint: Use Optional[type] = None for optional fields [OK]

Common Mistakes:

• Using plain type with default None without Optional
• Assigning type with equals sign incorrectly
• Setting required fields with default None

3. Given this Pydantic model:

from pydantic import BaseModel

class Item(BaseModel):
    id: int
    name: str
    price: float

item = Item(id='5', name='Book', price=12.99)

What will be the type of item.id after creation?

medium

A. TypeError raised

B. str with value '5'

C. float with value 5.0

D. int with value 5

Solution

1. Step 1: Understand Pydantic type coercion

   Pydantic automatically converts compatible types to the declared type if possible.

2. Step 2: Analyze input and conversion

   The string '5' can be converted to int 5, so item.id becomes int 5.

3. Final Answer:

   int with value 5 -> Option D

4. Quick Check:

   Pydantic converts compatible types automatically [OK]

Hint: Pydantic converts strings to int if possible [OK]

Common Mistakes:

• Assuming input type must match exactly without conversion
• Expecting a TypeError for string input
• Thinking the value stays as string

4. What is wrong with this Pydantic model definition?

from pydantic import BaseModel

class Product(BaseModel):
    name: str
    price: float = 'free'

medium

A. Missing import for Optional

B. Class must inherit from object, not BaseModel

C. Default value 'free' is a string but price expects a float

D. Field names cannot be lowercase

Solution

1. Step 1: Check field types and default values

   The field price expects a float but is given a string default 'free'.

2. Step 2: Understand Pydantic validation

   Pydantic will raise a validation error because 'free' cannot be converted to float.

3. Final Answer:

   Default value 'free' is a string but price expects a float -> Option C

4. Quick Check:

   Default value type must match field type [OK]

Hint: Default values must match declared field types [OK]

Common Mistakes:

• Assigning default values of wrong type
• Confusing inheritance requirements
• Thinking field names have naming restrictions

5. You want to create a Pydantic model User with a required username (string), an optional email (string), and a roles list of strings that defaults to an empty list. Which is the correct way to define it?

hard

A. class User(BaseModel): username: str; email: Optional[str] = None; roles: list[str] = Field(default_factory=list)

B. class User(BaseModel): username: str; email: str = None; roles: list[str] = []

C. class User(BaseModel): username: str; email: Optional[str]; roles: list[str] = None

D. class User(BaseModel): username: str; email: Optional[str] = None; roles: list[str] = []

Solution

1. Step 1: Identify optional email field syntax

   Email is optional, so use Optional[str] = None to allow missing value.

2. Step 2: Handle mutable default for roles list

   Using roles: list[str] = [] is unsafe because lists are mutable defaults shared across instances. Use Field(default_factory=list) to create a new list each time.

3. Final Answer:

   class User(BaseModel): username: str; email: Optional[str] = None; roles: list[str] = Field(default_factory=list) -> Option A

4. Quick Check:

   Use Field(default_factory=list) for mutable defaults [OK]

Hint: Use Field(default_factory=list) for empty list defaults [OK]

Common Mistakes:

• Using mutable empty list as default directly
• Not marking optional fields with Optional and default None
• Assigning None to non-optional list fields