After_request hooks in Flask - Mini Project: Build & Apply

Using After_request Hooks in Flask

📖 Scenario: You are building a simple Flask web app that returns a greeting message. You want to add a feature that modifies the response before it is sent to the user, such as adding a custom header.

🎯 Goal: Create a Flask app with a route that returns a greeting. Then use an after_request hook to add a custom header X-Custom-Header with the value FlaskProject to every response.

📋 What You'll Learn

Create a Flask app instance named app

Define a route /hello that returns the text Hello, Flask!

Create an after_request function named add_custom_header

In add_custom_header, add the header X-Custom-Header with value FlaskProject to the response

Return the modified response from add_custom_header

💡 Why This Matters

🌍 Real World

After_request hooks are useful to add headers like security policies, CORS, or custom metadata to all responses in a web app.

💼 Career

Understanding Flask hooks is important for backend web development roles that use Python and Flask to build APIs and web services.

1

Create the Flask app and a simple route

Import Flask from flask. Create a Flask app instance called app. Define a route /hello that returns the string 'Hello, Flask!'.

Flask

# Import Flask and create app
# Define route /hello that returns 'Hello, Flask!'
# Your code here

Hint

Use Flask(__name__) to create the app. Use @app.route('/hello') to define the route.

2

Create the after_request hook function

Define a function called add_custom_header that takes a parameter response. This function will be used as an after_request hook.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, Flask!'

# Define after_request function add_custom_header with parameter response
# Your code here

Hint

Define a function with one parameter named response and return it.

3

Add the custom header inside the after_request function

Inside the add_custom_header function, add a header X-Custom-Header with the value FlaskProject to the response.headers. Then return the modified response.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, Flask!'

def add_custom_header(response):
    # Add header X-Custom-Header with value FlaskProject
    # Your code here

Hint

Use response.headers['X-Custom-Header'] = 'FlaskProject' to add the header.

4

Register the after_request hook with the Flask app

Register the add_custom_header function as an after_request hook on the app by using the @app.after_request decorator above the function definition.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    return 'Hello, Flask!'

# Register add_custom_header as after_request hook
# Your code here
def add_custom_header(response):
    response.headers['X-Custom-Header'] = 'FlaskProject'
    return response

Hint

Use @app.after_request decorator above the function add_custom_header.

Practice

1. What is the main purpose of an after_request hook in Flask?

easy

A. To initialize the Flask app configuration

B. To handle incoming request data before routing

C. To define URL routes for the application

D. To modify the response before it is sent to the client

Solution

1. Step 1: Understand the role of after_request hooks

   After_request hooks run after the view function but before the response is sent to the client.

2. Step 2: Identify what after_request hooks modify

   They receive the response object and can modify it, such as adding headers or logging.

3. Final Answer:

   To modify the response before it is sent to the client -> Option D

4. Quick Check:

   After_request hooks modify response [OK]

Hint: Remember: after_request changes response, not request [OK]

Common Mistakes:

• Confusing after_request with before_request hooks
• Thinking after_request handles incoming data
• Assuming after_request defines routes

2. Which of the following is the correct syntax to register an after_request hook in Flask?

easy

A. @app.after_request\ndef modify_response(response):\n return response

B. @app.route('/after')\ndef modify_response():\n return 'Done'

C. @app.before_request\ndef modify_response(response):\n return response

D. @app.after_response\ndef modify_response(response):\n return response

Solution

1. Step 1: Identify the correct decorator for after_request

   The correct decorator is @app.after_request to register a function that modifies the response.

2. Step 2: Check function signature

   The function must accept one argument (the response) and return it.

3. Final Answer:

   @app.after_request\ndef modify_response(response):\n return response -> Option A

4. Quick Check:

   Use @app.after_request with response param [OK]

Hint: after_request needs @app.after_request decorator [OK]

Common Mistakes:

• Using @app.before_request instead of after_request
• Missing the response parameter in the function
• Using a non-existent decorator like @app.after_response

3. What will be the output headers after this Flask app runs a request?

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

@app.after_request
def add_header(response):
    response.headers['X-Custom'] = 'Hello'
    return response

@app.route('/')
def index():
    return Response('OK')

medium

A. Response with header 'X-Custom' set to 'Hello'

B. Response with no custom headers

C. Error because headers cannot be modified

D. Response with header 'X-Custom' set to 'OK'

Solution

1. Step 1: Understand after_request modifies response headers

   The after_request function adds a header 'X-Custom' with value 'Hello' to the response.

2. Step 2: Check the response returned by the route

   The route returns a Response with body 'OK' but no custom headers initially.

3. Step 3: Confirm header addition

   The after_request hook adds the header before sending, so the final response includes 'X-Custom: Hello'.

4. Final Answer:

   Response with header 'X-Custom' set to 'Hello' -> Option A

5. Quick Check:

   after_request adds headers to response [OK]

Hint: after_request can add headers before sending response [OK]

Common Mistakes:

• Thinking headers cannot be changed after response creation
• Confusing response body with headers
• Assuming after_request runs before route

4. Identify the error in this Flask after_request hook code:

from flask import Flask
app = Flask(__name__)

@app.after_request
def fix_response():
    print('Fixing response')
    return 'Fixed'

medium

A. The function should not return anything

B. The decorator should be @app.before_request

C. The function must accept a response parameter

D. The print statement is not allowed in after_request

Solution

1. Step 1: Check function signature for after_request

   Functions registered with @app.after_request must accept one argument: the response object.

2. Step 2: Analyze the return value

   The function returns a string instead of a response object, which is incorrect.

3. Step 3: Identify the main error

   Missing the response parameter causes Flask to raise an error because it expects the response argument.

4. Final Answer:

   The function must accept a response parameter -> Option C

5. Quick Check:

   after_request functions need response param [OK]

Hint: after_request functions always take response argument [OK]

Common Mistakes:

• Omitting the response parameter in after_request function
• Returning a string instead of a response object
• Confusing after_request with before_request

5. You want to add a security header X-Frame-Options: DENY to all responses except those from the /public route. How can you implement this using after_request hooks?

hard

A. Use before_request to add the header unconditionally

B. Use after_request to check request.path and add header only if path is not '/public'

C. Add the header inside each route function manually

D. Use after_request but always add the header regardless of path

Solution

1. Step 1: Use after_request to modify all responses

   after_request hooks run after every request and can modify the response before sending.

2. Step 2: Check the request path inside after_request

   By accessing request.path, you can conditionally add headers only when the path is not '/public'.

3. Step 3: Implement conditional header addition

   Inside the after_request function, add the header only if request.path != '/public'.

4. Final Answer:

   Use after_request to check request.path and add header only if path is not '/public' -> Option B

5. Quick Check:

   Conditionally add headers in after_request using request.path [OK]

Hint: Check request.path in after_request to add headers conditionally [OK]

Common Mistakes:

• Adding headers unconditionally ignoring route
• Using before_request which can't modify response headers
• Manually adding headers in every route instead of centralized hook