Blueprint creation and registration in Flask

Introduction

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

You want to split your app into parts like user pages and admin pages.

You want to reuse code across different apps.

You want to keep your main app file clean and simple.

You want to register routes only when needed.

You want to organize your app by features or sections.

Syntax

Flask

from flask import Blueprint

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

@bp.route('/path')
def view_func():
    return 'Hello from blueprint!'

# In main app file
from flask import Flask
app = Flask(__name__)
app.register_blueprint(bp)

The first argument to Blueprint is the blueprint's name.

url_prefix adds a prefix to all routes in the blueprint.

Examples

This blueprint handles user-related routes under '/users'.

Flask

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

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

This blueprint handles admin routes with a '/admin' prefix.

Flask

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

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

This registers the blueprint with the main Flask app.

Flask

app = Flask(__name__)
app.register_blueprint(bp)

Sample Program

This example creates a blog blueprint with two routes. It registers the blueprint to the main app. When you visit '/blog/' you see the blog home. When you visit '/blog/post/1' you see post 1.

Flask

from flask import Flask, Blueprint

# Create a blueprint for blog
blog_bp = Blueprint('blog', __name__, url_prefix='/blog')

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

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

# Create main app
app = Flask(__name__)

# Register the blueprint
app.register_blueprint(blog_bp)

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

Important Notes

Blueprints let you organize routes and code separately from the main app.

Always register blueprints before running the app.

You can create many blueprints for different parts of your app.

Summary

Blueprints group routes and code for better organization.

Use Blueprint to create, then app.register_blueprint() to add it.

Blueprints help keep your Flask app clean and modular.

Practice

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

easy

A. To handle user authentication

B. To create database models automatically

C. To organize routes and related code into reusable modules

D. To serve static files directly

Solution

1. Step 1: Understand Blueprint role

   A Blueprint groups routes and code to keep the app organized and modular.

2. Step 2: Compare options

   Only To organize routes and related code into reusable modules describes organizing routes and code. Others describe unrelated tasks.

3. Final Answer:

   To organize routes and related code into reusable modules -> Option C

4. Quick Check:

   Blueprint purpose = organize routes [OK]

Hint: Blueprints group routes for modular apps [OK]

Common Mistakes:

• Thinking Blueprint creates database models
• Confusing Blueprint with authentication
• Assuming Blueprint serves static files

2. Which of the following is the correct way to create a Blueprint named 'blog' in Flask?

easy

A. blog = Blueprint('blog', app)

B. blog = Blueprint('blog')

C. blog = Blueprint(__name__, 'blog')

D. blog = Blueprint('blog', __name__)

Solution

1. Step 1: Recall Blueprint constructor

   The Blueprint constructor requires the name and import name (usually __name__).

2. Step 2: Check options

   blog = Blueprint('blog', __name__) uses correct order: name 'blog' and __name__. Others miss or swap arguments.

3. Final Answer:

   blog = Blueprint('blog', __name__) -> Option D

4. Quick Check:

   Blueprint(name, __name__) = correct [OK]

Hint: Blueprint needs name and __name__ args [OK]

Common Mistakes:

• Omitting __name__ argument
• Swapping argument order
• Passing app instead of __name__

3. Given this code snippet, what will be the output when accessing the '/hello' route?

from flask import Flask, Blueprint
app = Flask(__name__)
hello_bp = Blueprint('hello', __name__)

@hello_bp.route('/hello')
def hello():
    return 'Hello from Blueprint!'

app.register_blueprint(hello_bp)

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

medium

A. 404 Not Found error

B. Hello from Blueprint!

C. 500 Internal Server Error

D. Empty response

Solution

1. Step 1: Check route registration

   The route '/hello' is defined in the Blueprint and the Blueprint is registered on the app.

2. Step 2: Understand response

   Accessing '/hello' calls the hello() function returning 'Hello from Blueprint!'.

3. Final Answer:

   Hello from Blueprint! -> Option B

4. Quick Check:

   Registered route returns defined string [OK]

Hint: Registered Blueprint routes respond normally [OK]

Common Mistakes:

• Forgetting to register the Blueprint
• Using wrong route path
• Expecting error without registration

4. Identify the error in this Flask Blueprint setup:

from flask import Flask, Blueprint
app = Flask(__name__)
admin_bp = Blueprint('admin', __name__)

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

# Missing line here

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

medium

A. Blueprint is not registered with the app

B. Route decorator syntax is wrong

C. Blueprint is not created correctly

D. Function dashboard() is missing return statement

Solution

1. Step 1: Check Blueprint creation and route

   Blueprint and route are correctly defined with proper syntax and return statement.

2. Step 2: Look for registration

   The Blueprint is not registered with the Flask app using app.register_blueprint(admin_bp).

3. Final Answer:

   Blueprint is not registered with the app -> Option A

4. Quick Check:

   Missing app.register_blueprint() causes route not found [OK]

Hint: Always register Blueprint with app [OK]

Common Mistakes:

• Forgetting app.register_blueprint()
• Misplacing route decorator
• Missing return in route function

5. You want to create two Blueprints, user_bp and admin_bp, each with a route '/profile'. How do you register them so that user_bp routes are under '/user' and admin_bp routes under '/admin' in the main app?

hard

A. app.register_blueprint(user_bp, url_prefix='/user')\napp.register_blueprint(admin_bp, url_prefix='/admin')

B. app.register_blueprint(user_bp)\napp.register_blueprint(admin_bp)

C. app.register_blueprint(user_bp, url_prefix='/admin')\napp.register_blueprint(admin_bp, url_prefix='/user')

D. user_bp.route('/user/profile')\nadmin_bp.route('/admin/profile')

Solution

1. Step 1: Understand url_prefix usage

   To group routes under a path prefix, use url_prefix when registering Blueprints.

2. Step 2: Apply prefixes correctly

   Register user_bp with url_prefix='/user' and admin_bp with url_prefix='/admin'.

3. Final Answer:

   app.register_blueprint(user_bp, url_prefix='/user')\napp.register_blueprint(admin_bp, url_prefix='/admin') -> Option A

4. Quick Check:

   url_prefix sets route base path [OK]

Hint: Use url_prefix to separate Blueprint routes [OK]

Common Mistakes:

• Not using url_prefix causing route conflicts
• Swapping prefixes between Blueprints
• Trying to set route paths inside Blueprint incorrectly