Blueprint URL prefixes in Flask - Mini Project: Build & Apply

Blueprint URL prefixes in Flask

📖 Scenario: You are building a small web app with two sections: one for users and one for products. Each section should have its own URL prefix to keep things organized.

🎯 Goal: Create two Flask blueprints named users_bp and products_bp. Register them in the main app with URL prefixes /users and /products respectively. Each blueprint should have one route that returns a simple message.

📋 What You'll Learn

Create a Flask app instance named app

Create a blueprint named users_bp with a route /profile that returns 'User Profile'

Create a blueprint named products_bp with a route /list that returns 'Product List'

Register users_bp with the URL prefix /users

Register products_bp with the URL prefix /products

💡 Why This Matters

🌍 Real World

Blueprints help organize large Flask apps by grouping related routes under URL prefixes, making the app easier to maintain.

💼 Career

Understanding blueprints and URL prefixes is essential for backend web developers working with Flask to build scalable web applications.

1

Create Flask app and users blueprint

Create a Flask app instance called app. Then create a blueprint called users_bp with the name 'users' and import name __name__. Add a route /profile to users_bp that returns the string 'User Profile'.

Flask

from flask import Flask, Blueprint

# Create Flask app instance

# Create users_bp blueprint

# Add /profile route to users_bp
# Your code here

Hint

Use Flask(__name__) to create the app. Use Blueprint('users', __name__) to create the users blueprint. Define a function profile decorated with @users_bp.route('/profile') that returns 'User Profile'.

2

Create products blueprint with list route

Create a blueprint called products_bp with the name 'products' and import name __name__. Add a route /list to products_bp that returns the string 'Product List'.

Flask

from flask import Flask, Blueprint

app = Flask(__name__)

users_bp = Blueprint('users', __name__)

@users_bp.route('/profile')
def profile():
    return 'User Profile'

# Create products_bp blueprint

# Add /list route to products_bp
# Your code here

Hint

Create the products blueprint like the users one. Add a route /list that returns 'Product List'.

3

Register users blueprint with URL prefix

Register the users_bp blueprint with the Flask app app using the URL prefix /users.

Flask

from flask import Flask, Blueprint

app = Flask(__name__)

users_bp = Blueprint('users', __name__)

@users_bp.route('/profile')
def profile():
    return 'User Profile'

products_bp = Blueprint('products', __name__)

@products_bp.route('/list')
def product_list():
    return 'Product List'

# Register users_bp with URL prefix '/users'
# Your code here

Hint

Use app.register_blueprint(users_bp, url_prefix='/users') to register the users blueprint with the prefix.

4

Register products blueprint with URL prefix

Register the products_bp blueprint with the Flask app app using the URL prefix /products.

Flask

from flask import Flask, Blueprint

app = Flask(__name__)

users_bp = Blueprint('users', __name__)

@users_bp.route('/profile')
def profile():
    return 'User Profile'

products_bp = Blueprint('products', __name__)

@products_bp.route('/list')
def product_list():
    return 'Product List'

app.register_blueprint(users_bp, url_prefix='/users')

# Register products_bp with URL prefix '/products'
# Your code here

Hint

Use app.register_blueprint(products_bp, url_prefix='/products') to register the products blueprint with the prefix.

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