はじめに
前回までにFlaskの環境構築とルーティングについて学びました。今回は、Webアプリケーションの見た目を担当する「テンプレートエンジンJinja2」について詳しく解説します。Jinja2を使うことで、PythonコードとHTMLを分離し、よりメンテナンス性の高いWebアプリケーションを作成できるようになります。
テンプレートエンジンとは?
テンプレートエンジンの必要性
これまで私たちは、Pythonコードの中にHTMLを文字列として直接記述してきました。
@app.route('/')
def index():
return '''
<html>
<body>
<h1>Hello World</h1>
</body>
</html>
'''
この方法には以下の問題点があります。
- HTMLの編集が困難
- デザイナーと開発者の協業がしにくい
- コードの見通しが悪い
- 繰り返し部分の管理が大変
Jinja2の解決策
Jinja2(ジンジャツー)は、Pythonで使われる高速で柔軟なテンプレートエンジンで、HTMLなどのテンプレートに変数や制御構文を埋め込み、動的なページやテキストを効率よく生成するための仕組みです。以下の機能を提供します。
- 変数の埋め込み
- 制御構造(条件分岐、ループ)
- テンプレートの継承
- フィルターと関数
基本的なディレクトリ構造
まず、テンプレートを使用するための適切なプロジェクト構成を作成しましょう。
myflaskapp/
│
├── venv/ # 仮想環境
├── app.py # メインアプリケーションファイル
├── templates/ # テンプレートディレクトリ
│ ├── base.html # ベーステンプレート
│ ├── index.html # ホームページ
│ ├── about.html # 会社情報ページ
│ └── users.html # ユーザー一覧ページ
└── static/ # 静的ファイル
├── css/
│ └── style.css
├── js/
└── images/
ディレクトリ作成
WindowsもmacOSもmkdirコマンドで必要なフォルダを作成します。
Windows (PowerShell):
mkdir templates, static, static\css, static\js, static\images
Mac (Terminal):
mkdir -p templates static/{css,js,images}
テンプレートの基本構文
最初のテンプレート
まず、最も基本的なテンプレートから始めましょう。
templates/index.html
<!DOCTYPE html>
<html>
<head>
<title>私のFlaskアプリ</title>
</head>
<body>
<h1>ようこそ!</h1>
<p>これは私の最初のJinja2テンプレートです。</p>
</body>
</html>
Flask アプリでブラウザにアクセスしたとき、「ようこそ!」という見出しと、説明文を表示するシンプルなテンプレート です。
テンプレートのレンダリング
テンプレートを表示するには、render_template関数を使用します。
app.py
from flask import Flask, render_template
app = Flask(__name__)
@app.route('/')
def index():
return render_template('index.html')
if __name__ == '__main__':
app.run(debug=True)
FlaskでWeb アプリを動かし、index.html を表示するための基本的な構成 を示しています。
基本的な構文ルール
Jinja2では、以下の特殊な記号を使用します。
{{ ... }}– 変数の表示{% ... %}– 制御構造(if, for, extendsなど){# ... #}– コメント
単純な変数の受け渡し
Pythonからテンプレートに変数を渡す方法です。
app.py
トップページにアクセスされたときに「田中太郎」という名前と「25」という年齢の値を用意し、それらを name と age という名前で index.html テンプレートに渡して表示させるための処理を行っています。
@app.route('/')
def index():
user_name = "田中太郎"
user_age = 25
return render_template('index.html',
name=user_name,
age=user_age)
templates/index.html
Python側から渡された name と age の値をそのままページ内に表示するためのHTMLファイルで、ブラウザを開くと「ユーザー情報」という見出しの下に、受け取った名前と年齢が差し込まれて表示される仕組みになっています。
<!DOCTYPE html>
<html>
<head>
<title>ユーザー情報</title>
</head>
<body>
<h1>ユーザー情報</h1>
<p>名前: {{ name }}</p>
<p>年齢: {{ age }}</p>
</body>
</html>
複雑なデータ構造の受け渡し
app.py
/user にアクセスされたときに「佐藤由紀子」というユーザー情報をまとめた辞書を作り、その辞書を user という名前でテンプレート user.html に渡し、ページ側で名前や年齢、メールアドレス、趣味の一覧を表示できるようにする処理を行っています。
@app.route('/user')
def show_user():
user_data = {
'name': '佐藤由紀子',
'age': 30,
'email': 'hanako@example.com',
'hobbies': ['読書', '旅行', '料理']
}
return render_template('user.html', user=user_data)
templates/user.html
Python側から渡された user という辞書の中身を取り出して画面に表示するためのもので、ページを開くと名前・年齢・メールアドレスがそのまま挿入され、趣味についてはリストになっている項目をカンマ区切りの文字列に変換してまとめて表示するようになっています。
<!DOCTYPE html>
<html>
<head>
<title>ユーザー詳細</title>
</head>
<body>
<h1>ユーザー詳細情報</h1>
<p>名前: {{ user.name }}</p>
<p>年齢: {{ user.age }}</p>
<p>メール: {{ user.email }}</p>
<p>趣味: {{ user.hobbies|join(', ') }}</p>
</body>
</html>
変数のエスケープ
Jinja2はデフォルトでHTMLエスケープを行います。
app.py
/escape にアクセスされたときに、HTMLタグを含んだ文字列と、通常の文字列を用意します。HTMLタグを含んだ文字列は html_text、通常の文字列は normal_text という変数名でテンプレートに渡します。
@app.route('/escape')
def escape_example():
html_text = "これは太字のテキストです"
normal_text = "これは通常のテキストです"
return render_template(
'escape.html',
html_text=html_text,
normal_text=normal_text
)
この段階では、HTMLタグを含む文字列を渡しているだけで、タグのエスケープ処理は明示的に実行していません。
templates/escape.html
templates/escape.html では、Python側から受け取ったデータを、3種類の方法で表示します。1つ目は escape フィルターで明示的にエスケープした表示、2つ目は safe フィルターによってエスケープせずに表示する方法、3つ目は通常の文字列を表示する方法です。
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>エスケープの例</title>
</head>
<body>
<h1>エスケープの例</h1>
<h2>安全な表示(escapeフィルター):</h2>
<p>{{ html_text | escape }}</p>
<h2>エスケープしない表示(safeフィルター):</h2>
<p>{{ html_text | safe }}</p>
<h2>通常の表示:</h2>
<p>{{ normal_text }}</p>
</body>
</html>
上記の3つの表示パターンはそれぞれ以下の通りになります。
安全な表示(escapeフィルター)
Jinja2の escape フィルターによって、HTMLの特殊文字が変換されます。 例えば、<b> タグに含まれる < や > は、それぞれ < と > に変換されます。 ブラウザはタグをHTMLの命令として解釈しないため、文字列として画面に表示します。 また、FlaskのHTMLテンプレートでは自動エスケープが有効なため、{{ html_text }} のようにフィルターを書かなくても、基本的には同じ結果になります。エスケープしない表示(safeフィルター)
Jinja2の safe フィルターは、対象の文字列をエスケープする必要がないものとして扱います。 そのため、文字列に含まれている <b> タグが、そのままHTMLとして出力され、ブラウザでは太字として表示されます。 ただし、safe は文字列の安全性を検証する機能ではありません。 例えば、外部から入力された文字列に悪意のあるJavaScriptが含まれている場合、それを safe で出力すると、XSS(クロスサイトスクリプティング)という脆弱性につながる可能性があります。 そのため、safe は安全性を確認した信頼できるHTMLに対してのみ使用する必要があります。通常の表示
この場合、Python側から渡された文字列には、HTMLタグが含まれていません。Flaskの自動エスケープは有効ですが、変換対象となるHTMLの特殊文字が含まれていないため、表示内容に変化はありません。その結果、通常の文字列として表示されます。制御構造
条件分岐 (if文)
app.py
/conditional にアクセスされたときに「鈴木一郎」というユーザー情報を含む辞書を作り、その中にログイン状態や役割(admin)が入ったまま user としてテンプレートに渡し、ページ側でユーザーがログインしているかどうか、あるいは管理者かどうかといった条件に応じて表示内容を切り替えられるようにしている処理です。
@app.route('/conditional')
def conditional_example():
user = {
'name': '鈴木一郎',
'is_logged_in': True,
'role': 'admin'
}
return render_template('conditional.html', user=user)
templates/conditional.html
渡されたユーザー情報をもとにログイン状態やユーザーの役割に応じて画面に表示するメッセージやスタイルを切り替える仕組みになっており、ログインしていれば名前を表示しながら管理者・一般ユーザー・ゲストのどれに該当するかで文言を変え、ログインしていない場合にはログインを促す内容が表示されるようになっています。
<!DOCTYPE html>
<html>
<head>
<title>条件分岐の例</title>
<style>
.admin { color: red; font-weight: bold; }
.user { color: blue; }
.guest { color: gray; }
</style>
</head>
<body>
<h1>ユーザー状態</h1>
{% if user.is_logged_in %}
<p class="success">ログイン中: {{ user.name }}</p>
{% if user.role == 'admin' %}
<p class="admin">管理者権限があります</p>
{% elif user.role == 'user' %}
<p class="user">一般ユーザーです</p>
{% else %}
<p class="guest">ゲストユーザーです</p>
{% endif %}
{% else %}
<p class="warning">ログインしていません</p>
<a href="/login">ログイン</a>
{% endif %}
</body>
</html>
ループ (for文)
app.py
/products にアクセスされたときに複数の商品の情報を一覧として用意し、そのリストを products という名前でテンプレートに渡して、ページ側で商品名や価格、在庫の有無などを繰り返し処理によって表示できるようにしている処理です。
@app.route('/products')
def products():
products_list = [
{'id': 1, 'name': 'ノートパソコン', 'price': 99800, 'in_stock': True},
{'id': 2, 'name': 'マウス', 'price': 2500, 'in_stock': True},
{'id': 3, 'name': 'キーボード', 'price': 5800, 'in_stock': False},
{'id': 4, 'name': 'モニター', 'price': 32800, 'in_stock': True},
{'id': 5, 'name': 'Webカメラ', 'price': 7200, 'in_stock': False}
]
return render_template('products.html', products=products_list)
templates/products.html
渡された商品のリストを表形式で表示するためのもので、商品ごとにIDや名前、価格、在庫状況を1行ずつ並べ、在庫がある場合は緑色、在庫がない場合は赤色といったようにスタイルを変えつつ、行番号によって背景色を切り替えることで見やすい一覧として表示できるように構成されています。また、ループの最後には商品数を表示する仕組みも含まれています。
<!DOCTYPE html>
<html>
<head>
<title>商品一覧</title>
<style>
table { border-collapse: collapse; width: 100%; }
th, td { border: 1px solid #ddd; padding: 12px; text-align: left; }
th { background-color: #f2f2f2; }
.in-stock { color: green; }
.out-of-stock { color: red; }
.even { background-color: #f9f9f9; }
</style>
</head>
<body>
<h1>商品一覧</h1>
<table>
<thead>
<tr>
<th>ID</th>
<th>商品名</th>
<th>価格</th>
<th>在庫状況</th>
</tr>
</thead>
<tbody>
{% for product in products %}
<tr class="{% if loop.index % 2 == 0 %}even{% else %}odd{% endif %}">
<td>{{ product.id }}</td>
<td>{{ product.name }}</td>
<td>{{ product.price }}円</td>
<td class="{% if product.in_stock %}in-stock{% else %}out-of-stock{% endif %}">
{% if product.in_stock %}
○ 在庫あり
{% else %}
✗ 在庫切れ
{% endif %}
</td>
</tr>
{% endfor %}
</tbody>
</table>
<h2>ループ変数の情報</h2>
<p>商品数: {{ products|length }}</p>
</body>
</html>
ループ変数
forループ内では、以下の特別な変数が利用できます。
templates/loop_vars.html
Jinja2 のループ機能を使って「りんご」「バナナ」「オレンジ」の3つを順番に表示しながら、各アイテムについてループ専用の変数を利用して、現在の位置や総回数、最初や最後の要素かどうかといった情報を同時に画面に表示する仕組みになっています。
<!DOCTYPE html>
<html>
<head>
<title>ループ変数</title>
</head>
<body>
<h1>ループ変数の例</h1>
<ul>
{% for item in ['りんご', 'バナナ', 'オレンジ'] %}
<li>
アイテム: {{ item }}<br>
インデックス: {{ loop.index }}<br>
0始まりインデックス: {{ loop.index0 }}<br>
反復回数: {{ loop.length }}<br>
最初の要素: {{ loop.first }}<br>
最後の要素: {{ loop.last }}<br>
<hr>
</li>
{% endfor %}
</ul>
</body>
</html>
フィルター
Jinja2フィルターは変数を変換またはフォーマットするための関数です。変数の後ろにパイプ記号(|)を記述して使用します。
{{ 変数名 | フィルター名 }}
各要素の意味は以下の通りです。
| 記述 | 意味 |
|---|---|
{{ }} | Jinja2で値をHTMLに出力するための構文 |
変数名 | Pythonなどから渡されたデータ |
\| | 変数とフィルターをつなぐ記号 |
フィルター名 | データに適用する処理の名前 |
基本的なフィルター
app.py
/filters にアクセスされたときに文字列や数値、リスト、HTML文字列、現在時刻といったさまざまな種類のデータをまとめて用意し、それらを data という名前でテンプレートに渡すことで、Jinja2 のフィルターを使った加工や整形の例をページ側で確認できるようにするための処理です。
@app.route('/filters')
def filters_example():
sample_data = {
'title': 'hello world',
'description': 'This is a LONG description that needs to be shortened.',
'price': 1234.5678,
'items': ['apple', 'banana', 'cherry'],
'html_content': '<p>This is <strong>HTML</strong> content</p>',
'now': datetime.now()
}
return render_template('filters.html', data=sample_data)
この書き方は、フィルター適用前と適用後の値を並べて表示するためのものです。
{{ data.title }} → {{ data.title|upper }}
{{ data.title }}:Pythonから渡されたdataのtitleをそのまま表示します。→:単なる文字列です。Jinja2の特別な構文ではありません。{{ data.title|upper }}:titleの文字列をすべて大文字に変換して表示します。|:フィルターを適用するための記号です。
例えば、Python側で次のように定義した場合、
data = {"title": "Hello Flask"}
HTMLでは次のように記述します。
<p>{{ data.title }} → {{ data.title|upper }}</p>
ブラウザの表示結果
Hello Flask → HELLO FLASK
つまり、{{ }} は変数を表示する構文であり、|upper はその値を大文字に変換する処理です。
なお、"(ダブルクォーテーション)で囲んでも構いません。その場合は、表示結果にも " が付きます。
templates/filters.html
Jinja2 のさまざまなフィルターを実際のデータに適用するとどのような結果になるのかを一覧で確認できるようにした例で、文字列の変換や短縮、リストの結合、数値の整形、未定義値へのデフォルト設定、HTMLを安全にそのまま表示する処理、さらには日付のフォーマットまでを表形式で分かりやすく示す構成になっています。
<!DOCTYPE html>
<html>
<head>
<title>フィルターの例</title>
</head>
<body>
<h1>Jinja2フィルターの例</h1>
<table border="1">
<tr>
<th>フィルター</th>
<th>結果</th>
</tr>
<tr>
<td>capitalize</td>
<td>"{{ data.title }}" → "{{ data.title|capitalize }}"</td>
</tr>
<tr>
<td>upper</td>
<td>"{{ data.title }}" → "{{ data.title|upper }}"</td>
</tr>
<tr>
<td>lower</td>
<td>"{{ data.title|upper }}" → "{{ data.title|upper|lower }}"</td>
</tr>
<tr>
<td>truncate</td>
<td>"{{ data.description }}" → "{{ data.description|truncate(20) }}"</td>
</tr>
<tr>
<td>length</td>
<td>"{{ data.items }}" → {{ data.items|length }} 項目</td>
</tr>
<tr>
<td>join</td>
<td>"{{ data.items }}" → "{{ data.items|join(', ') }}"</td>
</tr>
<tr>
<td>float</td>
<td>"{{ data.price }}" → "{{ data.price|float }}"</td>
</tr>
<tr>
<td>round</td>
<td>"{{ data.price }}" → "{{ data.price|round(2) }}"</td>
</tr>
<tr>
<td>currency format</td>
<td>"{{ data.price }}" → "{{ data.price|round|int }}円"</td>
</tr>
<tr>
<td>default</td>
<td>"{{ undefined_var|default('デフォルト値') }}"</td>
</tr>
<tr>
<td>safe (HTMLエスケープ無効)</td>
<td>{{ data.html_content|safe }}</td>
</tr>
<tr>
<td>datetime format</td>
<td>"{{ data.now }}" → "{{ data.now.strftime('%Y年%m月%d日 %H:%M') }}"</td>
</tr>
</table>
</body>
</html>
カスタムフィルターの作成
独自のフィルターを作成することもできます。
app.py
Flask に独自のカスタムフィルターを追加し、それをテンプレート内で使えるようにした例で、金額を「¥1,234,567」のような日本向けの書式に変換するフィルターと、日付から「月・火・水…」といった日本語の曜日を取り出すフィルターを登録し、そのフィルターを利用できるように値(価格と現在日時)をテンプレートへ渡して表示させるしくみになっています。
from flask import Flask, render_template
from datetime import datetime
app = Flask(__name__)
# カスタムフィルターの登録
@app.template_filter('format_currency')
def format_currency(value):
return f"¥{value:,.0f}"
@app.template_filter('japanese_weekday')
def japanese_weekday(date):
weekdays = ['月', '火', '水', '木', '金', '土', '日']
return weekdays[date.weekday()]
@app.route('/custom-filters')
def custom_filters():
return render_template('custom_filters.html',
price=1234567,
today=datetime.now())
if __name__ == '__main__':
app.run(debug=True)
templates/custom_filters.html
Flask側で登録したカスタムフィルターを実際に使って表示するためのページで、渡された price を format_currency フィルターで「¥1,234,567」のような日本向けの通貨表記に変換し、today に対してはそのままの日付表示に加えて、japanese_weekday フィルターを使って「月・火・水…」といった日本語の曜日を取り出して併記するように作られています。
<!DOCTYPE html>
<html>
<head>
<title>カスタムフィルター</title>
</head>
<body>
<h1>カスタムフィルターの例</h1>
<p>価格: {{ price|format_currency }}</p>
<p>今日の曜日: {{ today }} ({{ today|japanese_weekday }}曜日)</p>
</body>
</html>
テンプレートの継承
ベーステンプレートの作成
テンプレート継承は、共通のレイアウトを定義し、各部分を子テンプレートで上書きできる機能です。
templates/base.html
Flask のアプリ全体で共通して使うレイアウトを定義した“親テンプレート”になっており、ページのタイトル、ヘッダー、ナビゲーションメニュー、メッセージ表示、メインコンテンツ部分、フッターなどの基本構造をまとめておき、子テンプレートが必要な部分だけを block を使って差し替えられるように作られています。ページ全体のデザインやレイアウトを一箇所で管理しつつ、個別ページは content や title などのブロックを上書きするだけで独自表示ができるようにする仕組みです。
<!DOCTYPE html>
<html>
<head>
<title>{% block title %}マイサイト{% endblock %}</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 0;
padding: 0;
background-color: #f4f4f4;
}
.header {
background-color: #333;
color: white;
padding: 1rem;
}
.nav {
background-color: #444;
padding: 0.5rem;
}
.nav a {
color: white;
text-decoration: none;
margin-right: 1rem;
}
.nav a:hover {
text-decoration: underline;
}
.content {
padding: 2rem;
background-color: white;
margin: 1rem;
border-radius: 5px;
}
.footer {
background-color: #333;
color: white;
text-align: center;
padding: 1rem;
margin-top: 2rem;
}
.messages {
padding: 1rem;
margin: 1rem;
border-radius: 5px;
}
.success { background-color: #d4edda; color: #155724; }
.error { background-color: #f8d7da; color: #721c24; }
.warning { background-color: #fff3cd; color: #856404; }
</style>
{% block extra_css %}{% endblock %}
</head>
<body>
<header class="header">
<h1>{% block header %}マイFlaskアプリ{% endblock %}</h1>
</header>
<nav class="nav">
<a href="/">ホーム</a>
<a href="/about">会社情報</a>
<a href="/users">ユーザー一覧</a>
<a href="/products">商品一覧</a>
</nav>
<div class="messages">
{% with messages = get_flashed_messages(with_categories=true) %}
{% if messages %}
{% for category, message in messages %}
<div class="{{ category }}">{{ message }}</div>
{% endfor %}
{% endif %}
{% endwith %}
</div>
<main class="content">
{% block content %}
<!-- この部分は子テンプレートで上書きされます -->
{% endblock %}
</main>
<footer class="footer">
<p>© 2024 マイFlaskアプリ. All rights reserved.</p>
{% block footer %}
<p>連絡先: info@example.com</p>
{% endblock %}
</footer>
{% block extra_js %}{% endblock %}
</body>
</html>
子テンプレートの作成
templates/index.html
Flask + Jinja2 の「子テンプレート」 の典型的な使い方を示しており、base.html を継承しながら必要な部分だけカスタマイズしてホームページを作る例になっています。
{% extends "base.html" %}
{% block title %}ホーム - マイサイト{% endblock %}
{% block header %}ようこそ!{% endblock %}
{% block content %}
<h2>ホームページ</h2>
<p>これはホームページの内容です。</p>
<div class="features">
<h3>特徴</h3>
<ul>
<li>レスポンシブデザイン</li>
<li>ユーザーフレンドリー</li>
<li>高速なパフォーマンス</li>
</ul>
</div>
<div class="stats">
<h3>統計情報</h3>
<p>登録ユーザー数: 1,234人</p>
<p>総訪問者数: 45,678人</p>
</div>
{% endblock %}
{% block footer %}
<p>特別なフッターコンテンツ - ホームページ限定</p>
{{ super() }} <!-- 親テンプレートのフッター内容も表示 -->
{% endblock %}
templates/about.html
base.html を継承して会社情報ページを構成するための子テンプレートとして機能しています。まず最初に親テンプレートを継承し、そのうえで title ブロックと header ブロックを上書きすることで、このページ固有のタイトルと見出しを設定しています。続く content ブロックでは、会社紹介の文章や会社概要を表にまとめた内容、さらに企業としてのミッションが記述されており、この部分がページの主要コンテンツとなります。
{% extends "base.html" %}
{% block title %}会社情報 - マイサイト{% endblock %}
{% block header %}会社情報{% endblock %}
{% block content %}
<h2>私たちについて</h2>
<p>当社は革新的なWebソリューションを提供しています。</p>
<div class="company-info">
<h3>会社概要</h3>
<table>
<tr>
<th>会社名</th>
<td>株式会社サンプル</td>
</tr>
<tr>
<th>設立</th>
<td>2020年1月</td>
</tr>
<tr>
<th>所在地</th>
<td>東京都渋谷区</td>
</tr>
<tr>
<th>従業員数</th>
<td>50名</td>
</tr>
</table>
</div>
<div class="mission">
<h3>ミッション</h3>
<p>お客様の成功を通じて社会に貢献します。</p>
</div>
{% endblock %}
{% block extra_css %}
<style>
table {
border-collapse: collapse;
width: 100%;
}
th, td {
border: 1px solid #ddd;
padding: 8px;
text-align: left;
}
th {
background-color: #f2f2f2;
width: 30%;
}
</style>
{% endblock %}
また、最後に定義されている extra_css ブロックでは、このページだけに適用されるテーブルのスタイルが記述されており、セルの罫線や背景色、レイアウトに関するデザインを個別に調整しています。全体として、親テンプレートのレイアウト構造を保ちながら、このページ専用の内容とスタイルを柔軟に追加・変更するためのテンプレート構成になっています。
インクルードの使用
共通部分を別ファイルに分割してインクルードすることもできます。
templates/includes/navigation.html
このナビゲーション部分のコードは、サイト全体で共通して利用されるメニューを構成しており、ユーザーが主要なページへ素早く移動できるようにリンクを並べたものです。<nav> 要素はナビゲーション領域であることを示し、その中に複数の <a> タグが配置されています。リンク先はホーム、会社情報、ユーザー一覧、商品一覧、そしてお問い合わせページへと続いており、どれもサイト運営に必要な基本的コンテンツへアクセスするための導線となっています。スタイルクラスとして nav が指定されているため、親テンプレートや外部CSSでまとめてデザインが施され、サイト全体で統一感のあるナビゲーションバーとして表示されます。
<nav class="nav">
<a href="/">ホーム</a>
<a href="/about">会社情報</a>
<a href="/users">ユーザー一覧</a>
<a href="/products">商品一覧</a>
<a href="/contact">お問い合わせ</a>
</nav>
ベーステンプレートでインクルードを使用
このコードは base.html の一部で、ヘッダーとナビゲーションをまとめてページに組み込む部分を示しています。<header> 内の header ブロックは子テンプレートで自由に上書きできるようになっており、デフォルトでは「マイFlaskアプリ」と表示されます。その下で {% include 'includes/navigation.html' %} によってナビゲーション用のHTMLファイルを挿入しており、共通のメニューを複数のページで再利用できるように構成されています。これにより、ヘッダーとナビゲーションの構造を一箇所で管理しつつ、子テンプレートごとにヘッダー内容だけを変えることが可能になります。
<!-- base.htmlの一部 -->
<body>
<header class="header">
<h1>{% block header %}マイFlaskアプリ{% endblock %}</h1>
</header>
{% include 'includes/navigation.html' %}
<!-- 残りの内容 -->
</body>
ベストプラクティス
1. テンプレートの整理
- 関連するテンプレートはグループ化
- 共通部分はインクルードまたはベーステンプレートで管理
- 命名規則を統一
2. ビジネスロジックとプレゼンテーションの分離
- 複雑な計算はPythonコードで行う
- テンプレートでは表示に専念
- フィルターを使用して簡単な変換のみ行う
3. エラーハンドリング
Flask でカスタムエラーページを設定する部分です。@app.errorhandler(404) デコレーターは、存在しないページにアクセスしたときに呼び出され、先ほどの 404.html テンプレートを表示して HTTP ステータスコード 404 を返します。同様に、@app.errorhandler(500) はサーバー内部でエラーが発生した場合に 500.html を表示してステータスコード 500 を返すようになっています。これにより、ユーザーにわかりやすいエラーページを提供しつつ、標準のブラウザエラー画面ではなく自作のページでエラー内容を案内できるようになります。
@app.errorhandler(404)
def not_found_error(error):
return render_template('404.html'), 404
@app.errorhandler(500)
def internal_error(error):
return render_template('500.html'), 500
templates/404.html
存在しないページにアクセスした際に表示される 404 エラーページ用の子テンプレートです。base.html を継承して共通レイアウトを使いながら、タイトルを「ページが見つかりません」に変更し、content ブロック内でエラーメッセージと説明文を表示しています。さらにホームページへのリンクをボタンとして設置しており、ユーザーが簡単にトップページに戻れるように配慮された構成になっています。
{% extends "base.html" %}
{% block title %}ページが見つかりません{% endblock %}
{% block content %}
<div class="error-page">
<h1>404 - ページが見つかりません</h1>
<p>お探しのページは存在しないか、移動した可能性があります。</p>
<a href={{ url_for('index') }} class="button">ホームに戻る</a>
</div>
{% endblock %}
実践的な例:ユーザー管理システム
app.py
Flask を使って簡易的なユーザー管理アプリを作成した例です。アプリはトップページとユーザー一覧ページを持ち、ユーザーごとの詳細ページや新規ユーザー追加ページも用意されています。ユーザー情報はサンプルデータとしてリストに保持され、user_detail では URL から取得した ID に基づいて対象ユーザーを検索し、存在しなければフラッシュメッセージを表示して一覧ページにリダイレクトします。
from flask import Flask, render_template, request, redirect, url_for, flash
app = Flask(__name__)
# サンプルユーザーデータ
users = [
{'id': 1, 'name': '田中太郎', 'email': 'taro@example.com', 'role': 'admin', 'active': True},
{'id': 2, 'name': '佐藤由紀子', 'email': 'hanako@example.com', 'role': 'user', 'active': True},
{'id': 3, 'name': '鈴木一郎', 'email': 'ichiro@example.com', 'role': 'user', 'active': False},
{'id': 4, 'name': '高橋美咲', 'email': 'misaki@example.com', 'role': 'editor', 'active': True}
]
@app.route('/')
def index():
return render_template('index.html')
@app.route('/users')
def user_list():
return render_template('users.html', users=users)
@app.route('/user/')
def user_detail(user_id):
user = next((u for u in users if u['id'] == user_id), None)
if user:
return render_template('user_detail.html', user=user)
else:
flash('ユーザーが見つかりません', 'error')
return redirect(url_for('user_list'))
@app.route('/add-user', methods=['GET', 'POST'])
def add_user():
if request.method == 'POST':
# 新しいユーザーの追加処理(簡易版)
new_user = {
'id': len(users) + 1,
'name': request.form.get('name'),
'email': request.form.get('email'),
'role': request.form.get('role'),
'active': bool(request.form.get('active'))
}
users.append(new_user)
flash('ユーザーが正常に追加されました', 'success')
return redirect(url_for('user_list'))
return render_template('add_user.html')
if __name__ == '__main__':
app.run(debug=True)
add_user ではフォームから送信されたデータを受け取り、新しいユーザーをリストに追加した後、成功メッセージをフラッシュしてユーザー一覧に戻る処理が行われています。全体として、テンプレートのレンダリング、URL パラメータの取得、条件によるリダイレクト、フラッシュメッセージの活用といった Flask の基本機能を統合したシンプルなユーザー管理の流れを示しています。
templates/users.html
base.html を継承してユーザー一覧ページを構築する子テンプレートで、ページタイトルとヘッダーを「ユーザー一覧」「ユーザー管理」に上書きしています。content ブロックでは、新規ユーザー追加ボタンやユーザー情報を表形式で一覧表示し、ユーザーごとのID、名前、メール、権限、状態、詳細ページへのリンクを動的に表示しています。
{% extends "base.html" %}
{% block title %}ユーザー一覧 - マイサイト{% endblock %}
{% block header %}ユーザー管理{% endblock %}
{% block content %}
<div class="actions">
<a href={{ url_for('add_user') }} class="button">新しいユーザーを追加</a>
</div>
<table class="user-table">
<thead>
<tr>
<th>ID</th>
<th>名前</th>
<th>メール</th>
<th>権限</th>
<th>状態</th>
<th>操作</th>
</tr>
</thead>
<tbody>
{% for user in users %}
<tr class="{% if not user.active %}inactive{% endif %}">
<td>{{ user.id }}</td>
<td>{{ user.name }}</td>
<td>{{ user.email }}</td>
<td>
<span class="role {{ user.role }}">
{% if user.role == 'admin' %}管理者
{% elif user.role == 'editor' %}編集者
{% else %}ユーザー
{% endif %}
</span>
</td>
<td>
{% if user.active %}
<span class="active">有効</span>
{% else %}
<span class="inactive">無効</span>
{% endif %}
</td>
<td>
<a href={{ url_for('user_detail', user_id=user.id) }}>詳細</a>
</td>
</tr>
{% endfor %}
</tbody>
</table>
<div class="stats">
<p>総ユーザー数: {{ users|length }}</p>
<p>有効ユーザー: {{ users|selectattr('active')|list|length }}</p>
<p>管理者: {{ users|selectattr('role', 'equalto', 'admin')|list|length }}</p>
</div>
{% endblock %}
{% block extra_css %}
<style>
.button {
background-color: #007bff;
color: white;
padding: 10px 20px;
text-decoration: none;
border-radius: 5px;
display: inline-block;
margin-bottom: 20px;
}
.user-table {
width: 100%;
border-collapse: collapse;
}
.user-table th, .user-table td {
border: 1px solid #ddd;
padding: 12px;
text-align: left;
}
.user-table th {
background-color: #f2f2f2;
}
.role.admin { color: #dc3545; font-weight: bold; }
.role.editor { color: #fd7e14; }
.role.user { color: #28a745; }
.active { color: #28a745; }
.inactive { color: #6c757d; }
tr.inactive { background-color: #f8f9fa; }
.stats {
margin-top: 20px;
padding: 15px;
background-color: #e9ecef;
border-radius: 5px;
}
</style>
{% endblock %}
権限や状態に応じて文字色や背景色を変える条件分岐が含まれており、非アクティブユーザーは行の背景色が淡くなるなど視覚的な区別もされています。さらに、総ユーザー数や有効ユーザー数、管理者数などの統計情報も表示され、extra_css ブロックではボタンやテーブル、ユーザーの役割や状態に応じたスタイルを定義してページ全体の見た目を整えています。
まとめ
今回は、Jinja2テンプレートエンジンの基本構文や変数の表示方法、条件分岐・ループなどの制御構造、フィルターの活用方法、テンプレート継承について学習しました。
Jinja2を活用することで、HTMLとPythonの処理を分離し、保守性や再利用性の高いWebアプリケーションを構築できます。
今後の演習では、フォーム処理やデータベース連携について学び、ユーザーの操作に応じて動作する、より実践的なWebアプリケーションの開発を進めていきます。