Flask-Blueprints-Loader’s documentation¶

Flask-Blueprints-Loader is an extension for Flask that automatically discovers and registers Blueprint for your application.

Features¶

Automatic loading and registration of Flask blueprints.
Easy configuration via Flask app configuration variables.

Why Use Flask-Blueprints-Loader?¶

Flask-Blueprints-Loader is particularly useful for Large Applications as Packages that heavily rely on blueprints. Instead of manually registering each blueprint, this extension allows you to automate the process by automatically discovering and registering all blueprints for your application.

Installation¶

Flask-Blueprints-Loader is available on PyPI and can be installed with various Python Application dependency management tools. Install using pip:

$ pip install flask-blueprints-loader

Initialize the Extension¶

Application Instance Pattern

from flask import Flask
from flask_blueprints_loader import BlueprintsLoader

app = Flask(__name__)
loader = BlueprintsLoader(app)

with app.app_context():
   loader.register_blueprints()

Application Factories Pattern

from flask import Flask
from flask_blueprints_loader import BlueprintsLoader

loader = BlueprintsLoader()

def create_app():
   app = Flask(__name__)
   loader.init_app(app)

   with app.app_context():
      loader.register_blueprints()

   return app

Directory Structure¶

Flask-Blueprints-Loader expects your blueprints to be organized in a specific directory structure. By default, it looks for blueprints under the current_app.root_path directory, with each blueprint in its own package containing a views.py module that defines the Blueprint instance and route definitions.

Here is a structured Flask application with two blueprints, auth and blog

myapp/
├── __init__.py
├── auth/
│ ├── __init__.py
│ └── views.py
├── blog/
│ ├── __init__.py
│ └── views.py
├── templates/
│ ├── auth/
│ │ ├── login.html
│ │ └── register.html
│ └── blog/
│ ├── index.html
│ └── post.html
├── config.py
└── wsgi.py

Configuration¶

BLUEPRINTS_LOADER_PATH_NAME: str = ""¶: The name of the subdirectory containing the blueprints. By default blueprints are under the current_app.root_path.

BLUEPRINTS_LOADER_MODULE_NAME: str = views¶: The name of the module containing the blueprints. By default, it is set to “views”.

BLUEPRINTS_LOADER_UNLOADS: list = []¶: A list of blueprint names to exclude from loading. By default, it is an empty list.

Constraints and Drawbacks¶

Flask-Blueprints-Loader has the following constraints and drawbacks:

Blueprints are expected to be organized in a specific way, with a views.py module containing the Blueprint instance in each blueprint package.
If your blueprints are not organized in this way, you may need to make changes to your code to use Flask-Blueprints-Loader.