How do I add multiple arguments to my custom template filter in a django template?

by

It is possible and fairly simple.

Django only allows one argument to your filter, but there’s no reason you can’t put all your arguments into a single string using a comma to separate them.

So for example, if you want a filter that checks if variable X is in the list [1,2,3,4] you will want a template filter that looks like this:

{% if X|is_in:"1,2,3,4" %}

Now we can create your templatetag like this:

from django.template import Library

register = Library()

def is_in(var, args):
    if args is None:
        return False
    arg_list = [arg.strip() for arg in args.split(',')]
    return var in arg_list

register.filter(is_in)

The line that creates arg_list is a generator expression that splits the args string on all the commas and calls .strip() to remove any leading and trailing spaces.

If, for example, the 3rd argument is an int then just do:

arg_list[2] = int(arg_list[2])

Or if all of them are ints do:

arg_list = [int(arg) for arg in args.split(',')]

EDIT: now to specifically answer your question by using key,value pairs as parameters, you can use the same class Django uses to parse query strings out of URL’s, which then also has the benefit of handling character encoding properly according to your settings.py.

So, as with query strings, each parameter is separated by ‘&’:

{{ attr.name|replace:"cherche=_&remplacement= " }}

Then your replace function will now look like this:

from django import template
from django.http import QueryDict

register = template.Library()

@register.filter
def replace(value, args):
    qs = QueryDict(args)
    if qs.has_key('cherche') and qs.has_key('remplacement'):
        return value.replace(qs['cherche'], qs['remplacement'])
    else:
        return value

You could speed this up some at the risk of doing some incorrect replacements:

qs = QueryDict(args)
return value.replace(qs.get('cherche',''), qs.get('remplacement',''))

More Related Contents:

  1. Rendering a template variable as HTML
  2. How to add url parameters to Django template url tag?
  3. django 1.5 – How to use variables inside static tag
  4. How can I change the default Django date template format?
  5. Applying bootstrap styles to django forms
  6. How to get the current URL within a Django template?
  7. Load a Django template tag library for all views by default
  8. Need to convert a string to int in a django template
  9. Is it possible to pass query parameters via Django’s {% url %} template tag?
  10. Use variable as dictionary key in Django template
  11. Variable subtraction in django templates
  12. How to set a value of a variable inside a template code?
  13. Django – iterate number in for loop of a template
  14. What is a context in Django?
  15. Django: How do I add arbitrary html attributes to input fields on a form?
  16. Get list item dynamically in django templates
  17. Django templates – split string to array
  18. Django Template – Increment the value of a variable
  19. how to embed standalone bokeh graphs into django templates
  20. Access kwargs from a URL in a Django template
  21. Django templates: value of dictionary key with a space in it
  22. Django templates: verbose version of a choice
  23. Django {{ MEDIA_URL }} blank @DEPRECATED
  24. How to use if/else condition on Django Templates?
  25. How to iterate over nested dictionaries in django templates
  26. Django templates folders
  27. Get type of Django form widget from within template
  28. How do I display the value of a Django form field in a template?
  29. How do you limit list objects template side, rather than view side
  30. Django template {%for%} tag add li every 4th element

Leave a Comment