Configuration management in Flask

Introduction

Configuration management helps you keep your app settings organized and easy to change without touching the main code.

You want to set different settings for development and production.

You need to keep secret keys or passwords safe and separate from code.

You want to change database connection details without rewriting your app.

You want to enable or disable features easily by changing config values.

You want to keep your app flexible and easy to maintain.

Syntax

Flask

app = Flask(__name__)
app.config['KEY'] = 'value'

# Or load from a config file
app.config.from_pyfile('config.py')

You can set config values directly on app.config like a dictionary.

Using from_pyfile loads settings from a separate Python file.

Examples

Set debug mode on directly in your app.

Flask

app.config['DEBUG'] = True

Load all config values from a separate file named config.py.

Flask

app.config.from_pyfile('config.py')

Set multiple config values at once using from_mapping.

Flask

app.config.from_mapping(
    SECRET_KEY='mysecret',
    DATABASE_URI='sqlite:///mydb.sqlite'
)

Sample Program

This simple Flask app sets configuration values directly. It shows how to read those values inside a route to change behavior or display info.

Flask

from flask import Flask

app = Flask(__name__)

# Set config directly
app.config['DEBUG'] = True
app.config['SECRET_KEY'] = 'supersecretkey'

@app.route('/')
def home():
    debug_status = 'on' if app.config['DEBUG'] else 'off'
    return f"Debug mode is {debug_status}. Secret key length is {len(app.config['SECRET_KEY'])}."

if __name__ == '__main__':
    app.run()

Important Notes

Keep secret keys out of public code by using environment variables or separate config files.

You can create different config files for development, testing, and production.

Use app.config.from_envvar() to load config from environment variable paths.

Summary

Configuration management keeps your app settings organized and easy to change.

Use app.config like a dictionary to set or get settings.

Load settings from files or environment variables for flexibility and security.

Practice

1. What is the primary purpose of app.config in a Flask application?

easy

A. To define URL routes

B. To handle user sessions

C. To render HTML templates

D. To store and manage application settings

Solution

1. Step 1: Understand the role of app.config

   app.config is a special dictionary in Flask used to keep app settings organized.

2. Step 2: Compare with other Flask features

   User sessions, URL routes, and templates are handled by other parts of Flask, not app.config.

3. Final Answer:

   To store and manage application settings -> Option D

4. Quick Check:

   App settings = app.config [OK]

Hint: Remember: config means settings storage [OK]

Common Mistakes:

• Confusing config with routing or templates
• Thinking config handles user data
• Assuming config runs code

2. Which of the following is the correct way to set a configuration value named DEBUG to True in Flask?

easy

A. app.config['DEBUG'] = True

B. app.config.DEBUG = True

C. app.set_config('DEBUG', True)

D. app.config.set('DEBUG', True)

Solution

1. Step 1: Recall Flask config syntax

   Flask config uses dictionary syntax: app.config['KEY'] = value.

2. Step 2: Check each option

   app.config['DEBUG'] = True uses correct dictionary syntax. Dot notation, set_config, and config.set use invalid or non-existent methods.

3. Final Answer:

   app.config['DEBUG'] = True -> Option A

4. Quick Check:

   Set config like dict key-value [OK]

Hint: Use square brackets to set config keys [OK]

Common Mistakes:

• Using dot notation instead of dictionary syntax
• Calling non-existent methods like set_config
• Confusing config with other Flask methods

3. Given this Flask code snippet:

app = Flask(__name__)
app.config['DEBUG'] = False
app.config.from_mapping({'DEBUG': True, 'TESTING': True})
print(app.config['DEBUG'])

What will be printed?

medium

A. False

B. True

C. None

D. KeyError

Solution

1. Step 1: Understand config assignment order

   First, DEBUG is set to False. Then from_mapping updates it to True.

2. Step 2: Determine final value

   The last assignment wins, so DEBUG becomes True.

3. Final Answer:

   True -> Option B

4. Quick Check:

   Last config set wins [OK]

Hint: Later config calls overwrite earlier ones [OK]

Common Mistakes:

• Assuming first value stays
• Thinking from_mapping adds without overwrite
• Expecting error on duplicate keys

4. What is wrong with this Flask configuration code?

app = Flask(__name__)
app.config.from_pyfile('config.py')
app.config['SECRET_KEY'] = 'mysecret'

Assuming config.py does not exist in the project folder.

medium

A. It will raise a FileNotFoundError

B. It will silently ignore missing file

C. It will set SECRET_KEY before loading file

D. It will overwrite SECRET_KEY with None

Solution

1. Step 1: Understand from_pyfile behavior

   from_pyfile tries to load a Python file and raises an error if missing.

2. Step 2: Check file existence

   Since config.py does not exist, a FileNotFoundError occurs immediately.

3. Final Answer:

   It will raise a FileNotFoundError -> Option A

4. Quick Check:

   Missing config file causes error [OK]

Hint: Missing config files cause errors, not silent skips [OK]

Common Mistakes:

• Thinking Flask ignores missing config files
• Assuming config keys set before loading file are overwritten
• Expecting None values on missing keys

5. You want to load configuration in Flask from environment variables but provide default values if they are missing. Which code snippet correctly achieves this?

hard

A. app.config['DEBUG'] = os.environ['DEBUG'] or False

B. app.config['DEBUG'] = os.getenv('DEBUG') or None

C. app.config['DEBUG'] = os.getenv('DEBUG', False)

D. app.config['DEBUG'] = os.environ.get('DEBUG')

Solution

1. Step 1: Understand environment variable access

   os.getenv('KEY', default) returns the environment value or default if missing.

2. Step 2: Analyze each option

   app.config['DEBUG'] = os.getenv('DEBUG', False) uses os.getenv with default False, correctly providing fallback. app.config['DEBUG'] = os.environ['DEBUG'] or False may raise KeyError if 'DEBUG' missing. app.config['DEBUG'] = os.environ.get('DEBUG') returns None if missing but no default. app.config['DEBUG'] = os.getenv('DEBUG') or None returns None if missing, not False.

3. Final Answer:

   app.config['DEBUG'] = os.getenv('DEBUG', False) -> Option C

4. Quick Check:

   Use getenv with default for safe config [OK]

Hint: Use os.getenv with default to avoid missing keys [OK]

Common Mistakes:

• Using os.environ[] without checking existence
• Not providing default values
• Confusing os.environ.get with os.getenv