Django(3)常用模板的过滤器

为什么需要过滤器?

因为在DTL中,不支持函数的调用形式(),因此不能给函数传递参数,这将有很大的局限性。而过滤器其实就是一个函数,可以对需要处理的参数进行处理,并且还可以额外接收一个参数(也就是说,最多只能有2个参数)。

add过滤器:

将传进来的参数添加到原来的值上面。这个过滤器会尝试将参数转换成整形然后进行相加。如果转换成整形过程中失败了,那么会将参数进行拼接。如果是字符串,那么会拼接成字符串,如果是列表,那么会拼接成一个列表。示例代码如下:

{{ value|add:"2" }}

如果value是等于4,那么结果将是6。如果value是等于一个普通的字符串,比如abc,那么结果将是abc2add过滤器的源代码如下:

def add(value, arg):
"""Add the arg to the value."""
    try:
        return int(value) + int(arg)
    except (ValueError, TypeError):
        try:
            return value + arg
        except Exception:
            return ''

cut过滤器:

移除值中所有指定的字符串。类似于python中的replace(args,"")。示例代码如下:

{{ value|cut:" " }}

以上示例将会移除value中所有的空格字符。cut过滤器的源代码如下:

def cut(value, arg):
"""Remove all values of arg from the given string."""
    safe = isinstance(value, SafeData)
    value = value.replace(arg, '')
    if safe and arg != ';':
        return mark_safe(value)
    return value

date过滤器:


一个日期按照指定的格式,格式化成字符串。示例代码如下:

# 数据
context = {
    "birthday": datetime.now()
}

# 模版
{{ birthday|date:"Y/m/d" }}

那么将会输出2018/02/01。其中Y代表的是四位数字的年份,m代表的是两位数字的月份,d代表的是两位数字的日。
还有更多时间格式化的方式。见下表。

格式字符 描述 示例
Y 四位数字的年份 2018
m 两位数字的月份 01-12
n 月份,1-9前面没有0前缀 1-12
d 两位数字的天 01-31
j 天,但是1-9前面没有0前缀 1-31
g 小时,12小时格式的,1-9前面没有0前缀 1-12
h 小时,12小时格式的,1-9前面有0前缀 01-12
G 小时,24小时格式的,1-9前面没有0前缀 1-23
H 小时,24小时格式的,1-9前面有0前缀 01-23
i 分钟,1-9前面有0前缀 00-59
s 秒,1-9前面有0前缀 00-59

default

如果值被评估为False。比如[]""None{}等这些在if判断中为False的值,都会使用default过滤器提供的默认值。示例代码如下:

{{ value|default:"nothing" }}

如果value是等于一个空的字符串。比如"",那么以上代码将会输出nothing

default_if_none

如果值是None,那么将会使用default_if_none提供的默认值。这个和default有区别,default是所有被评估为False的都会使用默认值。而default_if_none则只有这个值是等于None的时候才会使用默认值。示例代码如下:

{{ value|default_if_none:"nothing" }}

如果value是等于""也即空字符串,那么以上会输出空字符串。如果value是一个None值,以上代码才会输出nothing

first

返回列表/元组/字符串中的第一个元素。示例代码如下:

{{ value|first }}

如果value是等于['a','b','c'],那么输出将会是a

last

返回列表/元组/字符串中的最后一个元素。示例代码如下:

{{ value|last }}

如果value是等于['a','b','c'],那么输出将会是c

floatformat

使用四舍五入的方式格式化一个浮点类型。如果这个过滤器没有传递任何参数。那么只会在小数点后保留一个小数,如果小数后面全是0,那么只会保留整数。当然也可以传递一个参数,标识具体要保留几个小数。

  1. 如果没有传递参数:
value 模版代码 输出
34.23234 {{ value|floatformat }} 34.2
34.000 {{ value|floatformat }} 34
34.260 {{ value|floatformat }} 34.3
  1. 如果传递参数:
value 模版代码 输出
34.23234 {{value|floatformat:3}} 34.232
34.0000 {{value|floatformat:3}} 34.000
34.26000 {{value|floatformat:3}} 34.260

join

类似与Python中的join,将列表/元组/字符串用指定的字符进行拼接。示例代码如下:

{{ value|join:"/" }}

如果value是等于['a','b','c'],那么以上代码将输出a/b/c

length

获取一个列表/元组/字符串/字典的长度。示例代码如下:

{{ value|length }}

如果value是等于['a','b','c'],那么以上代码将输出3。如果valueNone,那么以上将返回0

lower

将值中所有的字符全部转换成小写。示例代码如下:

{{ value|lower }}

如果value是等于Hello World。那么以上代码将输出hello world

upper

类似于lower,只不过是将指定的字符串全部转换成大写。

random

在被给的列表/字符串/元组中随机的选择一个值。示例代码如下:

{{ value|random }}

如果value是等于['a','b','c'],那么以上代码会在列表中随机选择一个。

safe

标记一个字符串是安全的。也即会关掉这个字符串的自动转义。示例代码如下:

{{value|safe}}

如果value是一个不包含任何特殊字符的字符串,比如这种,那么以上代码就会把字符串正常的输入。如果value是一串html代码,那么以上代码将会把这个html代码渲染到浏览器中。

