Optional and nullable fields in FastAPI - Step-by-Step Execution

Concept Flow - Optional and nullable fields

Define Pydantic Model

↓

Field declared as Optional or nullable

↓

Receive JSON input

↓

Check if field is present

Yes No↓

Validate value

↓

Create model instance with field value

↓

Use model in FastAPI endpoint

This flow shows how FastAPI handles fields that can be missing (optional) or set to null (nullable) when receiving data.

Execution Sample

FastAPI

from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel

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

Defines a FastAPI model with an optional field 'description' that can be missing or null.

Execution Table

Step	Input JSON	Field 'description' Present?	Value Used	Model Instance Field Value
1	{"description": "A book"}	Yes	"A book"	"A book"
2	{"description": null}	Yes	null	None
3	{}	No	Not present	None
4	{"description": 123}	Yes	123 (wrong type)	Validation Error

💡 Execution stops when input is fully validated or error occurs due to wrong type.

Variable Tracker

Variable	Start	After Input 1	After Input 2	After Input 3	After Input 4
description	None	"A book"	None	None	Validation Error

Key Moments - 3 Insights

Why does 'description' become None when the input JSON has null?

Because the field is Optional[str] with default None, FastAPI converts JSON null to Python None as shown in execution_table row 2.

What happens if the 'description' field is missing in the input?

FastAPI uses the default None value for the optional field, as shown in execution_table row 3.

Why does a validation error occur when 'description' is a number?

Because 'description' expects a string or None, a number type causes validation to fail, as in execution_table row 4.

Visual Quiz - 3 Questions

Look at the execution table, what is the model field value for 'description' at step 3 when input is {}?

A None

B "" (empty string)

C Validation Error

D "null" (string)

💡 Hint

Check execution_table row 3 under 'Model Instance Field Value'

At which step does the validation error occur due to wrong type?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look for 'Validation Error' in execution_table rows

If the field was not Optional and input JSON was missing 'description', what would happen?

A Field value would be None

B Validation Error for missing field

C Field value would be empty string

D FastAPI would ignore the field

💡 Hint

Refer to key_moments about missing fields and defaults

Concept Snapshot

FastAPI Optional and nullable fields:
- Use Optional[type] with default None to allow missing or null.
- JSON null converts to Python None.
- Missing fields get default None if Optional.
- Wrong types cause validation errors.
- Helps handle flexible input data safely.

Full Transcript

This visual execution shows how FastAPI handles optional and nullable fields in Pydantic models. When a field is declared as Optional[str] with a default of None, it means the field can be missing or set to null in the input JSON. The flow starts by defining the model, then receiving JSON input. If the field is present, FastAPI validates the value. If the value is null, it converts it to Python None. If the field is missing, it uses the default None. If the value type is wrong, validation fails. The execution table traces four inputs: a string value, null, missing field, and wrong type. The variable tracker shows how the field value changes or causes errors. Key moments clarify why null becomes None, what happens when the field is missing, and why wrong types cause errors. The quiz tests understanding of these behaviors. This helps beginners see exactly how FastAPI processes optional and nullable fields step-by-step.

Practice

1. In FastAPI, what does it mean when a field is declared as Optional[str] in a request model?

easy

A. The field is required and cannot be None.

B. The field must always be provided with a string value.

C. The field can only be an empty string but not None.

D. The field can be omitted or set to None in the request.

Solution

1. Step 1: Understand Optional type in FastAPI

   Optional[str] means the field can be missing or have a value of type str or None.

2. Step 2: Interpret the meaning for API requests

   This allows clients to omit the field or explicitly send null (None) as its value.

3. Final Answer:

   The field can be omitted or set to None in the request. -> Option D

4. Quick Check:

   Optional[str] = omitted or None [OK]

Hint: Optional means field can be missing or None [OK]

Common Mistakes:

• Thinking Optional means field is always required
• Confusing Optional with default values
• Assuming Optional forbids None

2. Which of the following is the correct way to declare a nullable string field in a FastAPI Pydantic model?

easy

A. name: Optional[str] = None

B. name: str | None = None

C. name: str = None

D. name: str?

Solution

1. Step 1: Recall Pydantic syntax for optional and nullable fields

   To allow a field to be nullable and optional, use Optional[str] with a default None.

2. Step 2: Check each option

   A is invalid because just assigning None to str without Optional is not correct. B is valid Python 3.10+ syntax but C is the recommended explicit way in FastAPI. D is invalid syntax.

3. Final Answer:

   name: Optional[str] = None -> Option A

4. Quick Check:

   Nullable string = Optional[str] = None [OK]

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

Common Mistakes:

• Using just type with = None without Optional
• Using invalid syntax like str?
• Confusing Optional with just default values

3. Given this FastAPI model:

from typing import Optional
from pydantic import BaseModel

class User(BaseModel):
    name: str
    nickname: Optional[str] = None

user = User(name='Alice')

What will be the value of user.nickname?

medium

A. '' (empty string)

B. 'Alice'

C. None

D. Raises an error

Solution

1. Step 1: Analyze the model fields and defaults

   The nickname field is Optional[str] with a default of None, so if not provided, it defaults to None.

2. Step 2: Check the instance creation

   When creating user with only name='Alice', nickname is not set, so it uses the default None.

3. Final Answer:

   None -> Option C

4. Quick Check:

   Optional field missing = None [OK]

Hint: Missing optional field defaults to None [OK]

Common Mistakes:

• Assuming nickname defaults to empty string
• Thinking nickname copies name value
• Expecting an error for missing optional field

4. What is wrong with this FastAPI model declaration?

from typing import Optional
from pydantic import BaseModel

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

medium

A. Optional[str] is not allowed in Pydantic models.

B. Missing default value for Optional field causes validation error.

C. Field description must be declared as str, not Optional[str].

D. No import for Optional is present.

Solution

1. Step 1: Understand Optional fields in Pydantic

   Optional means the field can be None or missing, but Pydantic requires a default value for optional fields.

2. Step 2: Check the model declaration

   The field description is Optional[str] but has no default value, so Pydantic will expect it to be provided and raise an error if missing.

3. Final Answer:

   Missing default value for Optional field causes validation error. -> Option B

4. Quick Check:

   Optional fields need default values [OK]

Hint: Optional fields must have default values [OK]

Common Mistakes:

• Omitting default None for Optional fields
• Thinking Optional alone makes field optional
• Ignoring Pydantic validation rules

5. You want to create a FastAPI model where the field email can be omitted, but if present, it can be set to null explicitly. Which is the best way to declare this field?

hard

A. email: Optional[str] = None

B. email: str = None

C. email: str | None

D. email: Optional[str]

Solution

1. Step 1: Understand requirements for the field

   The field must be optional (can be omitted) and nullable (can be None explicitly).

2. Step 2: Evaluate each declaration

   B lacks Optional and default None, so it is not optional. C lacks default None, so field is required. D lacks default None, so field is required. A uses Optional[str] with default None, making it optional and nullable.

3. Final Answer:

   email: Optional[str] = None -> Option A

4. Quick Check:

   Optional with default None = optional and nullable [OK]

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

Common Mistakes:

• Forgetting to assign default None
• Using union without default value
• Assuming Optional alone makes field optional