Blueprint routes and templates in Flask

Introduction

Blueprints help organize your Flask app by grouping routes and templates. They make your code cleaner and easier to manage.

You want to split a big app into smaller parts like user, admin, and blog sections.

You want to reuse routes and templates in different projects.

You want to keep your code organized when working with a team.

You want to load templates specific to a part of your app.

You want to avoid cluttering the main app file with many routes.

Syntax

Flask

from flask import Blueprint, render_template

bp = Blueprint('bp_name', __name__, template_folder='templates')

@bp.route('/path')
def view_func():
    return render_template('template.html')

The first argument is the blueprint's name, used internally.

template_folder tells Flask where to find templates for this blueprint.

Examples

This blueprint handles user-related routes and templates.

Flask

from flask import Blueprint, render_template

user_bp = Blueprint('user', __name__, template_folder='user_templates')

@user_bp.route('/profile')
def profile():
    return render_template('profile.html')

This blueprint is for admin routes and templates.

Flask

from flask import Blueprint, render_template

admin_bp = Blueprint('admin', __name__, template_folder='admin_templates')

@admin_bp.route('/dashboard')
def dashboard():
    return render_template('dashboard.html')

Sample Program

This example creates a blueprint named 'simple' with one route '/hello'. The blueprint is registered with the app under the URL prefix '/bp'. When you visit '/bp/hello', it shows a message from the blueprint.

Flask

from flask import Flask, Blueprint, render_template_string

app = Flask(__name__)

# Create a blueprint
bp = Blueprint('simple', __name__, template_folder='templates')

# Define a route in the blueprint
@bp.route('/hello')
def hello():
    # Use a simple template string for demo
    return render_template_string('<h1>Hello from Blueprint!</h1>')

# Register the blueprint with the app
app.register_blueprint(bp, url_prefix='/bp')

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

Important Notes

Always register your blueprint with the main app using app.register_blueprint().

Use url_prefix to add a common path before all blueprint routes.

Blueprint templates can be stored in a separate folder to keep things tidy.

Summary

Blueprints group routes and templates to organize your Flask app.

Register blueprints with the main app to activate their routes.

Use url_prefix to avoid route conflicts and keep URLs clear.

Practice

1. What is the main purpose of using a Blueprint in a Flask application?

easy

A. To handle user authentication automatically

B. To organize routes and templates into reusable components

C. To create a new Flask app instance

D. To connect Flask with a database

Solution

1. Step 1: Understand Blueprint role

   A Blueprint groups related routes and templates to keep code organized.

2. Step 2: Compare other options

   Connecting to databases, creating app instances, or handling authentication are separate tasks.

3. Final Answer:

   To organize routes and templates into reusable components -> Option B

4. Quick Check:

   Blueprint = organize routes/templates [OK]

Hint: Blueprints group routes/templates for better app structure [OK]

Common Mistakes:

• Thinking Blueprint creates the app instance
• Confusing Blueprint with database connection
• Assuming Blueprint handles authentication automatically

2. Which of the following is the correct way to register a Blueprint named blog with a Flask app app using the URL prefix /blog?

easy

A. app.register_blueprint(blog, url_prefix='/blog')

B. app.register_blueprint('/blog', blog)

C. app.register_blueprint(blog.prefix('/blog'))

D. app.register_blueprint(blog, prefix_url='/blog')

Solution

1. Step 1: Recall correct method signature

   The method is register_blueprint(blueprint, url_prefix='...').

2. Step 2: Check options for correct syntax

   Only app.register_blueprint(blog, url_prefix='/blog') uses the correct method and parameter names.

3. Final Answer:

   app.register_blueprint(blog, url_prefix='/blog') -> Option A

4. Quick Check:

   register_blueprint with url_prefix = app.register_blueprint(blog, url_prefix='/blog') [OK]

Hint: Use url_prefix parameter to set Blueprint URL base [OK]

Common Mistakes:

• Swapping parameter order
• Using wrong parameter name like prefix_url
• Calling prefix as a method on Blueprint

3. Given this Blueprint code:

from flask import Blueprint, render_template
blog = Blueprint('blog', __name__, template_folder='templates')

@blog.route('/post')
def show_post():
    return render_template('post.html')

And this main app code:

from flask import Flask
app = Flask(__name__)
app.register_blueprint(blog, url_prefix='/blog')

What URL should you visit to see the post.html template rendered?

medium

A. /blog

B. /post

C. /blog/post

D. /post/blog

Solution

1. Step 1: Understand route and url_prefix

   The Blueprint route is '/post', and the Blueprint is registered with prefix '/blog'.

2. Step 2: Combine prefix and route

   The full URL becomes '/blog/post' to access the route.

3. Final Answer:

   /blog/post -> Option C

4. Quick Check:

   url_prefix + route = /blog/post [OK]

Hint: Combine url_prefix and route for full URL [OK]

Common Mistakes:

• Ignoring url_prefix and using only route
• Swapping url_prefix and route order
• Assuming url_prefix is not added to route

4. What is wrong with this Blueprint registration code?

from flask import Flask
app = Flask(__name__)
app.register_blueprint(blog, prefix='/blog')

medium

A. You cannot register blueprints in Flask

B. Blueprint must be registered before app creation

C. Blueprint name must be 'app' to register

D. The parameter should be url_prefix, not prefix

Solution

1. Step 1: Check parameter name in register_blueprint

   The correct parameter to set URL prefix is url_prefix, not prefix.

2. Step 2: Validate other options

   Blueprints register after app creation; name can be anything; Flask supports blueprints.

3. Final Answer:

   The parameter should be url_prefix, not prefix -> Option D

4. Quick Check:

   Correct param is url_prefix [OK]

Hint: Use url_prefix, not prefix, when registering Blueprint [OK]

Common Mistakes:

• Using prefix instead of url_prefix
• Trying to register Blueprint before app exists
• Thinking Blueprint name must be 'app'

5. You have two Blueprints, admin and user, both with a route /dashboard. How can you register them in your Flask app to avoid URL conflicts and keep URLs clear?

hard

A. Register each Blueprint with a different url_prefix, like /admin and /user

B. Rename one Blueprint's route to /dashboard2

C. Register both Blueprints without any url_prefix

D. Use the same url_prefix for both Blueprints

Solution

1. Step 1: Understand URL conflicts

   Both Blueprints have the same route /dashboard, which causes conflicts if no prefix is used.

2. Step 2: Use url_prefix to separate routes

   Assigning different url_prefix values like /admin and /user keeps URLs unique and organized.

3. Final Answer:

   Register each Blueprint with a different url_prefix, like /admin and /user -> Option A

4. Quick Check:

   Different url_prefix avoids route conflicts [OK]

Hint: Use unique url_prefix for each Blueprint to avoid conflicts [OK]

Common Mistakes:

• Not using url_prefix and causing route clashes
• Renaming routes manually instead of using prefixes
• Using same url_prefix for multiple Blueprints