Response object creation in Flask - Mini Project: Build & Apply

Response Object Creation in Flask

📖 Scenario: You are building a simple web server using Flask. You want to send custom responses to users when they visit certain pages.

🎯 Goal: Create a Flask app that returns a custom response object with specific content and status code.

📋 What You'll Learn

Create a Flask app instance named app

Define a route /hello that returns a response object

The response object must contain the text 'Hello, Flask!'

Set the HTTP status code of the response to 200

💡 Why This Matters

🌍 Real World

Web servers often need to send custom responses with specific content and status codes to clients.

💼 Career

Understanding how to create and customize response objects is essential for backend web development with Flask.

1

Create the Flask app instance

Create a Flask app instance named app by importing Flask from flask and initializing it.

Flask

from flask import Flask

# Create the Flask app instance named app
# Your code here

Hint

Use app = Flask(__name__) to create the app instance.

2

Define a route for /hello

Define a route /hello using @app.route('/hello') and create a function named hello that will handle requests to this route.

Flask

from flask import Flask

app = Flask(__name__)

# Define a route /hello and a function hello
# Your code here

Hint

Use the @app.route('/hello') decorator and define a function hello().

3

Create a response object with text

Inside the hello function, import Response from flask and create a response object with the text 'Hello, Flask!'.

Flask

from flask import Flask

app = Flask(__name__)

@app.route('/hello')
def hello():
    # Import Response and create a response with 'Hello, Flask!'
    # Your code here

Hint

Use return Response('Hello, Flask!') inside the function.

4

Set the HTTP status code to 200

Modify the response object creation in the hello function to set the HTTP status code to 200 explicitly.

Flask

from flask import Flask, Response

app = Flask(__name__)

@app.route('/hello')
def hello():
    # Return Response with text and status code 200
    # Your code here

Hint

Pass status=200 as a parameter to Response.

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