Flask blueprint

Q: How deeply does The Well-Grounded Python Developer: How the pros use Python and Flask cover Flask blueprint?

Works through package creation, blueprint configuration, route decoration, and factory registration; does not explore Flask's registration internals.

As explained in The Well-Grounded Python Developer: How the pros use Python and Flask

A Flask Blueprint is a modular component that groups related routes, view functions, templates, static resources, and other application elements for registration with a Flask application.

As a Flask application grows, keeping every route beside the application setup becomes unwieldy. A blueprint groups routes for a distinct area of functionality in its own Python package. This gives related URL endpoints a namespace and lets you work on one feature without crowding a single file. section 7.4 section 7.4.1

To move introductory pages into a blueprint:

Create an `intro` package. In its `__init__.py`, instantiate `Blueprint` with a name and module location; set paths for its templates and static files. section 7.4.2
In a separate module, import the blueprint and decorate handlers with `@intro_bp.route(...)` instead of `@app.route(...)`. section 7.4.2
Import the package and call `app.register_blueprint(intro.intro_bp)` in the `create_app()` application factory. section 7.4.2

from flask import Blueprint                  #1
 
intro_bp = Blueprint('intro_bp', __name__,   #2
    static_folder="static",                  #2
    static_url_path="/intro/static",         #2
    template_folder="templates"              #2
)                                            #2
 
from app.intro import intro                  #3

The blueprint definition places template and static folders beside the feature package. Its explicit static URL path avoids a conflict with the application's root static folder. section 7.4.2

Grow the feature, not the application file

The same `intro_bp` handles `/` and, after another decorated handler is added, `/about`. The about handler renders `about.html` from the blueprint's templates directory. A separate authentication package can follow the same pattern for `/login`, with both blueprints registered by the application factory. section 7.4.2 section 7.4.3 section 8.2.1

Use a blueprint when routes belong to a coherent feature, such as introductory pages or authentication. Keeping that feature together makes the application easier to extend and can make the functionality reusable in another project. section 7.4 section 7.4.1

How The Well-Grounded Python Developer: How the pros use Python and Flask covers it

Cover of The Well-Grounded Python Developer: How the pros use Python and Flask

liveBook manning.com

Read The Well-Grounded Python Developer: How the pros use Python and Flask on liveBook Get the book at manning.com

Related concepts

namespaceimplements · A namespace is a naming context or identifier space in which names are defined and resolved, distinguishing them from names in other contexts.
url_forused by · url_for is a Flask function that constructs a URL from an endpoint and optional parameter values or file paths.
routingconfigures · Routing is the selection of a path, destination, or processing component to direct an item, request, or flow toward an intended endpoint.
moduleimplements · A module is a distinct, bounded software unit that groups related code or functionality and provides an organizational or interaction boundary within a larger system.

This explainer was generated by Manning's knowledge graph from the text of The Well-Grounded Python Developer: How the pros use Python and Flask. The section links point to the parts of the book it draws on.