Request object properties in Flask - Mini Project: Build & Apply

Exploring Flask Request Object Properties

📖 Scenario: You are building a simple Flask web app that receives user data through a form submission. You want to access different parts of the incoming request to understand what the user sent.

🎯 Goal: Learn how to access key properties of the Flask request object such as method, args, and form to handle user input.

📋 What You'll Learn

Create a Flask app with a route that accepts GET and POST requests

Access the HTTP method used in the request

Access query parameters from the URL

Access form data sent via POST

💡 Why This Matters

🌍 Real World

Web apps often need to read user input sent via URLs or forms. Understanding how to access request data is essential for building interactive websites.

💼 Career

Backend developers working with Flask or similar frameworks must know how to handle incoming request data to process user input and build APIs.

1

Set up a basic Flask app with a route

Import Flask and request from flask. Create a Flask app called app. Define a route at '/' that accepts both GET and POST methods with a function called index.

Flask

from flask import Flask, request

# Create a Flask app called app
# Define a route '/' that accepts GET and POST methods with a function index

Hint

Remember to import both Flask and request. Use @app.route decorator with methods=['GET', 'POST'].

2

Access the HTTP method of the request

Inside the index function, create a variable called method and set it to request.method to get the HTTP method used.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.route('/', methods=['GET', 'POST'])
def index():
    # Get the HTTP method used in the request
    # Your code here

Hint

Use request.method to find out if the request is GET or POST.

3

Access query parameters from the URL

Inside the index function, create a variable called name and set it to request.args.get('name') to get the value of the query parameter named name.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.route('/', methods=['GET', 'POST'])
def index():
    method = request.method
    # Get the 'name' query parameter from the URL
    # Your code here

Hint

Use request.args.get('name') to access query parameters sent in the URL.

4

Access form data sent via POST

Inside the index function, create a variable called email and set it to request.form.get('email') to get the value of the form field named email.

Flask

from flask import Flask, request

app = Flask(__name__)

@app.route('/', methods=['GET', 'POST'])
def index():
    method = request.method
    name = request.args.get('name')
    # Get the 'email' form field from POST data
    # Your code here

Hint

Use request.form.get('email') to access form data sent in a POST request.

Practice

1. What does request.method in Flask represent?

easy

A. The client's IP address

B. The URL path requested by the client

C. The response status code

D. The HTTP method used by the client (GET, POST, etc.)

Solution

1. Step 1: Understand the role of request.method

   This property tells you which HTTP method the client used to send the request, such as GET or POST.

2. Step 2: Differentiate from other request properties

   It is not the URL path, IP address, or response code, which are accessed differently.

3. Final Answer:

   The HTTP method used by the client (GET, POST, etc.) -> Option D

4. Quick Check:

   request.method = HTTP method [OK]

Hint: Remember: method means GET, POST, PUT, DELETE [OK]

Common Mistakes:

• Confusing method with URL or path
• Thinking method is client IP
• Mixing method with response status

2. Which of the following is the correct way to access query parameters from a Flask request object?

easy

A. request.args.get('param')

B. request.form['param']

C. request.cookies['param']

D. request.headers['param']

Solution

1. Step 1: Identify how query parameters are accessed

   Query parameters are part of the URL after the question mark and are accessed via request.args.

2. Step 2: Use the correct method to get a parameter

   Using request.args.get('param') safely retrieves the value or returns None if missing.

3. Final Answer:

   request.args.get('param') -> Option A

4. Quick Check:

   Query params = request.args.get() [OK]

Hint: Query params use request.args.get('name') [OK]

Common Mistakes:

• Using request.form for query parameters
• Trying to get query params from cookies or headers
• Using request.args['param'] without .get() risking KeyError

3. Given this Flask route code snippet, what will be printed if a client sends a POST request with form data {'username': 'alice'}?

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

@app.route('/login', methods=['POST'])
def login():
    user = request.form.get('username')
    method = request.method
    return f"User: {user}, Method: {method}"

medium

A. User: alice, Method: POST

B. User: None, Method: GET

C. User: alice, Method: GET

D. User: None, Method: POST

Solution

1. Step 1: Understand the request method and form data

   The client sends a POST request with form data containing 'username' = 'alice'.

2. Step 2: Check how data is accessed in the code

   The code uses request.form.get('username') which retrieves 'alice', and request.method which is 'POST'.

3. Final Answer:

   User: alice, Method: POST -> Option A

4. Quick Check:

   Form data and method match output [OK]

Hint: Form data is in request.form; method is request.method [OK]

Common Mistakes:

• Assuming method is GET when POST was sent
• Using request.args instead of request.form for POST data
• Expecting None for existing form data

4. What is wrong with this Flask code snippet if it raises a KeyError when accessing request.form['email']?

@app.route('/submit', methods=['POST'])
def submit():
    email = request.form['email']
    return f"Email: {email}"

medium

A. Flask requires request.args for form data

B. The route should accept GET method instead of POST

C. The form data might not include 'email', causing KeyError

D. request.form cannot be accessed directly

Solution

1. Step 1: Understand why KeyError occurs

   Accessing request.form['email'] raises KeyError if 'email' is missing in the form data.

2. Step 2: Suggest safer access method

   Use request.form.get('email') to avoid KeyError and get None if missing.

3. Final Answer:

   The form data might not include 'email', causing KeyError -> Option C

4. Quick Check:

   Missing key in form causes KeyError [OK]

Hint: Use .get() to avoid KeyError on missing form keys [OK]

Common Mistakes:

• Assuming form always has the key
• Confusing form data with query parameters
• Thinking request.form is inaccessible

5. You want to check if a client sent a cookie named session_id in a Flask route. Which code snippet correctly checks for it and returns its value or 'No session' if missing? A)

sid = request.cookies['session_id']
return sid if sid else 'No session'

B)

sid = request.cookies.get('session_id')
return sid or 'No session'

C)

sid = request.form.get('session_id')
return sid or 'No session'

D)

sid = request.args.get('session_id')
return sid or 'No session'

hard

A. Access cookie directly with [] and check truthiness

B. Use .get() on cookies and return fallback if missing

C. Check form data for cookie value

D. Check query parameters for cookie value

Solution

1. Step 1: Identify how to safely access cookies

   Cookies are accessed via request.cookies. Using .get() avoids KeyError if cookie is missing.

2. Step 2: Return cookie value or fallback

   Using sid or 'No session' returns the cookie value if present, else the fallback string.

3. Final Answer:

   Use .get() on cookies and return fallback if missing -> Option B

4. Quick Check:

   Cookies use request.cookies.get() safely [OK]

Hint: Use request.cookies.get('name') to avoid errors [OK]

Common Mistakes:

• Accessing cookies with [] risking KeyError
• Looking for cookies in form or args
• Not providing fallback for missing cookie