Environment variable management in FastAPI - Step-by-Step Execution

Concept Flow - Environment variable management

Start Application

↓

Load .env file (optional)

↓

Read environment variables

↓

Use variables in app config

↓

Run FastAPI app with config

↓

App uses env vars safely

The app starts, optionally loads a .env file, reads environment variables, uses them in configuration, then runs.

Execution Sample

FastAPI

from fastapi import FastAPI
from pydantic import BaseSettings

class Settings(BaseSettings):
    app_name: str

settings = Settings()
app = FastAPI(title=settings.app_name)

This code loads environment variables into a Settings object and uses it to set FastAPI app title.

Execution Table

Step	Action	Evaluation	Result
1	Create Settings instance	Reads env var APP_NAME	settings.app_name = 'My FastAPI App'
2	Create FastAPI app	Use settings.app_name for title	app.title = 'My FastAPI App'
3	Run app	App uses title from env var	App running with title 'My FastAPI App'
4	Exit	No more steps	Execution ends

💡 All environment variables loaded and app started successfully

Variable Tracker

Variable	Start	After Step 1	After Step 2	Final
settings.app_name	undefined	'My FastAPI App'	'My FastAPI App'	'My FastAPI App'
app.title	undefined	undefined	'My FastAPI App'	'My FastAPI App'

Key Moments - 2 Insights

Why does settings.app_name get its value from the environment?

Because the Settings class inherits from BaseSettings, which automatically reads environment variables matching the attribute names, as shown in step 1 of the execution_table.

What happens if the environment variable APP_NAME is missing?

The Settings class will raise a validation error unless a default value is provided. This is why step 1 depends on the env var being set.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of settings.app_name after step 1?

A 'My FastAPI App'

B undefined

C None

D '' (empty string)

💡 Hint

Check the 'Result' column in row 1 of the execution_table.

At which step does the FastAPI app get its title set from the environment variable?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Action' and 'Result' columns in the execution_table rows.

If the environment variable APP_NAME was not set, what would likely happen at step 1?

A settings.app_name would be None

B app.title would be set to a default string

C Settings would raise a validation error

D The app would run with an empty title

💡 Hint

Refer to the key_moments section about missing environment variables.

Concept Snapshot

Use Pydantic's BaseSettings to load environment variables.
Define a Settings class with attributes matching env vars.
Create an instance to read env vars automatically.
Use these settings to configure FastAPI app.
Missing env vars cause validation errors unless defaults set.

Full Transcript

This example shows how FastAPI apps manage environment variables using Pydantic's BaseSettings. When the app starts, it creates a Settings instance that reads environment variables like APP_NAME. This value is then used to set the FastAPI app's title. The execution table traces these steps: creating settings, reading env vars, setting app title, and running the app. Variables like settings.app_name and app.title update accordingly. Beginners often wonder why settings.app_name gets its value automatically; this is because BaseSettings reads matching environment variables. If APP_NAME is missing, the app will raise an error unless a default is provided. The visual quiz tests understanding of these steps and variable values. This approach keeps configuration clean and secure by separating code from environment-specific data.

Practice

1. What is the main reason to use environment variables in a FastAPI project?

easy

A. To keep sensitive information like API keys out of the code

B. To make the code run faster

C. To store user data permanently

D. To create new API endpoints automatically

Solution

1. Step 1: Understand environment variables purpose

   Environment variables are used to keep sensitive data like passwords or API keys separate from the code to improve security.

2. Step 2: Identify the correct reason in FastAPI context

   FastAPI uses environment variables to avoid hardcoding secrets, which helps keep them safe and flexible.

3. Final Answer:

   To keep sensitive information like API keys out of the code -> Option A

4. Quick Check:

   Environment variables = keep secrets safe [OK]

Hint: Environment variables store secrets, not speed or data [OK]

Common Mistakes:

• Thinking environment variables speed up code
• Confusing environment variables with database storage
• Assuming environment variables create API routes

2. Which of the following is the correct way to get an environment variable named API_KEY using Python's os module in FastAPI?

easy

A. api_key = os.get('API_KEY')