slice

类似于Python中的切片操作。示例代码如下:

{{ some_list|slice:"2:" }}

以上代码将会给some_list2开始做切片操作。

stringtags

删除字符串中所有的html标签。示例代码如下:

{{ value|striptags }}

如果valuehello world,那么以上代码将会输出hello world

truncatechars

如果给定的字符串长度超过了过滤器指定的长度。那么就会进行切割,并且会拼接三个点来作为省略号。示例代码如下:

{{ value|truncatechars:5 }}

如果value是等于北京欢迎您~,那么输出的结果是北京...。可能你会想,为什么不会北京欢迎您...呢。因为三个点也占了三个字符,所以北京+三个点的字符长度就是5。

truncatechars_html

类似于truncatechars,只不过是不会切割html标签。示例代码如下:

{{ value|truncatechars:5 }}

如果value是等于

北京欢迎您~

,那么输出将是

北京...


自定义过滤器:

  1. 首先在某个app中,创建一个python包,叫做templatetags,注意,这个包的名字必须为templatetags,不然就找不到。
  2. 在这个templatetags包下面,创建一个python文件用来存储过滤器。
  3. 在新建的python文件中,定义过滤器(也就是函数),这个函数的第一个参数永远是被过滤的那个值,并且如果在使用过滤器的时候传递参数,那么还可以定义另外一个参数。但是过滤器最多只能有2个参数。
  4. 在写完过滤器(函数)后,要使用django.template.Library.filter进行注册。
  5. 还要把这个过滤器所在的这个app添加到settings.INSTALLED_APS中,不然Django也找不到这个过滤器。
  6. 在模板中使用load标签加载过滤器所在的python包。
  7. 可以使用过滤器了。
  8. django.template.Library.filter还可以当作装饰器来使用。如果filter函数没有传递任何参数,那么将会使用这个函数的名字来作为过滤器的名字。当然如果你不想使用函数的名字来作为过滤器的名字,也可以传递一个name参数。示例代码如下:
    from django import template
    
    register = template.Library()
    
    @register.filter('my_greet')
    def greet(value,word):
        return value + word
    

自定义过滤器实例

  1. filter_demoapp下创建templatetags文件夹,并创建__init__.pymy_filter.py两个文件,其中my_filter.py文件代码如下:
    from django import template
    from datetime import datetime
    
    register = template.Library()
    
    
    @register.filter
    def time_since(value):
      '''
      time距离现在的时间间隔
      1.时间小于1分钟,显示“刚刚”
      2.时间大于1分钟小于1小时,显示“xxx分钟之前”
      3.时间大于1小时小于24小时,显示“xxx小时之前”
      4.时间大于24小时小于30天以内,显示“xxx天以前”
      5.否则显示具体时间,时间格式为:2019/03/25 23:29
      '''
        if not isinstance(value, datetime):
           return value
        now = datetime.now()
        # (now-value)是一个timedelay类型
        timestamp = (now - value).total_seconds()
        if timestamp < 60:
            return '刚刚'
        elif timestamp >= 60 and timestamp <= 60 * 60:
            minutes = int(timestamp / 60)
            return '%s分钟之前' % minutes
        elif timestamp >= 60 * 60 and timestamp <= 60 * 60 * 24:
            hours = int(timestamp / 60 / 60)
            return '%s小时之前' % hours
        elif timestamp >= 60 * 60 * 24 and timestamp <= 60 * 60 * 24 * 30:
            days = int(timestamp / 60 / 60 / 24)
            return '%s小时之前' % days
        else:
            return value.strftime('%Y/%m/%d %H:%M')
    
  2. 在templates文件中新建index.html,其中使用如下:
    {% load my_filter %}
    
    
        
            
            Document
      
      
          {{ mytime|time_since }}
      
    
    
  3. 在主项目文件settings.py中添加模板路径与注册app,其中代码如下:
    INSTALLED_APPS = [
        'django.contrib.admin',
       'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        # 注册自定义过滤模板
        'filter_demo',
    ]
    
    TEMPLATES = [
        {
           'BACKEND': 'django.template.backends.django.DjangoTemplates',
            'DIRS': [os.path.join(BASE_DIR, 'templates')],
            'APP_DIRS': True,
            'OPTIONS': {
                'context_processors': [
                    'django.template.context_processors.debug',
                    'django.template.context_processors.request',
                    'django.contrib.auth.context_processors.auth',
                    'django.contrib.messages.context_processors.messages',
                ],
            },
        },
    ]
    
  4. 在filter_demo的视图函数中views.py中传递数据,代码如下:
    from django.shortcuts import render
    from datetime import datetime
    # Create your views here.
    
    
    def index(request):
        context = {
            'mytime': datetime(year=2019, month=3, day=26, hour=0, minute=6, second=56)
        }
        return render(request, 'index.html', context=context)
    
  5. 在主项目的urls.py中定义路由映射,代码如下:
    from django.contrib import admin
    from django.urls import path
    from filter_demo import views
    
    urlpatterns = [
        path('admin/', admin.site.urls),
        path('', views.index),
    ]
    

你可能感兴趣的:(Django(3)常用模板的过滤器)