1. Django Tutorial(Airbnb) - Template Filter

📌 이 포스팅에서는 Django에 "Built-in Template Filter"과 "Custom Template Filter"를 만들어 사용하는 방법에 대해 알아보겠습니다.

🌈 Custom Template Filter

🔥 Built-in Template Filter

🔥 Custom Template Filter

1. Built-in Template Filter

Django는 Template Filter를 통해 Template에서 파이프(|)로 시작해서 함수처럼 문자열 등을 처리하는데 도움을 줍니다.
아래 소개된 "Built-in Template Filter" 뿐만아니라 |date, |addslashes, |cut, |floatformat 등 다양한 Template Filter가 존재합니다.

🔎 |add : 숫자를 더해줍니다.

{{ value|add:"2" }}  # 👈 value = 3 이라면,, 2를 더해 5로 나타냅니다.

🔎 |capfirst : 첫번째 글자를 대문자로 변경시켜줍니다.

{{ value|capfirst }} # 👈 value = 'django' 라면,, "Django"로 변환

🔎 |center : 공백을 주고, 가운데 정렬을 해줘요.

"{{ value|center:"15" }}" # 👈 value = 'Django' 라면,, "    Django    "로 변환

🔎 |first : 리스트에서 맨 처음 요소를 가져옵니다.

{{ value|first }} # 👈 value = ['a', 'b', 'c']라면,, 'a'만 가져옴

🔎 |join : python join 문법과 같은 기능이에요.

{{ value|join:" // " }} # 👈 value = ['a', 'b', 'c']라면,, "a // b // c"

2. Custom Template Filter

🤔 Custom Template Filter 생성하기

필요한 기능이 "Built-in Template Filter"로 제공되지 않다면, 직접 추가하여 사용할 수 있습니다. 이를 "Custom Template Filter"라 합니다.

• 참고 : https://docs.djangoproject.com/en/2.2/howto/custom-template-tags/

str을 대문자로 변경시키는 Custom Template Filter를 만들어 보겠습니다. "Custom Template Filter"를 사용할 app 디렉토리 바로 아래에 "templatetags" 디렉토리를 생성합니다. 다른 이름으로 생성하면 Django가 인식할 수 없으니 꼭 "templatetags"라는 이름을 사용해야 합니다.
"templatetags" 디렉토리 내에 "__init__.py"와 등록할 함수를 넣어줄 python 파일을 생성합니다. 저는 "my_filter.py"로 생성하였습니다.

app dir/ # 👈 사용할 app 디렉토리
    __init__.py
    models.py
    templatetags/ # 👈 "templatetags" dir 만듭니다:)
        __init__.py       # 👈 __ini__.py를 만듭니다:)
        my_filter.py      # 👈 python 함수를 만들 파일을 만듭니다:)
    views.py

Custom Template Filter를 등록하는 방법은 아래 2가지가 있습니다.

• 방법1 : 데코레이션 사용 방법으로 name값에 함수의 이름을 전달합니다.

from django import template       # 👈 "template" import
register = template.Library()     # 👈 template.Library()에 추가해주어야 합니다.
@register.filter(name="my_upper") # 👈 template.Library()에 filter를 등록
def my_upper(value):
    return value.upper()

• 방법2 : filter의 첫번째 argument로 template에서 사용할 이름을 str로 넣고, 두번째 argument로 함수를 명시해줍니다.

from django import template # 👈 "template" import
register = template.Library() # 👈 template.Library()에 추가해주어야 합니다.
def my_upper(value):
    return value.upper()
register.filter("lululala", my_upper) # 👈 template에서 |lululala로 사용할 수 있어요:)

🤔 Custom Template Filter 사용하기

• 사용할 템플릿으로 이동해 상단 부분에 "my_filter.py"를 load드 합니다.

{% extends "base.html" %}
{% load my_filter %}  # 👈 custom template filter를 load
{% block content %}
    {{'somthing'|my_upper}} # 👈 등록한 filte 기능이 적용되어 'somthing'이 'SOMETHING'로 나타납니다.
{% endblock %}