Skip to content
Code Blue プログラミング学習ノート
Python/Flask

FlaskルーティングとBlueprint

はじめに

前回の記事では、Flaskの「ルーティング」と「ビュー関数」について学習しました。

これまでは、app.py にURLとビュー関数をまとめて記述していました。しかし、Webアプリケーションの規模が大きくなると、ルーティングの数が増え、1つのファイルで管理することが難しくなります。

そこでFlaskには、ルーティングを機能ごとに分割して管理できる Blueprint(ブループリント) という仕組みが用意されています。

この記事では、Blueprintの基本概念から、複数ファイルに分けたFlaskアプリケーションの構築方法までを解説します。

Blueprintの基本概念

Blueprintとは?

Blueprintとは、Flaskアプリケーションのルーティングや関連する処理を、機能ごとにまとめて管理するための仕組みです。

例えば、学習ログアプリに以下のページがあるとします。

  • トップページ
  • 学習ログ一覧ページ
  • 学習ログ詳細ページ
  • アプリ説明ページ

これまでの方法では、すべてのルーティングを app.py に記述していました。

from flask import Flask

app = Flask(__name__)

@app.route('/')
def index():
    return 'トップページ'

@app.route('/logs')
def logs():
    return '学習ログ一覧'

@app.route('/about')
def about():
    return 'アプリ説明'

この方法でも問題ありませんが、機能が増えるとコードが長くなり、管理しづらくなります。

Blueprintを使用すると、ルーティングを別のファイルにまとめ、Flaskアプリケーションに登録できるようになります。

Blueprintを使用するメリット

メリット説明
ファイルの分割ルーティングを複数のファイルに分けられる
管理のしやすさ機能ごとにコードを整理できる
再利用性Blueprintを別のFlaskアプリケーションでも利用できる
拡張性新しい機能を追加しやすくなる

Blueprintは、それ自体が独立したFlaskアプリケーションではありません。ルーティングなどの定義をまとめ、Flaskアプリケーションに登録して使用する仕組みです。

Blueprintの基本的な使い方

Blueprintの作成

まず、Blueprintを使用してルーティングを定義してみましょう。

from flask import Blueprint

main = Blueprint('main', __name__)

@main.route('/')
def index():
    return 'トップページ'

@main.route('/about')
def about():
    return 'アプリ説明ページ'

これまでの @app.route() が @main.route() に変わっていることがポイントです。

Blueprintの定義

main = Blueprint('main', __name__)

このコードでは、Blueprint クラスからBlueprintオブジェクトを作成しています。

記述説明
BlueprintFlaskが提供するBlueprintクラス
'main'Blueprintの名前
__name__Blueprintが定義されているモジュールの名前
main作成したBlueprintを格納する変数

main という名前は自由に変更できます。

例えば、ユーザー管理機能なら users、商品管理機能なら products といった名前を使用できます。

@main.route() デコレータ

@main.route('/about')
def about():
    return 'アプリ説明ページ'

基本的な書き方は、これまで学習した @app.route() と同じです。

  • @app.route():Flaskアプリケーションに直接ルートを登録する
  • @main.route():Blueprintにルートを定義する

ただし、Blueprintに定義しただけでは、FlaskアプリケーションのURLとして使用できません。

BlueprintをFlaskアプリケーションに登録する必要があります。

Blueprintの登録

register_blueprint() メソッド

BlueprintをFlaskアプリケーションに登録するには、register_blueprint() を使用します。

from flask import Flask, Blueprint

app = Flask(__name__)

main = Blueprint('main', __name__)

@main.route('/')
def index():
    return 'トップページ'

app.register_blueprint(main)

登録処理の解説

app.register_blueprint(main)

このコードは、main というBlueprintをFlaskアプリケーションに登録する処理です。

登録すると、Blueprintで定義したルーティングが使用できるようになります。

例えば、次のような対応になります。

Blueprintで定義したURLブラウザからアクセスするURL
/http://127.0.0.1:5000/
/abouthttp://127.0.0.1:5000/about

Blueprintを作成しても、登録しなければルーティングは反映されません。

Blueprintを別ファイルで管理する

Blueprintの重要な特徴は、ルーティングを別ファイルに分割できることです。

ディレクトリ構成

まず、以下の構成でファイルを作成します。

studylog/
├── app.py
└── application/
    ├── __init__.py
    └── routes/
        ├── __init__.py
        └── main.py

各ファイルの役割は以下のとおりです。

ファイル役割
app.pyFlaskアプリケーションの起動入口
application/__init__.pyFlaskアプリケーションの生成とBlueprintの登録
application/routes/main.pyURLとビュー関数の定義
application/routes/__init__.pyroutesディレクトリをPythonパッケージとして扱うためのファイル

今回は application/routes/__init__.py には何も記述しません。

① main.pyにルーティングを定義する

application/routes/main.py

from flask import Blueprint

main = Blueprint('main', __name__)

@main.route('/')
def index():
    return 'トップページ'

@main.route('/logs')
def logs():
    return '学習ログ一覧ページ'

@main.route('/about')
def about():
    return 'アプリ説明ページ'

main.py は、URLにアクセスしたときに実行する処理をまとめたファイルです。

ここではFlaskアプリケーション自体は作成せず、Blueprintだけを定義しています。

② init.pyでFlaskアプリケーションを生成する

application/__init__.py

from flask import Flask

