Accessing query parameters in Flask - Step-by-Step Execution

Concept Flow - Accessing query parameters

Client sends HTTP GET request with URL including ?key=value

↓

Flask receives request

↓

Flask reads query parameters from request.args

↓

Access specific parameter by key

↓

Use parameter value in response

↓

Send response back to client

This flow shows how Flask gets query parameters from the URL and uses them in the response.

Execution Sample

Flask

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

@app.route('/search')
def search():
    term = request.args.get('term', '')
    return f'Search term: {term}'

This Flask route reads the 'term' query parameter from the URL and returns it in the response.

Execution Table

Step	Action	Request URL	Query Parameters	Parameter Access	Response
1	Client sends GET request	/search?term=flask	term: flask	N/A	N/A
2	Flask receives request	/search?term=flask	term: flask	N/A	N/A
3	Read query parameters	/search?term=flask	term: flask	term = 'flask'	N/A
4	Return response	/search?term=flask	term: flask	term = 'flask'	Search term: flask
5	Client receives response	/search?term=flask	term: flask	term = 'flask'	Search term: flask
6	Client sends GET request without term	/search		N/A	N/A
7	Flask receives request	/search		N/A	N/A
8	Read query parameters	/search		term = '' (default)	N/A
9	Return response	/search		term = ''	Search term:
10	Client receives response	/search		term = ''	Search term:

💡 Execution stops after response is sent back to client.

Variable Tracker

Variable	Start	After Step 3	After Step 8	Final
term	N/A	'flask'	'' (empty string)	Depends on request

Key Moments - 2 Insights

What happens if the query parameter 'term' is missing in the URL?

The code uses request.args.get('term', '') which returns an empty string as default, as shown in execution_table rows 8 and 9.

How does Flask access query parameters from the URL?

Flask uses request.args which is a dictionary-like object containing all query parameters, as seen in execution_table row 3.

Visual Quiz - 3 Questions

Look at the execution table, what is the value of 'term' at step 3?

A 'flask'

B '' (empty string)

C None

D 'search'

💡 Hint

Check the 'Parameter Access' column at step 3 in the execution_table.

At which step does the code use the default value for 'term'?

A Step 3

B Step 4

C Step 8

D Step 1

💡 Hint

Look at the 'Parameter Access' column where 'term' is set to empty string.

If the URL was '/search?term=python', what would be the response?

A Search term: flask

B Search term: python

C Search term:

D Error

💡 Hint

Refer to how 'term' is used in the response in execution_table rows 4 and 5.

Concept Snapshot

Flask reads query parameters from request.args.
Use request.args.get('key', default) to safely access parameters.
If parameter missing, default value is used.
Example: term = request.args.get('term', '')
Returns string or default if not present.
Use in route functions to customize response.

Full Transcript

In Flask, query parameters come after the ? in a URL. When a client sends a GET request like /search?term=flask, Flask receives it and reads the parameters from request.args. This is like a dictionary where keys are parameter names. Using request.args.get('term', '') gets the value for 'term' or returns an empty string if missing. The route function then uses this value to build the response. If the URL has no term parameter, the default empty string is used. This way, your app can handle URLs with or without query parameters safely.

Practice

1. In Flask, which method is used to safely access a query parameter named user from the URL?

easy

A. request.form['user']

B. request.args.get('user')

C. request.query['user']

D. request.params.get('user')

Solution

1. Step 1: Understand Flask request object

   Flask's request object holds incoming request data, including query parameters in args.

2. Step 2: Use the correct method to access query parameters

   request.args.get('user') safely retrieves the value of the user parameter or returns None if missing.

3. Final Answer:

   request.args.get('user') -> Option B

4. Quick Check:

   Use args.get() for query parameters [OK]

Hint: Use request.args.get('param') to read query parameters [OK]

Common Mistakes:

• Using request.form for query parameters
• Trying to access request.query which doesn't exist
• Using request.params instead of request.args

2. Which of the following is the correct syntax to get a query parameter page with a default value of 1 in Flask?

easy

A. request.args.get('page', default=1)

B. request.args.get('page', 1)

