プログラミング

FlaskのカスタムJinjaフィルター作成法

最終更新： 16/04/2025
1 分の読み

Flask は、Python の軽量なウェブアプリケーションフレームワークで、Jinja テンプレートエンジンを使用して HTML を動的に生成します。Jinja はデフォルトでさまざまな組み込みフィルターを提供しますが、特定のニーズに合わせてカスタムフィルターを作成することも可能です。本記事では、Flask アプリケーションにおける Jinja フィルターの作成方法について、完全かつ包括的に解説します。

Jinja フィルターとは？

Jinja フィルターは、テンプレート内で変数を処理するために使用される関数です。フィルターは通常、パイプ (|) 演算子と共に使われ、変数の値に変換や加工を加えます。たとえば、文字列を小文字に変換する組み込みのフィルター lower を使用する場合、次のように記述します。

関連記事
jinja
{{ "Hello World!" | lower }}

このコードは、出力として「hello world!」を生成します。

Flask アプリケーションでカスタム Jinja フィルターを作成する方法

Flask でカスタムフィルターを作成するには、まずフィルターの実装を行い、それを Flask アプリケーションに登録する必要があります。以下はその手順です。

1. Flask アプリケーションをセットアップする

まず最初に、Flask アプリケーションを作成します。以下のコードで Flask をインストールし、簡単なアプリケーションを設定します。

bash
pip install Flask

次に、app.py というファイルを作成し、基本的な Flask アプリケーションを定義します。

python
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)

2. カスタムフィルターを作成する

カスタムフィルターは、Flask アプリケーションで使用する前に定義する必要があります。カスタムフィルターは、Python の関数として作成され、その後 Flask アプリケーションに登録されます。以下に例を示します。

例えば、文字列を逆順にするフィルターを作成したいとします。次のように関数を定義します。

python
def reverse_string(s):
    return s[::-1]

この関数は、文字列 s を逆順にして返します。

3. カスタムフィルターを Flask アプリケーションに登録する

次に、reverse_string フィルターを Flask アプリケーションに登録します。これには、app.jinja_env.filters を使用してフィルターを Flask の Jinja 環境に追加します。

python
app.jinja_env.filters['reverse'] = reverse_string

これで、reverse というフィルターがテンプレート内で使用可能になります。

4. テンプレートでフィルターを使用する

テンプレートファイル（例えば templates/index.html）内で、作成したカスタムフィルターを使用することができます。以下のように、reverse フィルターを使って文字列を逆順にする例を示します。

html
html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>カスタムフィルターの例title>
head>
<body>
    <h1>{{ "こんにちは、Flask!" | reverse }}h1>
body>
html>

上記のテンプレートでは、"こんにちは、Flask!" という文字列を逆順に変換するために、reverse フィルターを使用しています。出力結果は以下のようになります。

diff
!ksaFl ,はちにこ

5. 複数のカスタムフィルターの作成

Flask では、複数のカスタムフィルターを作成することも可能です。たとえば、文字列の最初の文字を大文字にするフィルターや、数字を通貨形式で表示するフィルターを作成することができます。

python
def capitalize_first(s):
    return s.capitalize()

def format_currency(amount):
    return f"¥{amount:,.2f}"

これらのフィルターも同様に Flask アプリケーションに登録します。

python
app.jinja_env.filters['capitalize'] = capitalize_first
app.jinja_env.filters['currency'] = format_currency

そして、テンプレート内でこれらのフィルターを使用します。

html
html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>複数フィルターの例title>
head>
<body>
    <h1>{{ "hello world" | capitalize }}h1>
    <p>{{ 1234567.89 | currency }}p>
body>
html>

この場合、出力結果は次のようになります。

nginx
Hello world
¥1,234,567.89

6. フィルターに引数を渡す

カスタムフィルターは引数を取ることもできます。例えば、文字列の一部を置換するフィルターを作成する場合、次のように実装できます。

python
def replace_word(s, old, new):
    return s.replace(old, new)

このフィルターを Flask アプリケーションに登録するには、以下のようにします。

python
app.jinja_env.filters['replace'] = replace_word

そして、テンプレート内で引数を渡して使用します。

html
html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>引数付きフィルターの例title>
head>
<body>
    <h1>{{ "こんにちは、世界!" | replace("世界", "Flask") }}h1>
body>
html>

この場合、出力結果は次のようになります。

こんにちは、Flask!

7. フィルターのデバッグ

カスタムフィルターを作成していると、動作が期待通りでない場合があります。Flask にはデバッグ機能が備わっており、エラーメッセージを表示することで、問題を迅速に解決できます。Flask アプリケーションをデバッグモードで実行することで、エラーが発生した際に詳細なエラーメッセージを確認できます。

python
app.run(debug=True)

8. フィルターの組み合わせ

Jinja では、複数のフィルターをパイプ (|) で組み合わせて使用できます。例えば、文字列を小文字にした後、その文字列を逆順にしたい場合、次のように記述します。

jinja
{{ "こんにちは、Flask!" | lower | reverse }}

このようにして、複数のカスタムフィルターを連携させることができます。

まとめ

Flask アプリケーションでカスタム Jinja フィルターを作成することにより、テンプレートのレンダリング時にデータを動的に処理する柔軟性が得られます。フィルターを適切に使用することで、コードの可読性が向上し、テンプレート内でのデータ操作を簡素化できます。今回紹介した方法を参考に、アプリケーションに合わせたカスタムフィルターを作成し、より効果的な開発を行ってください。

最終更新： 16/04/2025
1 分の読み
Back to top button