Flask Blueprint ブループリントオブジェクト API
Blueprint は、アプリケーションを再利用可能なモジュールに分割するために使用されます。各ブループリントは独自のルート、テンプレート、静的ファイル、フックを持つことができます。
作成方法:
bp = Blueprint("auth", __name__)
コンストラクタの引数
| パラメータ | 型 | デフォルト値 | 説明 |
|---|---|---|---|
| name | str | 必須 | ブループリント名。url_for の endpoint プレフィックスに使用されます。 |
| import_name | str | 必須 | ブループリントが属するモジュール名。リソースを特定するために使用されます。通常は __name__ を渡します。 |
| static_folder | str | None | ブループリントの静的ファイルフォルダー |
| static_url_path | str | None | 静的ファイルが外部に公開される URL パス |
| template_folder | str | None | ブループリントのテンプレートフォルダー |
| url_prefix | str | None | ブループリントのすべてのルートに共通のプレフィックス。例: "/auth" |
| subdomain | str | None | ブループリントのルートが一致するサブドメイン |
| url_defaults | dict | None | ブループリントのルートのデフォルト URL パラメータ |
| root_path | str | None | ブループリントのルートパス。通常は自動検出されます。 |
| cli_group | str | None | CLI コマンドグループ名。デフォルトではブループリント名が使用されます。 |
コア属性
| 属性 | 型 | 説明 |
|---|---|---|
| name | str | ブループリント名。登録後は endpoint プレフィックスに使用されます。 |
| cli | AppGroup | ブループリント専用の CLI コマンドグループ。カスタムコマンドを追加できます。 |
| has_static_folder | bool | 静的フォルダーが設定されているかどうか |
ルーティングメソッド
ブループリントの使い方は Flask アプリケーションと同じです。ただ、appに置き換えます。bp:
| メソッド | 説明 |
|---|---|
| route(rule, **options) | URL をビュー関数にバインドするデコレータ。 |
| get / post / put / delete / patch(rule, **options) | HTTP メソッドのショートカットデコレータ。 |
| add_url_rule(rule, endpoint, view_func, **options) | プログラム的に URL ルールを追加します。 |
フックデコレータ
ブループリントのフックは、そのブループリント内のルートのみに影響します:
| メソッド | 説明 |
|---|---|
| before_request | ブループリント内のすべてのリクエストの前に実行 |
| after_request | ブループリント内のリクエストのレスポンス後に実行 |
| teardown_request | ブループリント内のリクエストコンテキストが破棄されるときに実行 |
| errorhandler(code_or_exception) | ブループリント内のエラーハンドラ |
| url_value_preprocessor | ブループリント内の URL 値プリプロセッサ |
| url_defaults | ブループリント内の URL デフォルトパラメータ |
| template_filter / template_test / template_global | ブループリントのテンプレートフィルター/テスト/グローバル関数 |
ブループリント固有のメソッド
| メソッド | 説明 |
|---|---|
| register(app, options) | ブループリントを Flask アプリケーションに登録します。app.register_blueprint() によって内部的に呼び出されます。 |
| record(func) | ブループリントがアプリケーションに登録されたときに呼び出されるコールバック関数を登録します。 |
| record_once(func) | record と同様ですが、ブループリントを複数回登録しても一度だけ実行されます。 |
| make_setup_state(app, options) | ブループリント登録状態オブジェクトを作成します。 |
| send_static_file(filename) | ブループリントの静的フォルダーからファイルを送信します。 |
| open_resource(resource, mode="rb") | ブループリントのルートパスにあるリソースファイルを開きます。 |
ブループリント登録時の options パラメータ
呼び出すapp.register_blueprint(bp, **options)ときに渡すことができます:
| パラメータ | 説明 |
|---|---|
| url_prefix | ブループリントの URL プレフィックスを上書きします。 |
| subdomain | ブループリントのサブドメインを上書きします。 |
| url_defaults | ブループリントの URL デフォルト値を上書きします。 |
| name | ブループリントの名前を変更します(同じブループリントを複数回、毎回異なる名前で登録できます)。 |
コード例
実例
from flask import Blueprint, render_template
# ブループリントを作成
bp = Blueprint("blog", __name__,
url_prefix="/blog",
template_folder="templates",
static_folder="static")
# ルートを登録
@bp.route("/")
def index():
return render_template("blog/index.html")
@bp.route("/<int:post_id>")
def show(post_id):
return f"Show post {post_id}"
# ブループリント内のフック
@bp.before_request
def check_login():
# /blog/* パスに対してのみ有効
pass
# app に登録
# app.register_blueprint(bp)
# ブループリントを作成
bp = Blueprint("blog", __name__,
url_prefix="/blog",
template_folder="templates",
static_folder="static")
# ルートを登録
@bp.route("/")
def index():
return render_template("blog/index.html")
@bp.route("/<int:post_id>")
def show(post_id):
return f"Show post {post_id}"
# ブループリント内のフック
@bp.before_request
def check_login():
# /blog/* パスに対してのみ有効
pass
# app に登録
# app.register_blueprint(bp)