Environment-based configuration in Flask - Mini Project: Build & Apply

Environment-based configuration

📖 Scenario: You are building a simple Flask web application that needs to behave differently depending on the environment it runs in, such as development or production. This is common in real projects where you want to enable debugging in development but disable it in production for security.

🎯 Goal: Create a Flask app that reads its configuration from an environment variable called FLASK_ENV. The app should set debug mode to true if FLASK_ENV is development, and false otherwise.

📋 What You'll Learn

Create a Flask app instance named app

Read the environment variable FLASK_ENV to determine the environment

Set app.config['DEBUG'] to true if FLASK_ENV is development

Set app.config['DEBUG'] to false if FLASK_ENV is not development

Add a simple route / that returns 'Hello, Flask!'

💡 Why This Matters

🌍 Real World

Many web applications need to behave differently in development and production environments. Using environment variables to control configuration is a common and secure way to manage this.

💼 Career

Understanding environment-based configuration is essential for deploying Flask apps safely and effectively in real-world jobs.

1

Create the Flask app instance

Import Flask from flask and create a Flask app instance called app.

Flask

from flask import Flask

# Create the Flask app instance called app
# Your code here

Hint

Use Flask(__name__) to create the app instance.

2

Read the environment variable FLASK_ENV

Import os and create a variable called env that reads the environment variable FLASK_ENV using os.getenv.

Flask

from flask import Flask
import os

app = Flask(__name__)

# Read the environment variable FLASK_ENV into variable env
# Your code here

Hint

Use os.getenv('FLASK_ENV') to get the environment variable.

3

Set app.config['DEBUG'] based on environment

Use an if statement to set app.config['DEBUG'] = True if env == 'development', otherwise set app.config['DEBUG'] = False.

Flask

from flask import Flask
import os

app = Flask(__name__)

env = os.getenv('FLASK_ENV')

# Set app.config['DEBUG'] to True if env is 'development', else False
# Your code here

Hint

Use a simple if and else to set the debug config.

4

Add a route that returns a greeting

Add a route to app for the path '/' using @app.route('/'). Define a function called home that returns the string 'Hello, Flask!'.

Flask

from flask import Flask
import os

app = Flask(__name__)

env = os.getenv('FLASK_ENV')

if env == 'development':
    app.config['DEBUG'] = True
else:
    app.config['DEBUG'] = False

# Add a route '/' that returns 'Hello, Flask!'
# Your code here

Hint

Use @app.route('/') decorator and define a function that returns the greeting.

Practice

1. What is the main reason to use environment-based configuration in a Flask app?

easy

A. To avoid using environment variables completely

B. To write all configuration directly in the main app file

C. To separate settings for development, testing, and production environments

D. To hardcode sensitive data like passwords in the code

Solution

1. Step 1: Understand environment-based configuration purpose

   It helps keep different settings for development, testing, and production separate and secure.

2. Step 2: Identify best practice for config management

   Separating configs avoids hardcoding sensitive data and makes the app flexible across environments.

3. Final Answer:

   To separate settings for development, testing, and production environments -> Option C

4. Quick Check:

   Environment-based config = Separate settings [OK]

Hint: Think about keeping dev and prod settings separate [OK]

Common Mistakes:

• Hardcoding all config in one file
• Ignoring environment differences
• Storing secrets in code
• Not using environment variables

2. Which of the following is the correct way to load configuration from a Python class in Flask?

easy

A. app.config.from_object('config.DevelopmentConfig')

B. app.config.from_file('config.py')

C. app.load_config('config.py')

D. app.config.load('DevelopmentConfig')

Solution

1. Step 1: Recall Flask config loading methods

   Flask uses from_object to load config from a Python class.

2. Step 2: Match correct syntax

   app.config.from_object('config.DevelopmentConfig') correctly loads the class named DevelopmentConfig from config module.

3. Final Answer:

   app.config.from_object('config.DevelopmentConfig') -> Option A

4. Quick Check:

   Use from_object to load class config [OK]

Hint: Use from_object with full class path string [OK]

Common Mistakes:

• Using non-existent methods like from_file or load_config
• Passing filename instead of class path
• Missing quotes around class path
• Confusing from_object with from_envvar

3. Given this Flask config setup:

class Config:
    DEBUG = False

class DevelopmentConfig(Config):
    DEBUG = True

app = Flask(__name__)
app.config.from_object(DevelopmentConfig)
print(app.config['DEBUG'])

What will be printed?

medium

A. False

B. KeyError

C. None

D. True

Solution

1. Step 1: Understand class inheritance

   DevelopmentConfig inherits from Config and overrides DEBUG to True.

2. Step 2: Check which config is loaded

   app.config.from_object loads DevelopmentConfig, so DEBUG is True.

3. Final Answer:

   True -> Option D

4. Quick Check:

   Subclass overrides DEBUG = True [OK]

Hint: Subclass config overrides parent values [OK]

Common Mistakes:

• Assuming base class value is used
• Confusing attribute names
• Expecting KeyError for existing keys
• Ignoring inheritance

4. What is wrong with this Flask config loading code?

app = Flask(__name__)
app.config.from_envvar('MY_CONFIG')

Assuming the environment variable MY_CONFIG is not set.

medium

A. It will silently ignore missing MY_CONFIG and use default config

B. It will raise a RuntimeError because MY_CONFIG is missing

C. It will load config from a file named 'MY_CONFIG'

D. It will load config from environment variables automatically

Solution

1. Step 1: Understand from_envvar behavior

   from_envvar expects an environment variable with a filepath; if missing, it raises RuntimeError.

2. Step 2: Check what happens if MY_CONFIG is not set

   Since MY_CONFIG is missing, Flask raises RuntimeError to alert missing config file.

3. Final Answer:

   It will raise a RuntimeError because MY_CONFIG is missing -> Option B

4. Quick Check:

   Missing env var causes RuntimeError [OK]

Hint: from_envvar requires env var set or it errors [OK]

Common Mistakes:

• Assuming it ignores missing env var
• Thinking it loads from env vars automatically
• Confusing from_envvar with from_object
• Expecting silent fallback to defaults

5. You want your Flask app to load different configs based on the environment variable FLASK_ENV. Which code snippet correctly implements this?

hard

A. if os.getenv('FLASK_ENV') == 'production':
app.config.from_object('config.ProductionConfig')
else:
app.config.from_object('config.DevelopmentConfig')

B. app.config.from_object('config.' + FLASK_ENV + 'Config')

C. app.config.from_envvar('FLASK_ENV')

D. app.config.from_object('config.DefaultConfig')

Solution

1. Step 1: Check how to read environment variable

   Use os.getenv('FLASK_ENV') to get the current environment string.

2. Step 2: Use conditional logic to load correct config

   If environment is 'production', load ProductionConfig; otherwise load DevelopmentConfig.

3. Final Answer:

   if os.getenv('FLASK_ENV') == 'production': app.config.from_object('config.ProductionConfig') else: app.config.from_object('config.DevelopmentConfig') -> Option A

4. Quick Check:

   Use os.getenv + if-else to select config [OK]

Hint: Use os.getenv and if-else to pick config class [OK]

Common Mistakes:

• Trying to concatenate string without quotes
• Using from_envvar with FLASK_ENV directly
• Not handling default environment
• Loading only one config regardless of env