Context lifecycle execution in Flask

Introduction

Flask uses contexts to keep track of data during a request or application run. This helps Flask know what data belongs to which user or task without mixing them up.

When you want to access request data like form inputs or URL parameters inside your functions.

When you need to store information that should only last during a single web request.

When you want to share data across different parts of your app safely during a request.

When you want to run code before or after handling a web request.

When you want to manage resources like database connections that open and close with each request.

Syntax

Flask

from flask import Flask, request, g

app = Flask(__name__)

@app.before_request
def before():
    # Code to run before each request
    g.user = 'Guest'

@app.route('/')
def index():
    return f"Hello, {g.user}!"

@app.teardown_request
def teardown(exception=None):
    # Code to run after each request
    pass

@app.before_request runs code before each request starts.

@app.teardown_request runs code after each request ends, even if there was an error.

Examples

This sets a user name before handling any request, so you can use g.user inside your routes.

Flask

from flask import Flask, g

app = Flask(__name__)

@app.before_request
def set_user():
    g.user = 'Alice'

This checks if the request has an Authorization header before running the route. If not, it stops with a 401 error.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.before_request
def check_auth():
    if not request.headers.get('Authorization'):
        return 'Unauthorized', 401

This runs after every request to clean up resources like database connections.

Flask

from flask import Flask

app = Flask(__name__)

@app.teardown_request
def close_db(error=None):
    print('Request finished, closing resources')

Sample Program

This Flask app sets a user name from the URL query parameter before each request. The route greets the user by name or says 'Guest' if no name is given. After the request, it prints a message in the console.

Flask

from flask import Flask, g, request

app = Flask(__name__)

@app.before_request
def before():
    g.user = request.args.get('user', 'Guest')

@app.route('/')
def index():
    return f"Hello, {g.user}!"

@app.teardown_request
def teardown(exception=None):
    print('Request ended')

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

Important Notes

The g object is a place to store data during a request. It resets for each new request.

Contexts help Flask know which request is running, so data doesn't get mixed between users.

Use before_request to prepare data and teardown_request to clean up.

Summary

Flask uses context lifecycle hooks to run code before and after each request.

This helps manage data and resources safely during web requests.

Use g to store request-specific data accessible in your routes.

Practice

1. What is the main purpose of Flask's before_request function in the context lifecycle?

easy

A. To run code before each request to prepare data or resources

B. To clean up resources after a request finishes

C. To handle errors during a request

D. To define the URL routes for the application

Solution

1. Step 1: Understand the role of before_request

   This function runs before each request to set up anything needed during the request.

2. Step 2: Compare with other lifecycle hooks

   after_request cleans up after requests, error handlers manage errors, and routes define URLs.

3. Final Answer:

   To run code before each request to prepare data or resources -> Option A

4. Quick Check:

   before_request runs before request [OK]

Hint: Remember: before_request runs setup code before handling requests [OK]

Common Mistakes:

• Confusing before_request with after_request
• Thinking before_request handles errors
• Mixing route definitions with lifecycle hooks

2. Which of the following is the correct way to store data for the current request using Flask's context?

easy

A. Store data in the g object inside a before_request function

B. Use a global variable outside the request

C. Save data in a class variable of the Flask app

D. Write data directly to the response object

Solution

1. Step 1: Identify how Flask manages request-specific data

   Flask provides the g object to store data unique to each request.

2. Step 2: Confirm correct usage

   Using g inside before_request ensures data is set up before route handlers run.

3. Final Answer:

   Store data in the g object inside a before_request function -> Option A

4. Quick Check:

   g stores request data [OK]

Hint: Use g for request data, not globals [OK]

Common Mistakes:

• Using global variables that persist across requests
• Trying to store request data in app class variables
• Modifying the response object directly for data storage

3. Given this Flask code snippet, what will be printed when a request is made to /hello?

from flask import Flask, g
app = Flask(__name__)

@app.before_request
def before():
    g.message = 'Hi'

@app.route('/hello')
def hello():
    return g.message + ' there!'

medium

A. there!

B. Error: g.message not set

C. Hi there!

D. Hi

Solution

1. Step 1: Analyze the before_request function

   The function sets g.message to 'Hi' before the route runs.

2. Step 2: Check the route handler output

   The route returns g.message + ' there!', which becomes 'Hi there!'.

3. Final Answer:

   Hi there! -> Option C

4. Quick Check:

   g.message set before route [OK]

Hint: before_request sets g data used in routes [OK]

Common Mistakes:

• Assuming g.message is not set yet
• Forgetting before_request runs before routes
• Expecting an error due to missing g attribute

4. What is wrong with this Flask code that tries to use g outside a request context?

from flask import Flask, g
app = Flask(__name__)

g.message = 'Hello'

@app.route('/')
def index():
    return g.message

medium

A. The g object cannot store strings

B. The route function is missing a return statement

C. The app is missing a secret key

D. Accessing g outside a request causes a runtime error

Solution

1. Step 1: Identify where g is assigned

   g.message = 'Hello' is set outside any request or app context.

2. Step 2: Understand Flask context rules

   g is only available during a request context; accessing it outside causes an error.

3. Final Answer:

   Accessing g outside a request causes a runtime error -> Option D

4. Quick Check:

   g only valid inside requests [OK]

Hint: Set g only inside request functions [OK]

Common Mistakes:

• Setting g variables globally outside requests
• Confusing g with global variables
• Ignoring Flask's context lifecycle rules

5. You want to log the time taken by each request in your Flask app. Which is the best way to do this using context lifecycle hooks?

hard

A. Use teardown_request to set start time and before_request to log duration

B. Use before_request to store start time in g, and after_request to calculate and log duration

C. Log the time only inside the route without lifecycle hooks

D. Store start time in a global variable and log it in the route function

Solution

1. Step 1: Use before_request to mark start time

   Store the current time in g.start_time before the request runs.

2. Step 2: Use after_request to calculate duration and log

   Calculate elapsed time using current time minus g.start_time and log it, then return the response.

3. Final Answer:

   Use before_request to store start time in g, and after_request to calculate and log duration -> Option B

4. Quick Check:

   Use before_request and after_request for timing [OK]

Hint: Start timer before, log after request finishes [OK]

Common Mistakes:

• Using global variables instead of g
• Logging time only inside routes missing full request duration
• Mixing up lifecycle hook order