B. api_key = os.getenv('API_KEY')

C. api_key = os.environ.get('API_KEY')()

D. api_key = os.getenv(API_KEY)

Solution

1. Step 1: Recall correct os module function

   The correct function to get environment variables is os.getenv('VAR_NAME').

2. Step 2: Check syntax correctness

   api_key = os.getenv('API_KEY') uses os.getenv('API_KEY') correctly with quotes around the variable name and no extra parentheses.

3. Final Answer:

   api_key = os.getenv('API_KEY') -> Option B

4. Quick Check:

   Use os.getenv('VAR') to get environment variables [OK]

Hint: Use os.getenv('VAR_NAME') with quotes [OK]

Common Mistakes:

• Using os.get instead of os.getenv
• Calling os.environ.get with extra parentheses
• Not quoting the environment variable name

3. Given this FastAPI code snippet using Pydantic's BaseSettings:

from pydantic import BaseSettings

class Settings(BaseSettings):
    app_name: str
    debug_mode: bool = False

settings = Settings()

If the environment variable APP_NAME is set to "MyApp" and DEBUG_MODE is not set, what will settings.app_name and settings.debug_mode be?

medium

A. None and None

B. "MyApp" and True

C. None and False

D. "MyApp" and False

Solution

1. Step 1: Understand BaseSettings behavior

   Pydantic BaseSettings reads environment variables matching attribute names in uppercase by default.

2. Step 2: Check provided environment variables and defaults

   APP_NAME is set to "MyApp", so settings.app_name is "MyApp". DEBUG_MODE is not set, so it uses the default False.

3. Final Answer:

   "MyApp" and False -> Option D

4. Quick Check:

   Env var set = value, missing uses default [OK]

Hint: Unset vars use default values in BaseSettings [OK]

Common Mistakes:

• Assuming missing env vars become True
• Thinking unset vars become None instead of default
• Confusing attribute names with env var names

4. What is wrong with this FastAPI environment variable usage code?

import os

API_KEY = os.getenv('API_KEY')
print(f"API key is {API_KEY.upper()}")

Assuming API_KEY is not set in the environment.

medium

A. It will raise an AttributeError because API_KEY is None

B. It will print 'API key is ' with empty string

C. It will raise a SyntaxError

D. It will print the string 'None'

Solution

1. Step 1: Check os.getenv behavior when var missing

   os.getenv returns None if the environment variable is not set and no default is given.

2. Step 2: Understand what happens calling upper() on None

   Calling None.upper() raises an AttributeError because NoneType has no method upper().

3. Final Answer:

   It will raise an AttributeError because API_KEY is None -> Option A

4. Quick Check:

   None.upper() causes AttributeError [OK]

Hint: Check for None before calling string methods [OK]

Common Mistakes:

• Assuming os.getenv returns empty string if missing
• Expecting no error when calling upper() on None
• Confusing AttributeError with SyntaxError

5. You want to manage environment variables in FastAPI using Pydantic's BaseSettings and ensure a default port of 8000 if PORT is not set. Which code snippet correctly achieves this?

hard

A. class Settings(BaseSettings):
port: int

settings = Settings(port=8000)

B. class Settings(BaseSettings):
port: int

settings = Settings() # default 8000 if missing

C. class Settings(BaseSettings):
port: int = 8000

settings = Settings()

D. class Settings(BaseSettings):
port: str = '8000'

settings = Settings()

Solution

1. Step 1: Define default value in BaseSettings attribute

   Setting port: int = 8000 provides a default if the environment variable PORT is missing.

2. Step 2: Instantiate Settings without arguments

   Calling Settings() reads environment variables or uses defaults if missing, so port will be 8000 if PORT is unset.

3. Final Answer:

   class Settings(BaseSettings): port: int = 8000 settings = Settings() -> Option C

4. Quick Check:

   Default values in BaseSettings = default used if env var missing [OK]

Hint: Set default in class attribute for fallback [OK]

Common Mistakes:

• Not providing default and expecting fallback
• Passing default in constructor instead of attribute
• Using string type for port instead of int