Django snippets: Private Context Decorator

from django.template.context import Context

def private_context(f):
    """
    Simple decorator which avoids the need to a) copy-and-paste code to force
    context variables into inclusion_tag templates and b) carefully avoid
    inclusion tag variables conflicting with global variables.
    
    Instead each inclusion tag will be called with a *copy* of the provided
    context variable and its results will be merged in to avoid leaking into
    the global context
    """
    from functools import wraps
    
    @wraps(f)
    def private_context_wrapper(context, *args, **kwargs):
        c = Context(context)
        rc = f(c, *args, **kwargs)
        c.update(rc)
        return c

    return private_context_wrapper

More like this

Template tag: Group variables into list by Killarny 4 years, 2 months ago
inclusion tag with template as variable by forgems 4 years, 3 months ago
Decorating class-based views by lqc 1 year, 3 months ago
Repeat blocks with new context / simple Jinja-like macro system by miracle2k 5 years, 9 months ago
Readonly fields on Form/Modelform by Killarny 4 years, 2 months ago

Django's standard inclusion_tag doesn't include context variables by default. When you add takes_context you are required to manually merge the context variables into the dict which your tag returns, which tends to result in wasteful code or [possibly accidentally] leaking variables into the global context (context.update({…})).

This decorator allows your inclusion tag to remain simple and still have safe access to the global context for things like MEDIA_URL:

@register.inclusion_tag('my_template')
@private_context
def my_tag(context, …):
  return {"foo": 1, "bar": 2}

Author:: acdha
Posted:: August 16, 2009
Language:: Python
Django Version:: 1.1
Tags:: templatetag decorator context inclusion_tag
Score:: 1 (after 1 ratings)

Django snippets

Private Context Decorator

More like this

Tools

Comments

Snippets

About