Blueprint URL prefixes in Flask

Introduction

Blueprint URL prefixes help organize your web app by grouping routes under a common starting path. This keeps URLs tidy and your code easier to manage.

You want to group related pages, like all user pages under '/users'.

You are building a big app and want to split routes into smaller parts.

You want to avoid repeating the same URL part for many routes.

You want to create reusable route groups that can be added with different prefixes.

Syntax

Flask

blueprint = Blueprint('name', __name__, url_prefix='/prefix')

The url_prefix adds a common start to all routes in this blueprint.

Routes inside the blueprint do not need to repeat the prefix.

Examples

This blueprint groups routes under '/users'. The route '/' inside becomes '/users/'.

Flask

from flask import Blueprint

users_bp = Blueprint('users', __name__, url_prefix='/users')

@users_bp.route('/')
def users_home():
    return 'Users Home'

The route '/dashboard' inside the admin blueprint is accessed at '/admin/dashboard'.

Flask

from flask import Blueprint

admin_bp = Blueprint('admin', __name__, url_prefix='/admin')

@admin_bp.route('/dashboard')
def dashboard():
    return 'Admin Dashboard'

Sample Program

This Flask app uses a blueprint with the prefix '/blog'. The route '/' inside the blueprint is accessed at '/blog/'. The route '/post/<id>' is accessed at '/blog/post/<id>'.

Flask

from flask import Flask, Blueprint

app = Flask(__name__)

# Create a blueprint with URL prefix '/blog'
blog_bp = Blueprint('blog', __name__, url_prefix='/blog')

@blog_bp.route('/')
def blog_home():
    return 'Welcome to the Blog Home'

@blog_bp.route('/post/<int:id>')
def show_post(id):
    return f'Post number {id}'

# Register blueprint with the app
app.register_blueprint(blog_bp)

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

URL prefixes help keep your app routes organized and avoid conflicts.

You can register the same blueprint multiple times with different prefixes if needed.

Summary

Blueprint URL prefixes add a common path to all routes in a blueprint.

This makes your URLs cleaner and your code easier to maintain.

Use them to group related routes logically under one URL section.

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