Blueprint URL prefixes in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Blueprint in Flask?

A Blueprint in Flask is a way to organize a group of related routes and functions. It helps split a large app into smaller parts, like chapters in a book.

beginner

What does the URL prefix do when registering a Blueprint?

The URL prefix adds a starting path to all routes inside the Blueprint. For example, if the prefix is '/admin', all Blueprint routes start with '/admin'.

beginner

How do you register a Blueprint with a URL prefix in Flask?

Use app.register_blueprint(blueprint, url_prefix='/prefix'). This tells Flask to add '/prefix' before all Blueprint routes.

intermediate

Why use URL prefixes with Blueprints?

URL prefixes help group routes logically and avoid conflicts. For example, '/user' prefix for user pages and '/admin' for admin pages.

intermediate

What happens if you register two Blueprints with the same URL prefix?

Flask will combine their routes under the same prefix. If routes inside conflict, Flask raises an error. So, route paths inside Blueprints should be unique.

What is the purpose of the url_prefix parameter when registering a Blueprint?

A To add a common path before all Blueprint routes

B To change the Blueprint's name

C To disable the Blueprint routes

D To set the Blueprint's template folder

The url_prefix adds a common path before all routes in the Blueprint, grouping them under that prefix.

If a Blueprint has a route '/dashboard' and is registered with url_prefix='/admin', what is the full URL path?

A /dashboard

B /admin

C /dashboard/admin

D /admin/dashboard

The url_prefix '/admin' is added before the Blueprint route '/dashboard', making the full path '/admin/dashboard'.

Can you register multiple Blueprints with different url_prefix values in the same Flask app?

A No, only one Blueprint per app

B Yes, each can have its own url_prefix

C Yes, but all must share the same url_prefix

D No, url_prefix is not allowed

You can register many Blueprints, each with its own url_prefix to organize routes.

What happens if you register a Blueprint without specifying url_prefix?

A Blueprint routes are not accessible

B Flask throws an error

C Blueprint routes are registered at the root level

D Blueprint routes get a default prefix

Without url_prefix, Blueprint routes are registered directly at the root URL level.

Why is it important to avoid route name conflicts inside Blueprints sharing the same url_prefix?

A Because Flask merges routes and conflicts cause errors

B Because url_prefix changes route names automatically

C Because Blueprints cannot share url_prefix

D Because route names are ignored

If routes inside Blueprints with the same url_prefix have the same path, Flask raises an error due to conflicts.

Explain how URL prefixes work with Flask Blueprints and why they are useful.

Think about how you group pages under sections in a website.

Describe the steps to register a Blueprint with a URL prefix in a Flask app.

Focus on how you connect the Blueprint to the main app.

Practice

1. What is the main purpose of using a URL prefix in a Flask blueprint?

easy

A. To add a common path segment to all routes in the blueprint

B. To change the HTTP methods allowed for the routes

C. To register the blueprint with the Flask app

D. To define the template folder for the blueprint

Solution

1. Step 1: Understand what URL prefix means in Flask blueprints

   A URL prefix is a string added before all routes in a blueprint to group them under a common path.

2. Step 2: Identify the purpose of URL prefix

   This helps organize routes logically and keeps URLs clean by adding a shared path segment.

3. Final Answer:

   To add a common path segment to all routes in the blueprint -> Option A

4. Quick Check:

   URL prefix = common path for blueprint routes [OK]

Hint: URL prefix groups routes under one shared path [OK]

Common Mistakes:

• Confusing URL prefix with HTTP methods
• Thinking URL prefix registers the blueprint
• Mixing URL prefix with template folder settings

2. Which of the following is the correct way to set a URL prefix when creating a Flask blueprint?

easy

A. bp = Blueprint('bp', __name__, urlprefix='/admin')

B. bp = Blueprint('bp', __name__, prefix_url='/admin')

C. bp = Blueprint('bp', __name__, url_prefix='/admin')

