概要
ブログのようなサイトの記事一覧ページにて、新しい記事にNew!というバッジをつけたい というのはよくあるケースだと思います。
Djangoでこれを実現するには、Contextにnewかどうかのboolを追加する、というやり方が考えられますが、ListViewでこれを行うのはあまり良い方法とは思えません。
今回はテンプレートフィルタを自作して、テンプレート内で新しい記事かどうかを判定する方法を紹介します。
環境
- Python 3.7.4
- MacOS Mojave 10.14.6
- Django 2.2.8
ファイル作成
<プロジェクトフォルダ>/<アプリケーションフォルダ>/ 内にtemplatetags/ディレクトリを作成します。
このアプリケーションはsettings.pyのINSTALLED_APPに記述する必要があります。
作成したディレクトリに、<任意の名前>.pyのファイルを作成します。
ここでの<任意の名前>はtemplate内で`{% load <任意の名前> %}`とするので、命名に気をつけます。
フィルタを作成
今回は、datetime型の値を受け取って、それが直近一週間かどうかを判定するフィルタを作成します。
このフィルタを用いてif文を分岐させるので、返り値はboolにします。
"""
dateが直近一週間かどうか判別するテンプレートタグ
"""
import datetime
from django import template
from django.utils import timezone
register = template.Library()
@register.filter(expects_localtime=True)
def is_new(dt: datetime.datetime):
# newかどうかの基準日
criteria_date = timezone.now() - datetime.timedelta(weeks=1)
return dt >= criteria_date
expects_localtime=Trueについて
公式Docより
If you write a custom filter that operates on datetime objects, you'll usually register it with the expects_localtime flag set to True:
日時オブジェクトを操作するカスタムフィルターを作成する場合、通常は、expects_localtimeフラグをTrueに設定して登録します。
When this flag is set, if the first argument to your filter is a time zone aware datetime, Django will convert it to the current time zone before passing it to your filter when appropriate, according to rules for time zones conversions in templates.
このフラグが設定されている場合、フィルターの最初の引数がタイムゾーン対応の日時である場合、Djangoはテンプレートのタイムゾーン変換の規則に従って、適切なときにフィルターに渡す前に現在のタイムゾーンに変換します。
つまり、タイムゾーンを考慮して計算を行う場合に必要な引数です。
フィルタ関数に渡されるdatetimeがタイムゾーンを考慮した値になります。
命名
@register.filter(name='foo')としてやると、template内ではfooという名前でフィルタが利用出来ます。
name引数を渡さない場合、関数名がそのままフィルタの名前になります。
今回はname引数を渡していないので、is_newという名前でフィルタを利用します。
template
template内では以下のように利用します。
以下はお知らせ一覧を表示し、一週間以内であればnew!バッジをつける例です。bootstrapを使用しています。
contextにnewかどうかを判断したboolを渡すより、かなりすっきりします。
{% load sample_filter %}
...
{% for news in news_list %}
<a href="{% url 'news:detail' news.pk %}" class="list-group-item list-group-item-action">
<span>{{ news.publish_time |date:"Y年m月d日 H:i" }}</span>
<span class="badge badge-primary">{{ news.category }}</span>
{{ news.subject }}
<!-- newバッジをつけるか判定 -->
{% if news.publish_time|is_new %}
<span class="badge badge-info badge-new">new!</span>
{% endif %}
</a>
{% empty %}
<p>お知らせはありません。</p>
{% endfor %}
...
他
上のコード中で利用しているdateフィルタのように、フィルタは引数をとることもできます。
公式Docの引用になりますが、
def cut(value, arg):
"""Removes all values of arg from the given string"""
return value.replace(arg, '')
{{ somevariable|cut:"0" }}
として使えます。get_context_dataなどが肥大化していく際は、テンプレートフィルタを利用するのも一つの手でしょう。
参考
独自のテンプレートタグとフィルタ | Django ドキュメント | Django
https://docs.djangoproject.com/ja/2.2/howto/custom-template-tags/