C. request.args['page'] or 1

D. request.args.get('page', fallback=1)

Solution

1. Step 1: Check the get() method parameters

   The get() method accepts a default keyword argument to provide a fallback value if the parameter is missing.

2. Step 2: Identify correct syntax for default

   Using request.args.get('page', default=1) correctly sets 1 as default. Passing 1 as second positional argument is invalid.

3. Final Answer:

   request.args.get('page', default=1) -> Option A

4. Quick Check:

   Use default= for fallback in get() [OK]

Hint: Use default= in get() to set fallback value [OK]

Common Mistakes:

• Passing default value as second positional argument
• Using fallback= which is not valid in Flask
• Accessing with [] which raises error if missing

3. What will be the output of this Flask route when accessed with URL /search?term=flask?

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

@app.route('/search')
def search():
    term = request.args.get('term', 'none')
    return f"Search term: {term}"

medium

A. Error: term parameter missing

B. Search term: none

C. Search term:

D. Search term: flask

Solution

1. Step 1: Understand the URL query parameter

   The URL contains ?term=flask, so the query parameter term has value 'flask'.

2. Step 2: Check how term is retrieved in code

   request.args.get('term', 'none') returns 'flask' because the parameter exists.

3. Final Answer:

   Search term: flask -> Option D

4. Quick Check:

   Parameter present returns its value, not default [OK]

Hint: If parameter exists, get() returns its value, else default [OK]

Common Mistakes:

• Assuming default is returned even if parameter exists
• Confusing query parameters with form data
• Expecting empty string instead of actual value

4. Identify the error in this Flask code snippet that tries to get a query parameter id:

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

@app.route('/item')
def item():
    id = request.args['id']
    return f"Item ID: {id}"

medium

A. Using request.args['id'] raises KeyError if 'id' missing

B. Missing import of request module

C. Route decorator syntax is incorrect

D. Using f-string inside return is invalid

Solution

1. Step 1: Analyze how query parameter is accessed

   Using request.args['id'] accesses the parameter directly and raises KeyError if missing.

2. Step 2: Identify safer alternative

   Using request.args.get('id') avoids error by returning None if missing.

3. Final Answer:

   Using request.args['id'] raises KeyError if 'id' missing -> Option A

4. Quick Check:

   Direct dict access can cause KeyError [OK]

Hint: Use get() to avoid KeyError when parameter might be missing [OK]

Common Mistakes:

• Assuming request.args['id'] never fails
• Ignoring possibility of missing parameters
• Confusing import errors with runtime errors

5. You want to create a Flask route /filter that reads two optional query parameters: category (default 'all') and limit (default 10, integer). Which code correctly handles both parameters safely?

hard

A. category = request.args.get('category') or 'all'
limit = int(request.args.get('limit', 10))

B. category = request.args['category'] or 'all'
limit = int(request.args['limit'] or 10)

C. category = request.args.get('category', default='all')
limit = int(request.args.get('limit', default=10))

D. category = request.args.get('category', 'all')
limit = int(request.args.get('limit', '10'))

Solution

1. Step 1: Handle category parameter with default

   Using request.args.get('category', default='all') safely returns 'all' if missing.

2. Step 2: Handle limit parameter with default and convert to int

   request.args.get('limit', default=10) returns string or int 10; wrapping with int() converts string to integer safely.

3. Step 3: Check other options for errors

   category = request.args['category'] or 'all' limit = int(request.args['limit'] or 10) risks KeyError; category = request.args.get('category') or 'all' limit = int(request.args.get('limit', 10)) uses positional default incorrectly; category = request.args.get('category', 'all') limit = int(request.args.get('limit', '10')) converts default string '10' which works but less clear than int 10.

4. Final Answer:

   category = request.args.get('category', default='all')\nlimit = int(request.args.get('limit', default=10)) -> Option C

5. Quick Check:

   Use get() with default and convert types explicitly [OK]

Hint: Use get() with default and convert types explicitly [OK]

Common Mistakes:

• Using [] which raises error if missing
• Passing default as positional argument incorrectly
• Not converting string query param to int