Response headers in Flask - Step-by-Step Execution

Concept Flow - Response headers

Client sends HTTP request

↓

Flask app processes request

↓

Create response object

↓

Add headers to response

↓

Send response with headers back to client

↓

Client receives response with headers

This flow shows how a Flask app receives a request, creates a response, adds headers, and sends it back to the client.

Execution Sample

Flask

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

@app.route('/')
def index():
    resp = make_response('Hello World')
    resp.headers['X-Custom-Header'] = 'MyValue'
    return resp

This Flask route returns 'Hello World' with a custom response header 'X-Custom-Header'.

Execution Table

Step	Action	Response Content	Headers Before	Headers After
1	Request received at '/' route		{}	{}
2	Create response with body 'Hello World'	Hello World	{}	{}
3	Add header 'X-Custom-Header: MyValue'	Hello World	{}	{'X-Custom-Header': 'MyValue'}
4	Return response to client	Hello World	{'X-Custom-Header': 'MyValue'}	{'X-Custom-Header': 'MyValue'}

💡 Response sent with body and custom header; request handling complete.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
resp.headers	{}	{}	{'X-Custom-Header': 'MyValue'}	{'X-Custom-Header': 'MyValue'}
resp.data	null	b'Hello World'	b'Hello World'	b'Hello World'

Key Moments - 2 Insights

Why do we add headers after creating the response object?

Because the response object must exist first to modify its headers, as shown in step 3 of the execution_table.

Can we add multiple headers the same way?

Yes, you can add multiple headers by assigning different keys in resp.headers before returning, similar to step 3.

Visual Quiz - 3 Questions

Look at the execution_table at step 3, what header is added to the response?

A X-Custom-Header with value 'MyValue'

B Content-Type with value 'text/html'

C Server with value 'Flask'

D Authorization with value 'Bearer token'

💡 Hint

Check the 'Headers After' column at step 3 in the execution_table.

At which step does the response body get set to 'Hello World'?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at the 'Response Content' column in the execution_table.

If you add another header 'Cache-Control' before returning, how would the 'Headers After' look at step 4?

A {'X-Custom-Header': 'MyValue'}

B {}

C {'X-Custom-Header': 'MyValue', 'Cache-Control': 'no-cache'}

D {'Cache-Control': 'no-cache'}

💡 Hint

Refer to variable_tracker and how headers accumulate after step 3.

Concept Snapshot

Flask Response Headers Quick Guide:
- Create response object with make_response()
- Add headers via resp.headers['Header-Name'] = 'value'
- Return response object from route
- Headers sent with response to client
- Use headers to control caching, security, or custom info

Full Transcript

In Flask, when a client sends a request, the app processes it and creates a response object. We can add headers to this response by modifying resp.headers before returning it. For example, adding a custom header 'X-Custom-Header' with a value. The response body and headers are then sent back to the client. This process allows us to control extra information sent with the response, like caching or security details.

Practice

1. What is the purpose of response headers in a Flask web application?

easy

A. To send extra information from the server to the browser

B. To store user data on the server

C. To write data into the database

D. To create HTML content dynamically

Solution

1. Step 1: Understand what response headers do

   Response headers carry extra information about the response, like content type or caching rules.

2. Step 2: Identify their role in Flask

   In Flask, response headers are sent from the server to the browser to control how the browser handles the response.

3. Final Answer:

   To send extra information from the server to the browser -> Option A

4. Quick Check:

   Response headers = extra info sent to browser [OK]

Hint: Response headers send info from server to browser [OK]

Common Mistakes:

• Confusing headers with server-side data storage
• Thinking headers create HTML content
• Mixing headers with database operations

2. Which of the following is the correct way to add a custom header X-Custom-Header with value Test to a Flask response?

easy

A. response.set_header('X-Custom-Header', 'Test')

B. response.add_header('X-Custom-Header', 'Test')

C. response.header('X-Custom-Header', 'Test')

D. response.headers['X-Custom-Header'] = 'Test'

Solution

1. Step 1: Recall Flask response header syntax

   In Flask, headers are set by assigning values to keys in the response.headers dictionary.

2. Step 2: Match the correct syntax

   Only response.headers['X-Custom-Header'] = 'Test' uses the correct dictionary assignment syntax.

3. Final Answer:

   response.headers['X-Custom-Header'] = 'Test' -> Option D

4. Quick Check:

   Use dictionary assignment for headers [OK]

Hint: Set headers by assigning to response.headers dict [OK]

Common Mistakes:

• Using non-existent methods like add_header or set_header
• Calling response.header() which does not exist
• Trying to set headers as function calls

3. Given this Flask code snippet, what will be the value of the Content-Type header in the response?

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

@app.route('/')
def index():
    response = make_response('Hello')
    response.headers['Content-Type'] = 'application/json'
    return response

medium

A. text/html

B. application/json

C. text/plain

D. application/xml

Solution

1. Step 1: Check the header assignment in the code

   The code sets response.headers['Content-Type'] = 'application/json', which overrides the default.

2. Step 2: Understand the effect on response

   This means the response will have the Content-Type header set to application/json.

3. Final Answer:

   application/json -> Option B

4. Quick Check:

   Content-Type header = application/json [OK]

Hint: Headers set in code override defaults [OK]

Common Mistakes:

• Assuming default Content-Type without checking header override
• Confusing Content-Type with response body content
• Ignoring header assignment line

4. What is wrong with this Flask code that tries to add a header?

from flask import Flask
app = Flask(__name__)

@app.route('/')
def home():
    response = 'Hello'
    response.headers['X-Test'] = 'Value'
    return response

medium

A. You cannot add headers to a string response directly

B. The header key must be lowercase

C. The header value must be an integer

D. Flask does not support custom headers

Solution

1. Step 1: Identify the response type

   The response is a plain string, not a response object.

2. Step 2: Understand header assignment requirements

   Headers can only be set on response objects, not on strings.

3. Final Answer:

   You cannot add headers to a string response directly -> Option A

4. Quick Check:

   Headers require response object, not string [OK]

Hint: Headers need response object, not plain string [OK]

Common Mistakes:

• Trying to set headers on string instead of response
• Thinking header keys must be lowercase
• Believing Flask disallows custom headers

5. You want to add a header Cache-Control with value no-store to all responses in your Flask app. Which is the best way to do this?

hard

A. Set Cache-Control in the HTML meta tags

B. Add response.headers['Cache-Control'] = 'no-store' inside every route function

C. Use a @app.after_request function to add the header to all responses

D. Modify the Flask source code to add the header globally

Solution

1. Step 1: Understand the goal

   You want to add the header to all responses automatically, not manually in each route.

2. Step 2: Identify Flask feature for global response modification

   The @app.after_request decorator lets you modify every response before sending it.

3. Step 3: Evaluate options

   The @app.after_request decorator adds the header to every response automatically, which is efficient and clean.

4. Final Answer:

   Use a @app.after_request function to add the header to all responses -> Option C

5. Quick Check:

   Use after_request to set headers globally [OK]

Hint: Use @app.after_request to add headers globally [OK]

Common Mistakes:

• Adding header manually in every route (Option B)
• Trying to set headers in HTML meta tags (Option C)
• Editing Flask source code (Option D)