D. bp = Blueprint('bp', __name__, route_prefix='/admin')

Solution

1. Step 1: Recall the correct parameter name for URL prefix

   The Flask Blueprint constructor uses the parameter named 'url_prefix' to set the prefix.

2. Step 2: Check each option for correct syntax

   Only bp = Blueprint('bp', __name__, url_prefix='/admin') uses 'url_prefix' exactly as Flask expects.

3. Final Answer:

   bp = Blueprint('bp', __name__, url_prefix='/admin') -> Option C

4. Quick Check:

   Correct parameter name is url_prefix [OK]

Hint: Use 'url_prefix' exactly when creating blueprint [OK]

Common Mistakes:

• Using incorrect parameter names like prefix_url
• Misspelling url_prefix as urlprefix
• Confusing route_prefix with url_prefix

3. Given this Flask blueprint code:

bp = Blueprint('bp', __name__, url_prefix='/shop')

@bp.route('/items')
def items():
    return 'Shop Items'

What URL path will show the text 'Shop Items' when this blueprint is registered?

medium

A. /shop/items

B. /bp/items

C. /items

D. /shop/bp/items

Solution

1. Step 1: Understand how url_prefix affects route paths

   The url_prefix '/shop' is added before all routes in the blueprint.

2. Step 2: Combine prefix with route path

   The route '/items' becomes '/shop/items' when accessed in the app.

3. Final Answer:

   /shop/items -> Option A

4. Quick Check:

   URL = url_prefix + route path = /shop/items [OK]

Hint: URL = url_prefix + route path [OK]

Common Mistakes:

• Ignoring the url_prefix and using only route path
• Assuming blueprint name appears in URL
• Adding extra segments not defined

4. What is wrong with this Flask blueprint code?

bp = Blueprint('bp', __name__, url_prefix='/api')

@bp.route('data')
def data():
    return 'API Data'

medium

A. The function 'data' must accept a parameter

B. The url_prefix should be set when registering the blueprint, not here

C. The blueprint name 'bp' is invalid

D. The route path is missing a leading slash '/'

Solution

1. Step 1: Check the route decorator syntax

   Flask route paths must start with a leading slash '/' to be valid.

2. Step 2: Identify the missing slash in '@bp.route('data')'

   The route should be '@bp.route('/data')' to work correctly.

3. Final Answer:

   The route path is missing a leading slash '/' -> Option D

4. Quick Check:

   Route paths need leading '/' [OK]

Hint: Always start route paths with '/' [OK]

Common Mistakes:

• Omitting leading slash in route paths
• Thinking url_prefix is set only on registration
• Believing blueprint names have strict rules
• Assuming route functions need parameters without reason

5. You have two blueprints:

bp1 = Blueprint('bp1', __name__, url_prefix='/user')
@bp1.route('/profile')
def profile():
    return 'User Profile'

bp2 = Blueprint('bp2', __name__, url_prefix='/user')
@bp2.route('/settings')
def settings():
    return 'User Settings'

If both are registered in the app, what happens when you visit /user/settings?

hard

A. A routing conflict error occurs because both blueprints share the same prefix

B. The 'User Settings' page is shown correctly

C. The 'User Profile' page is shown instead

D. A 404 Not Found error occurs

Solution

1. Step 1: Understand blueprint URL prefixes and route paths

   Both blueprints share the same prefix '/user', but their routes differ: '/profile' and '/settings'.

2. Step 2: Check if routes overlap

   Since '/user/settings' matches only bp2's route, no conflict occurs.

3. Final Answer:

   The 'User Settings' page is shown correctly -> Option B

4. Quick Check:

   Same prefix allowed if routes differ [OK]

Hint: Same prefix okay if route paths differ [OK]

Common Mistakes:

• Assuming same prefix always causes conflict
• Confusing blueprint name with URL path
• Expecting 404 when route exists