Modularizing Flask Applications with Blueprints | CodeSignal Learn

Modularizing Flask Applications with Blueprints | CodeSignal Learn

Modularizing Flask Applications with Blueprints

Welcome back! By this stage in your journey, you should have a basic understanding of Flask and how to render HTML templates with dynamic content. In the previous lesson, we discussed how to use Jinja2 templates to display personalized content. Today, we will focus on organizing your code for better maintainability. In this lesson, we'll discuss the Model-View-Controller (MVC) pattern and how the concept of Blueprints in Flask fits into it. By the end of this lesson, you will learn how to create and integrate Blueprints to maintain clean and modular code.

Understanding the MVC Pattern and Controllers

Before diving into Blueprints, let's quickly introduce the Model-View-Controller (MVC) pattern, which is a widely adopted design pattern in web development. This pattern helps separate concerns within your application, making it easier to manage and evolve. Model : Represents the data and business logic of the application. We will cover models in more detail in a future lesson. View : Represents the user interface and presentation layer. So far, you have seen views as templates rendered with Jinja2 in Flask. Controller : Acts as an intermediary between Model and View. It processes user input, interacts with the Model, and selects the View to display accordingly. In our Flask application, we will implement controllers to handle user requests, fetch data as needed, and render the appropriate templates. Blueprints in Flask will help us modularize these controllers for better organization and maintainability.

Discovering Flask Blueprints

Blueprints in Flask are a way to organize and structure your application. Think of a Blueprint as a container or module that groups related routes and functions. The term blueprint is used because it acts as a plan or template for different parts of your application, similar to how an architect's blueprint outlines the design of a building. Here's why Blueprints are beneficial, especially for beginners: Modularity : You can create separate controllers for different features or sections of your application, making it easier to manage. Each Blueprint can have its own routes, views, and templates. Clean Code : By separating different parts of your application into distinct modules, your code becomes easier to read and maintain. Reusability : Common code can be packaged into Blueprints and reused across different parts of your application. By using Blueprints, you'll be able to keep your application's code structured and easy to understand, making development and future updates smoother and more intuitive. Now, let's move on to creating a Blueprint for our Welcome controller.

Sign up

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Structuring Our Controller

To implement Blueprints, we'll need to organize our project structure. So far, the app directory with our project only includes a templates folder and the app.py file. Now, we'll add a controllers directory to organize our controllers. Here’s how our project structure should look like: app/ │ ├── controllers/ │ └── welcome_controller.py │ ├── templates/ │ └── welcome.html │ └── app.py By organizing your project this way, you separate different parts of your application, making it easier to manage and understand. Now, let's move on to creating a Blueprint for our Welcome controller.

Creating a Blueprint for the Welcome Controller

Let's start by creating a Blueprint for our welcome route. This code will be placed in a new file named welcome_controller.py inside the controllers directory. from flask import Blueprint, render_template # Define a new Blueprint named 'welcome' welcome_controller = Blueprint('welcome', __name__) # Define the route within the 'welcome' Blueprint @welcome_controller.route('/') def welcome(): name = "User" return render_template('welcome.html', name=name) In this snippet, we define a new Blueprint and assign it to the variable welcome_controller . The string'welcome' is the name of the Blueprint and is used internally by Flask to distinguish different Blueprints . It allows you to refer to this particular Blueprint when registering it with the main Flask app or when performing operations like URL generation that involve the Blueprint . It should be unique within your application to avoid naming conflicts. The variable welcome_controller is the Blueprint instance itself. By creating this instance, we group related routes and functions together to keep our code organized. Notice that the decorator @welcome_controller.route('/') is used instead of @app.route('/') . This change is important because we are now associating the route with the Blueprint instance referenced by the variable welcome_controller instead of the main Flask application instance. This helps us modularize our code, making it easier to manage and maintain.

Integrating the Blueprint with the Flask Application

Next, we need to register our Blueprint with the main Flask application. This will be done in the app.py file located in the root directory of our project. from flask import Flask from controllers.welcome_controller import welcome_controller app = Flask(__name__) # Registering the Blueprint app.register_blueprint(welcome_controller) if __name__ == '__main__': app.run(host='0.0.0.0', port=3000', debug=True) In this code, we import the welcome_controller Blueprint from the welcome_controller module and then register it using app.register_blueprint(welcome_controller) . By doing this, we integrate our Blueprint into the main application, ensuring that routes defined under @welcome_controller.route('/') are recognized and handled appropriately. This keeps our code modular and organized.

Python

from flask import Blueprint, render_template

# Define a new Blueprint named 'welcome'
welcome_controller = Blueprint('welcome', __name__)

# Define the route within the 'welcome' Blueprint
@welcome_controller.route('/')
def welcome():
    name = "User"
    return render_template('welcome.html', name=name)

Python

from flask import Flask
from controllers.welcome_controller import welcome_controller

app = Flask(__name__)

# Registering the Blueprint
app.register_blueprint(welcome_controller)

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=3000', debug=True)