API Reference

class flask_blueprints_loader.blueprints_loader.BlueprintsLoader(app=None)

Automatically discover and register Flask blueprints.

The BlueprintsLoader class provides functionality for dynamically loading and registering Flask blueprints.

Parameters:

app (Flask | None) – The Flask application instance. (optional)

path_name

The name of the directory containing the blueprints.

module_name

The name of the module containing the blueprints.

unloads

A list of blueprint names to exclude from loading.

blueprints_path

The full path to the directory containing the blueprints.

init_app(app)

Initializes the Flask application with the BlueprintsLoader instance.

Parameters:

app (Flask) – The Flask application instance.

Return type:

None

load_blueprint(path)

Loads a Flask blueprint from the specified path.

The load_blueprint method is used to load a Flask blueprint from the given path. It iterates over the attributes of the views module and returns the first attribute that is an instance of Blueprint and is not in the unloads list.

Parameters:

path (Path) – The path to the blueprint module file.

Returns:

The loaded blueprint if found, or None if no suitable blueprint is found.

Return type:

Blueprint | None

load_blueprints()

Loads and registers Flask blueprints.

The load_blueprints method is used to load and register Flask blueprints. It iterates over the blueprint paths in the blueprints_path directory that match the specified module name. If a blueprint is successfully loaded, it is registered with the current Flask application using current_app.register_blueprint.

Return type:

None

static load_module(path)

Loads a Python module from the specified path.

The load_module static method is used to load a Python module from the given path. It takes a path parameter of type Path representing the path to the module file. The method attempts to import the module using importlib.util.spec_from_file_location and importlib.util.module_from_spec. If the module is successfully imported, it is executed using spec.loader.exec_module and returned.

Parameters:

path (Path) – The path to the module file.

Returns:

The loaded module if successful, or None if an error occurs during import.

Return type:

ModuleType | None