【Flask】url_for関数で動的リンクを生成しよう｜Chapter2-3

一つ前のページではテンプレートの継承について学習しました。

今回は url_for()関数 について見ていきましょう。

FlaskでWebアプリを開発していると、「リンク先を指定する」場面に何度も遭遇します。

このときURLパスをそのままHTMLにベタ書きしてしまうと、後々のルート変更などでコードのメンテナンスがとても大変になります。

Flaskでは、この問題を解決するために url_for() という便利な関数が用意されており、ルーティングで定義した関数名から自動的に対応するURLパスを生成できます。

この記事では、url_for() の基本から使い方まで、初心者にもわかりやすく丁寧に解説していきます。

<<前のページ

Flaskの記事一覧

次のページ>>

url_for関数でリンクを動的生成する方法と基本構文

url_for()関数は、Flaskにおける「関数名からURLを生成する関数」です。

url_for関数とは？｜ルートに依存しないリンクを生成しよう

通常、HTMLでリンクを貼るときには以下のようにURLパスを直接書くことが多いです。

<a href="/hello">Helloページ</a>

しかしこの方法では、もしURLを /hello → /greeting に変更したい場合、テンプレートファイル内のすべての /hello を修正しなければなりません。

そこで登場するのが url_for()関数です。

この関数を使えば、URLではなくルートに対応した「関数名」からURLを自動生成できるため、ルート変更にも柔軟に対応できます。

あわせて読みたい

【HTML】レッスン1-3：Webページにリンクや画像を挿入しよう

url_forの基本構文と記述例

url_for関数は、Pythonコードとテンプレート内（Jinja2）にそれぞれ以下のように記載します。

from flask import url_for

url_for('関数名') # その関数のurlを生成

{{ url_for('関数名') }} <!-- その関数のurlを生成 -->

このように、url_for() には関数名を文字列として渡し、必要に応じてパラメータを指定します。

関数名は @app.route() で指定されたURLに対応しています。

例えば、以下のコードを見てみましょう。

from flask import Flask, url_for
app = Flask(__name__)

@app.route('/hello') # もしこのURLにアクセスされたら
def hello():         # hello関数の定義
    return 'Hello, Flask!'

with app.test_request_context(): # リクエストコンテキスト（詳細は後述）
    print(url_for('hello'))		 # hello関数のURL（/hello）を生成し、確認のため出力

このコードを実行すると、Hello関数にルーティングされたURL「/hello」が出力されます。

また、テンプレートの中でリンクを作るときも url_for() は非常に便利です。

<!-- hello関数のurlへリンク -->
<a href="{{ url_for('hello') }}">Helloページへ</a>

このように書くことで、ルートに対応するURLが自動的に挿入され、
<a href="/hello">Helloページへ</a> というHTMLが生成されます。

リクエストコンテキストとは？｜app.test_request_context()メソッドを使おう

Flaskでは、request や url_for などの一部のオブジェクトや関数は「リクエストコンテキスト」という特別な状態の中でしか正しく動作しません。

リクエストコンテキストとは、「今まさに誰かがこのアプリにアクセスしてきて、リクエストが処理されている状態」を指します。

Webアプリでは、多くの場合、ユーザーがページにアクセスしたとき自動的にリクエストコンテキストが作られます。そのため普段は意識しなくても問題ありません。

しかし、スクリプトや対話型シェル、学習中のテストコードなど「実際のリクエストが無い場面」でFlaskの機能を使いたい場合、このリクエストコンテキストを自分で用意する必要があります。

そこで使うのが、app.test_request_context()メソッド です。

with app.test_request_context():
    # ここでFlaskのrequestやurl_forなどが使える

このブロック内では一時的にリクエストが発生したのと同じ状態、すなわちリクエストコンテキストを作り出します。

この仕組みにより、たとえば

with app.test_request_context():
    print(url_for('hello'))

と書くと、実際にアクセスがなくてもurl_for('hello')が正しく動き、そのエンドポイントに対応するURL（例：/hello）を取得できます。

引数を持つurl_for()関数の記述方法と注意点

もしURLに変数を含める場合は、ルーティング関数と合わせて url_for() にも引数を渡します。

@app.route('/user/<username>') # もしこのURLにアクセスされたら
def user_profile(username):    # 仮引数usernameを持つuser_profile関数の定義
    return f'ユーザー名: {username}'

with app.test_request_context(): # リクエストコンテキスト
    print(url_for('user_profile', username='taro')) # user_profil関数のURLを生成し、確認のため出力

このコードを実行すると、user_profile関数にルーティングされたURL「/user/taro」が出力されます。

テンプレート側でも以下のように使用できます。

<a href="{{ url_for('user_profile', username='taro') }}">Taroのプロフィール</a>

url_for()関数を使用することで、URLパスをテンプレートに直接書かなくてよいため保守性が大幅に向上します。

特にプロジェクトが大きくなってからの変更対応に大きなメリットがあります。

まとめ：url_forを使えばFlaskのリンク管理が圧倒的に楽になる

• url_for() は関数名からURLを生成するFlaskの組み込み関数
• Python側でもテンプレート側でも使用可能
• 引数付きルートも柔軟に対応
• 直接URLを書かず、保守性の高いコードを実現できる

次回は render_template() を使ってテンプレートにデータを渡す方法を学び、url_for() と組み合わせて実用的なページを作成していきます！

<<前のページ

Flaskの記事一覧

次のページ>>

FAQ｜Flaskのurl_for関数の使い方でよくある質問