Blueprint creation and registration 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, making the app easier to manage.

beginner

How do you create a Blueprint in Flask?

You create a Blueprint by importing Blueprint from flask and then making an instance with a name and import name, like: <br><code>from flask import Blueprint<br>bp = Blueprint('bp_name', __name__)</code>

beginner

How do you register a Blueprint to a Flask app?

You register a Blueprint by calling app.register_blueprint() and passing the Blueprint instance. This connects the Blueprint routes to the main app.

intermediate

Why use Blueprints in a Flask app?

Blueprints help keep code organized, allow reuse of code parts, and make it easier to work in teams by separating features into modules.

beginner

What happens if you forget to register a Blueprint in Flask?

If you forget to register a Blueprint, its routes won’t be available in the app. It’s like writing a chapter but never adding it to the book — users can’t see it.

What is the first step to use a Blueprint in Flask?

A Import Flask

B Create a Blueprint instance

C Run the Flask app

D Register the Blueprint

You first create a Blueprint instance before you can register it or use it.

Which method connects a Blueprint to the main Flask app?

A Blueprint.connect()

B app.create_blueprint()

C app.register_blueprint()

D app.add_blueprint()

The correct method is app.register_blueprint() to add the Blueprint routes to the app.

What argument is required when creating a Blueprint?

A The Blueprint name and import name

B The app instance

C The route URL

D The template folder

You must provide a name and the import name (usually __name__) when creating a Blueprint.

What is a benefit of using Blueprints in Flask?

A They handle database connections

B They speed up the app automatically

C They replace Flask routes

D They organize code into modules

Blueprints help organize code into smaller, manageable modules.

If a Blueprint is not registered, what happens?

A Blueprint routes are not available

B Blueprint runs separately

C The app crashes

D Blueprint registers automatically

Without registration, the Blueprint routes won’t be part of the app.

Explain how to create and register a Blueprint in Flask step-by-step.

Think about setting up a mini app and then connecting it to the main app.

Describe why using Blueprints can help when building larger Flask applications.

Imagine building a big house by working on rooms separately.

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