Moving from direct_to_template to new TemplateView in Django

Question

Looking to update my project to the latest version of django and have found that generic views have changed quite a bit. Looking at the documentation I see that they changed all the generic stuff to class based views. I understand the usage for the most part, but am confused as to what I need to do when returning a larger number of objects for a view. A current url might look like :

(r'^$', direct_to_template, { 'template': 'index.html', 'extra_context': { 'form': CodeAddForm, 'topStores': get_topStores, 'newsStories': get_dealStories, 'latestCodes': get_latestCode, 'tags':get_topTags, 'bios':get_bios}},  'index'),

How do I convert something like that into these new views?

score 31 · Accepted Answer · edited Dec 18 '14 at 20:16

31

Generic Views Migration describes what class based view replaces what. According to the doc, the only way to pass extra_context is to subclass TemplateView and provide your own get_context_data method. Here is a DirectTemplateView class I came up with that allows for extra_context as was done with direct_to_template.

from django.views.generic import TemplateView

class DirectTemplateView(TemplateView):
    extra_context = None
    def get_context_data(self, **kwargs):
        context = super(self.__class__, self).get_context_data(**kwargs)
        if self.extra_context is not None:
            for key, value in self.extra_context.items():
                if callable(value):
                    context[key] = value()
                else:
                    context[key] = value
        return context

Using this class you would replace:

(r'^$', direct_to_template, { 'template': 'index.html', 'extra_context': { 
    'form': CodeAddForm, 
    'topStores': get_topStores, 
    'newsStories': get_dealStories, 
    'latestCodes': get_latestCode, 
    'tags':get_topTags, 
    'bios':get_bios
}},  'index'),

with:

(r'^$', DirectTemplateView.as_view(template_name='index.html', extra_context={ 
    'form': CodeAddForm, 
    'topStores': get_topStores, 
    'newsStories': get_dealStories, 
    'latestCodes': get_latestCode, 
    'tags':get_topTags, 
    'bios':get_bios
}), 'index'),

edited Dec 18 '14 at 20:16

radtek

34,210
11
144
111

answered Aug 27 '12 at 21:45

Pykler

14,565
9
41
50

1

if i'm using direct_to_template in a view what is the syntax for your DirectTemplateView for the following? return direct_to_template(request, template='template.html', extra_context) – rjmoggach Oct 23 '12 at 16:26
1

DirectTemplateView.as_view(template_name='template.html', extra_context=extra_context) – Pykler Oct 24 '12 at 18:17
I've tried this but am getting this error: `AttributeError at /pipe/data_browse/ 'DirectTemplateView' object has no attribute 'has_header' Request Method: GET Request URL: http://localhost:8000/pipe/data_browse/ Django Version: 1.5.2 Exception Type: AttributeError Exception Value: 'DirectTemplateView' object has no attribute 'has_header' Exception Location: /Library/Python/2.7/site-packages/django/utils/cache.py in patch_vary_headers, line 142 Python Executable: /usr/bin/python Python Version: 2.7.2` – Dylan Sep 27 '13 at 16:51
Followup: I found just converting direct_to_template to render_to_response worked better. See my answer below. – Dylan Sep 27 '13 at 17:42
Nice work! I just fixed the formatting of the url to conform with PEP8 – radtek Dec 18 '14 at 19:54

score 4 · Answer 2 · answered Sep 27 '13 at 17:41

I ran into a problem with Pykler's answer using the DirectTemplateView subclass. Specifically, this error:

AttributeError at /pipe/data_browse/ 'DirectTemplateView' object has no attribute 'has_header' Request Method:  
  GET Request URL:  http://localhost:8000/pipe/data_browse/ Django Version: 1.5.2
  Exception Type:   AttributeError
  Exception Value:   'DirectTemplateView' object has no attribute 'has_header'
  Exception Location:   /Library/Python/2.7/site-packages/django/utils/cache.py in patch_vary_headers, line 142 
  Python Executable:    /usr/bin/python 
  Python Version:   2.7.2

What worked for me was to instead convert any line like this:

return direct_to_template(request, 'template.html', {'foo':12, 'bar':13})

to this:

return render_to_response('template.html', {'foo':12, 'bar':13}, context_instance=RequestContext(request))

It apears that Pykler's answer returns a view object to middleware causing issues with some custom middleware, render_to_responce or render works similarly to direct_to_template returning a response object. For the time being this seems like a more backwards compatible approach. This also makes it super simple to upgrade Djano to 1.5 or 1.6 without having to convert all your views to class based views. — Arctelix, Feb 17 '14 at 14:26

Moving from direct_to_template to new TemplateView in Django

2 Answers2

Linked