Response object creation in Flask

Introduction

A response object in Flask is what your web app sends back to the user's browser. It tells the browser what to show or do next.

When you want to send a simple message or HTML page back to the user.

When you need to send a file or image as a response.

When you want to customize the status code or headers of the response.

When you want to redirect the user to another page.

When you want to return JSON data from an API endpoint.

Syntax

Flask

from flask import Response

response = Response(response=None, status=None, headers=None, mimetype=None, content_type=None, direct_passthrough=False)

The response parameter is the content you want to send back, like text or HTML.

You can set status to a number like 200 (OK) or 404 (Not Found).

Examples

This creates a plain text response with the message "Hello, world!" and status code 200.

Flask

from flask import Response

resp = Response("Hello, world!", status=200, mimetype='text/plain')

This sends back HTML content to show a heading.

Flask

from flask import Response

resp = Response("<h1>Welcome</h1>", mimetype='text/html')

This adds a custom header to the response.

Flask

from flask import Response

headers = {'X-Custom-Header': 'MyValue'}
resp = Response("Data", headers=headers)

This creates a response with no content but a 404 Not Found status.

Flask

from flask import Response

resp = Response(status=404)

Sample Program

This Flask app sends a simple HTML heading as a response when you visit the home page.

Flask

from flask import Flask, Response

app = Flask(__name__)

@app.route('/')
def home():
    content = "<h1>Hello from Flask!</h1>"
    return Response(content, status=200, mimetype='text/html')

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

Important Notes

Use mimetype or content_type to tell the browser what kind of content you are sending.

Always set the correct status code to help browsers and tools understand the response.

Flask also provides shortcut functions like flask.jsonify and flask.redirect for common response types.

Summary

A Response object is what Flask sends back to the user's browser.

You can customize the content, status code, headers, and content type.

Creating a Response object lets you control exactly what the user receives.

Practice

1. What is the main purpose of a Response object in Flask?

easy

A. To store user session information

B. To send data back to the user's browser

C. To receive data from the user's browser

D. To connect to a database

Solution

1. Step 1: Understand Flask's response role

   A Response object in Flask is what the server sends back to the user's browser after processing a request.

2. Step 2: Identify the correct purpose

   Since the Response object controls what the user receives, it is used to send data back to the browser.

3. Final Answer:

   To send data back to the user's browser -> Option B

4. Quick Check:

   Response object = send data back [OK]

Hint: Response objects send data back to the browser [OK]

Common Mistakes:

• Confusing response with request handling
• Thinking Response stores session data
• Assuming Response connects to databases

2. Which of the following is the correct way to create a Response object with the text 'Hello' and status code 200 in Flask?

easy

A. return Response('Hello', status=200)

B. return Response('Hello', code=200)

C. return Response('Hello', status_code=200)

D. return Response('Hello', stat=200)

Solution

1. Step 1: Recall Response constructor parameters

   The Flask Response object accepts a status parameter to set the HTTP status code.

2. Step 2: Match correct parameter name

   Only status=200 is valid; code, status_code, and stat are invalid.

3. Final Answer:

   return Response('Hello', status=200) -> Option A

4. Quick Check:

   Use status= for HTTP code [OK]

Hint: Use status= to set HTTP status code in Response [OK]

Common Mistakes:

• Using incorrect parameter names like code or stat
• Confusing status with status_code
• Omitting the status parameter

3. What will be the output status code when this Flask code runs?

from flask import Response

resp = Response('Not Found', status=404)
print(resp.status_code)

medium

A. 404

B. 200

C. 500

D. None

Solution

1. Step 1: Check Response creation

   The Response is created with the text 'Not Found' and status=404, which sets the HTTP status code to 404.

2. Step 2: Access status_code attribute

   Printing resp.status_code will output the status code set, which is 404.

3. Final Answer:

   404 -> Option A

4. Quick Check:

   Status code set = printed status_code [OK]

Hint: Response.status_code shows the HTTP status code [OK]

Common Mistakes:

• Assuming default 200 status code
• Confusing status with response content
• Expecting None or error output

4. Identify the error in this Flask code snippet:

from flask import Response

resp = Response('OK', status_code=200)
return resp

medium

A. Response object cannot be returned directly

B. Response content must be bytes, not string

C. Response constructor does not accept status_code parameter

D. Missing import for Flask app

Solution

1. Step 1: Check Response constructor parameters

   The Response object uses status to set HTTP status, not status_code.

2. Step 2: Identify the error

   Using status_code=200 causes a TypeError because it is not a valid parameter.

3. Final Answer:

   Response constructor does not accept status_code parameter -> Option C

4. Quick Check:

   Use status= not status_code in Response [OK]

Hint: Use status=, not status_code= in Response constructor [OK]

Common Mistakes:

• Using status_code instead of status
• Thinking Response content must be bytes
• Assuming Response can't be returned directly

5. You want to create a Flask Response object that returns JSON data {"success": true} with status 201 and a custom header X-Custom: Yes. Which code snippet correctly does this?

hard

A. return Response(json.dumps({"success": true}), status=201, content_type='application/json', headers={'X-Custom': 'Yes'})

B. return Response(json.dumps({"success": true}), status=201, mimetype='application/json', header={'X-Custom': 'Yes'})

C. return Response('{"success": true}', status_code=201, mimetype='application/json', headers={'X-Custom': 'Yes'})

D. return Response('{"success": true}', status=201, mimetype='application/json', headers={'X-Custom': 'Yes'})

Solution

1. Step 1: Check status parameter correctness

   Use status=201 to set the HTTP status code correctly.

2. Step 2: Verify mimetype and headers usage

   mimetype='application/json' correctly sets content type; headers must be a dictionary with correct key.

3. Step 3: Identify errors in other options

   return Response(json.dumps({"success": true}), status=201, content_type='application/json', headers={'X-Custom': 'Yes'}) uses content_type which is valid but misses importing json and json.dumps usage is not shown; return Response('{"success": true}', status_code=201, mimetype='application/json', headers={'X-Custom': 'Yes'}) uses invalid status_code; return Response(json.dumps({"success": true}), status=201, mimetype='application/json', header={'X-Custom': 'Yes'}) uses incorrect header key (should be headers).

4. Final Answer:

   return Response('{"success": true}', status=201, mimetype='application/json', headers={'X-Custom': 'Yes'}) -> Option D

5. Quick Check:

   Status=201, mimetype, headers dict correct [OK]

Hint: Use status=, mimetype=, and headers={} for custom Response [OK]

Common Mistakes:

• Using status_code instead of status
• Wrong headers key name (header vs headers)
• Forgetting to set mimetype for JSON