def create_app():
    app = Flask(__name__)

    from application.routes.main import main
    app.register_blueprint(main)

    return app

ここでは create_app() という関数を定義しています。

このように、関数を使用してFlaskアプリケーションを生成する設計を アプリケーションファクトリ(Application Factory) と呼びます。

処理の流れは以下のとおりです。

  1. Flask(__name__) でFlaskアプリケーションを生成する
  2. main.py からBlueprintを読み込む
  3. register_blueprint() でBlueprintを登録する
  4. return app で生成したアプリケーションを返す

③ app.pyでアプリケーションを生成する

app.py

from application import create_app

app = create_app()

if __name__ == '__main__':
    app.run(debug=True)

app.py は、アプリケーションの起動入口です。

from application import create_app

このコードは、application/__init__.py で定義された create_app() を読み込んでいます。

続いて、次のコードを実行します。

app = create_app()

これによりFlaskアプリケーションが生成され、Blueprintも登録されます。

最後に app.run() で開発用サーバーを起動します。

ファイル間の処理の流れ

これまでのコードを整理すると、次のようになります。

app.py
  │
  │ create_app()を呼び出す
  ▼
application/__init__.py
  │
  ├── Flaskアプリケーションを生成
  │
  ├── main.pyを読み込む
  │
  └── Blueprintを登録
             │
             ▼
application/routes/main.py
  │
  └── URLとビュー関数を定義

この仕組みにより、アプリケーションを起動する処理と、各ページのルーティングを分離できます。

なお、上の図は主にアプリケーションの初期化時の流れを示しています。実際にブラウザからアクセスしたときは、Flaskが登録済みのルーティングを参照し、対応するビュー関数を実行します。

実践的な例:StudyLogアプリケーション

これまでの内容を使い、学習ログの詳細ページを追加してみましょう。

動的URLパラメータとBlueprint

Blueprintでも、これまで学習した動的URLパラメータを利用できます。

application/routes/main.py

from flask import Blueprint

main = Blueprint('main', __name__)

# 仮の学習ログデータ
logs = {
    1: 'Pythonの基礎を学習',
    2: 'Flaskのルーティングを学習',
    3: 'Blueprintを学習'
}

@main.route('/')
def index():
    return 'StudyLog トップページ'

@main.route('/logs')
def log_list():
    return '学習ログ一覧ページ'

@main.route('/logs/<int:log_id>')
def log_detail(log_id):
    log = logs.get(log_id)

    if log is None:
        return 'ログが見つかりません', 404

    return f'ログID: {log_id} / 学習内容: {log}'

@main.route('/about')
def about():
    return 'StudyLogについて'

動的ルートの解説

@main.route('/logs/<int:log_id>')
def log_detail(log_id):

これは、URLに含まれる整数を log_id という引数で受け取る処理です。

例えば、以下のURLにアクセスします。

http://127.0.0.1:5000/logs/2

すると、log_id に 2 が渡され、次の内容が表示されます。

ログID: 2 / 学習内容: Flaskのルーティングを学習

存在しないログIDにアクセスした場合は、HTTPステータスコード404とともに「ログが見つかりません」と表示します。

この段階ではデータベースを使用せず、Pythonの辞書を仮の学習ログデータとして利用しています。

BlueprintのURLプレフィックス

Blueprintには、複数のURLに共通するパスを設定する機能があります。

これを URLプレフィックス(url_prefix) と呼びます。

例えば、学習ログに関連するページを /logs 以下にまとめたい場合は、次のように記述できます。

from flask import Blueprint

logs_bp = Blueprint('logs', __name__)

@logs_bp.route('/')
def log_list():
    return '学習ログ一覧'

@logs_bp.route('/<int:log_id>')
def log_detail(log_id):
    return f'ログID: {log_id}'

Blueprintを登録するときに、url_prefix を指定します。

app.register_blueprint(logs_bp, url_prefix='/logs')

これにより、次のURLが使用できるようになります。

Blueprint内のURL実際のURL
//logs/
/<int:log_id>/logs/1 など

このように、Blueprintを使用すると関連するルーティングをまとめて管理できます。

なお、今回のStudyLog演習では、すべてのルーティングを main.py に記述するため、URLプレフィックスの設定は必須ではありません。

Blueprintとurl_for()

前回学習した url_for() は、Blueprintでも使用できます。

ただし、Blueprintを使用する場合は、基本的に次のように記述します。

url_for('main.index')

ここでの main はBlueprintの名前、index はビュー関数の名前です。

例えば、トップページへのURLを取得する場合は次のようになります。

from flask import Blueprint, url_for

main = Blueprint('main', __name__)

@main.route('/')
def index():
    return 'トップページ'

@main.route('/about')
def about():
    return url_for('main.index')

url_for('main.index') の実行結果は / です。

Blueprintを使用しない場合の url_for('index') とは、指定方法が異なる点に注意してください。

まとめ

今回は、FlaskのBlueprintを使用したルーティングの管理方法について学習しました。Blueprintは、Blueprint() で作成し、@main.route() でルーティングを定義した後、register_blueprint() でFlaskアプリケーションに登録する仕組みです。また、create_app() を活用することで、アプリケーションの生成処理を整理できます。

従来の @app.route() との主な違いは、ルーティングを機能ごとに分割して管理できる点です。これにより、複数ファイルで構成されるアプリケーションの保守性や拡張性が向上します。