Performing a getattr() style lookup in a django template

Python’s getattr() method is useful when you don’t know the name of a certain attribute in advance.

This functionality would also come in handy in templates, but I’ve never figured out a way to do it. Is there a built-in tag or non-built-in tag that can perform dynamic attribute lookups?

Answers:

Thank you for visiting the Q&A section on Magenaut. Please note that all the answers may not help you solve the issue immediately. So please treat them as advisements. If you found the post helpful (or not), leave a comment & I’ll get back to you as soon as possible.

Method 1

I also had to write this code as a custom template tag recently. To handle all look-up scenarios, it first does a standard attribute look-up, then tries to do a dictionary look-up, then tries a getitem lookup (for lists to work), then follows standard Django template behavior when an object is not found.

(updated 2009-08-26 to now handle list index lookups as well)

# app/templatetags/getattribute.py

import re
from django import template
from django.conf import settings

numeric_test = re.compile("^d+$")
register = template.Library()

def getattribute(value, arg):
    """Gets an attribute of an object dynamically from a string name"""

    if hasattr(value, str(arg)):
        return getattr(value, arg)
    elif hasattr(value, 'has_key') and value.has_key(arg):
        return value[arg]
    elif numeric_test.match(str(arg)) and len(value) > int(arg):
        return value[int(arg)]
    else:
        return settings.TEMPLATE_STRING_IF_INVALID

register.filter('getattribute', getattribute)

Template usage:

{% load getattribute %}
{{ object|getattribute:dynamic_string_var }}

Method 2

I don’t think so. But it wouldn’t be too hard to write a custom template tag to return an attribute in the context dict. If you’re simply trying to return a string, try something like this:

class GetAttrNode(template.Node):
    def __init__(self, attr_name):
        self.attr_name = attr_name

    def render(self, context):
        try:
            return context[self.attr_name]
        except:
            # (better yet, return an exception here)
            return ''

@register.tag
def get_attr(parser, token):
    return GetAttrNode(token)

Note that it’s probably just as easy to do this in your view instead of in the template, unless this is a condition that is repeated often in your data.

Method 3

I ended up adding a method to the model in question, and that method can be accessed like an attribute in the template.

Still, i think it would be great if a built in tag allowed you to dynamically lookup an attribute, since this is a problem a lot of us constantly have in our templates.

Method 4

Keeping the distinction between get and getattr,

@register.filter(name='get')
def get(o, index):
    try:
        return o[index]
    except:
        return settings.TEMPLATE_STRING_IF_INVALID


@register.filter(name='getattr')
def getattrfilter(o, attr):
    try:
        return getattr(o, attr)
    except:
        return settings.TEMPLATE_STRING_IF_INVALID

Method 5

There isn’t a built-in tag, but it shouldn’t be too difficult to write your own.

Method 6

That snippet saved my day but i needed it to span it over relations so I changed it to split the arg by “.” and recursively get the value.
It could be done in one line:
return getattribute(getattribute(value,str(arg).split(".")[0]),".".join(str(arg).split(".")[1:]))
but I left it in 4 for readability.
I hope someone has use for this.

import re
from django import template
from django.conf import settings

numeric_test = re.compile("^d+$")
register = template.Library()

def getattribute(value, arg):
"""Gets an attribute of an object dynamically AND recursively from a string name"""
    if "." in str(arg):
        firstarg = str(arg).split(".")[0]
        value = getattribute(value,firstarg)
        arg = ".".join(str(arg).split(".")[1:])
        return getattribute(value,arg)
    if hasattr(value, str(arg)):
        return getattr(value, arg)
    elif hasattr(value, 'has_key') and value.has_key(arg):
        return value[arg]
    elif numeric_test.match(str(arg)) and len(value) > int(arg):
        return value[int(arg)]
    else:
        #return settings.TEMPLATE_STRING_IF_INVALID
        return 'no attr.' + str(arg) + 'for:' + str(value)

register.filter('getattribute', getattribute)

All methods was sourced from stackoverflow.com or stackexchange.com, is licensed under cc by-sa 2.5, cc by-sa 3.0 and cc by-sa 4.0