Skip to content
/ django Public

Commit 49fd163

Browse files
adrianholovatyadrianholovaty
committed
Fixed #925 -- Added TEMPLATE_CONTEXT_PROCESSORS, which lets you specify processesors for DjangoContext. Thanks, Luke Plant
git-svn-id: http://code.djangoproject.com/svn/django/trunk@1773 bcc190cf-cafb-0310-a4f2-bffc1f526a37
1 parent d926905 commit 49fd163

File tree

9 files changed

+212
-86
lines changed

9 files changed

+212
-86
lines changed

‎django/conf/global_settings.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,15 @@
100100
# 'django.core.template.loaders.eggs.load_template_source',
101101
)
102102

103+
# List of processors used by DjangoContext to populate the context.
104+
# Each one should be a callable that takes the request object as its
105+
# only parameter and returns a dictionary to add to the context.
106+
TEMPLATE_CONTEXT_PROCESSORS = (
107+
'django.core.context_processors.auth',
108+
'django.core.context_processors.debug',
109+
'django.core.context_processors.i18n',
110+
)
111+
103112
# URL prefix for admin media -- CSS, JavaScript and images. Make sure to use a
104113
# trailing slash.
105114
# Examples: "http://foo.com/media/", "/media/".

‎django/core/extensions.py‎

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,34 @@
22
# of MVC. In other words, these functions/classes introduce controlled coupling
33
# for convenience's sake.
44

5-
from django.core.exceptions import Http404, ObjectDoesNotExist
5+
from django.core.exceptions import Http404, ImproperlyConfigured, ObjectDoesNotExist
66
from django.core.template import Context, loader
7-
from django.conf.settings import DEBUG, INTERNAL_IPS
7+
from django.conf.settings import TEMPLATE_CONTEXT_PROCESSORS
88
from django.utils.httpwrappers import HttpResponse
99

10+
_standard_context_processors = None
11+
12+
# This is a function rather than module-level procedural code because we only
13+
# want it to execute if somebody uses DjangoContext.
14+
def get_standard_processors():
15+
global _standard_context_processors
16+
if _standard_context_processors is None:
17+
processors = []
18+
for path in TEMPLATE_CONTEXT_PROCESSORS:
19+
i = path.rfind('.')
20+
module, attr = path[:i], path[i+1:]
21+
try:
22+
mod = __import__(module, '', '', [attr])
23+
except ImportError, e:
24+
raise ImproperlyConfigured, 'Error importing request processor module %s: "%s"' % (module, e)
25+
try:
26+
func = getattr(mod, attr)
27+
except AttributeError:
28+
raise ImproperlyConfigured, 'Module "%s" does not define a "%s" callable request processor' % (module, attr)
29+
processors.append(func)
30+
_standard_context_processors = tuple(processors)
31+
return _standard_context_processors
32+
1033
def render_to_response(*args, **kwargs):
1134
return HttpResponse(loader.render_to_string(*args, **kwargs))
1235
load_and_render = render_to_response # For backwards compatibility.
@@ -25,24 +48,19 @@ def get_list_or_404(mod, **kwargs):
2548

2649
class DjangoContext(Context):
2750
"""
28-
This subclass of template.Context automatically populates 'user' and
29-
'messages' in the context.
51+
This subclass of template.Context automatically populates itself using
52+
the processors defined in TEMPLATE_CONTEXT_PROCESSORS.
53+
Additional processors can be specified as a list of callables
54+
using the "processors" keyword argument.
3055
"""
31-
def __init__(self, request, dict=None):
56+
def __init__(self, request, dict=None, processors=None):
3257
Context.__init__(self, dict)
33-
self['user'] = request.user
34-
self['messages'] = request.user.get_and_delete_messages()
35-
self['perms'] = PermWrapper(request.user)
36-
from django.conf import settings
37-
self['LANGUAGES'] = settings.LANGUAGES
38-
if hasattr(request, 'LANGUAGE_CODE'):
39-
self['LANGUAGE_CODE'] = request.LANGUAGE_CODE
58+
if processors is None:
59+
processors = ()
4060
else:
41-
self['LANGUAGE_CODE'] = settings.LANGUAGE_CODE
42-
if DEBUG and request.META.get('REMOTE_ADDR') in INTERNAL_IPS:
43-
self['debug'] = True
44-
from django.core import db
45-
self['sql_queries'] = db.db.queries
61+
processors = tuple(processors)
62+
for processor in get_standard_processors() + processors:
63+
self.update(processor(request))
4664

4765
# PermWrapper and PermLookupDict proxy the permissions system into objects that
4866
# the template system can understand.

‎django/views/generic/create_update.py‎

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
from django.core.template import loader
44
from django.core import formfields, meta
55
from django.views.auth.login import redirect_to_login
6-
from django.core.extensions import DjangoContext as Context
6+
from django.core.extensions import DjangoContext
77
from django.core.paginator import ObjectPaginator, InvalidPage
88
from django.utils.httpwrappers import HttpResponse, HttpResponseRedirect
99
from django.core.exceptions import Http404, ObjectDoesNotExist, ImproperlyConfigured
1010

1111
def create_object(request, app_label, module_name, template_name=None,
12-
template_loader=loader, extra_context={},
13-
post_save_redirect=None, login_required=False, follow=None):
12+
template_loader=loader, extra_context={}, post_save_redirect=None,
13+
login_required=False, follow=None, context_processors=None):
1414
"""
1515
Generic object-creation function.
1616
@@ -60,9 +60,9 @@ def create_object(request, app_label, module_name, template_name=None,
6060
if not template_name:
6161
template_name = "%s/%s_form" % (app_label, module_name)
6262
t = template_loader.get_template(template_name)
63-
c = Context(request, {
64-
'form' : form,
65-
})
63+
c = DjangoContext(request, {
64+
'form': form,
65+
}, context_processors)
6666
for key, value in extra_context.items():
6767
if callable(value):
6868
c[key] = value()
@@ -71,9 +71,9 @@ def create_object(request, app_label, module_name, template_name=None,
7171
return HttpResponse(t.render(c))
7272

7373
def update_object(request, app_label, module_name, object_id=None, slug=None,
74-
slug_field=None, template_name=None, template_loader=loader,
75-
extra_lookup_kwargs={}, extra_context={}, post_save_redirect=None,
76-
login_required=False, follow=None):
74+
slug_field=None, template_name=None, template_loader=loader,
75+
extra_lookup_kwargs={}, extra_context={}, post_save_redirect=None,
76+
login_required=False, follow=None, context_processors=None):
7777
"""
7878
Generic object-update function.
7979
@@ -131,10 +131,10 @@ def update_object(request, app_label, module_name, object_id=None, slug=None,
131131
if not template_name:
132132
template_name = "%s/%s_form" % (app_label, module_name)
133133
t = template_loader.get_template(template_name)
134-
c = Context(request, {
135-
'form' : form,
136-
'object' : object,
137-
})
134+
c = DjangoContext(request, {
135+
'form': form,
136+
'object': object,
137+
}, context_processors)
138138
for key, value in extra_context.items():
139139
if callable(value):
140140
c[key] = value()
@@ -145,9 +145,9 @@ def update_object(request, app_label, module_name, object_id=None, slug=None,
145145
return response
146146

147147
def delete_object(request, app_label, module_name, post_delete_redirect,
148-
object_id=None, slug=None, slug_field=None, template_name=None,
149-
template_loader=loader, extra_lookup_kwargs={},
150-
extra_context={}, login_required=False):
148+
object_id=None, slug=None, slug_field=None, template_name=None,
149+
template_loader=loader, extra_lookup_kwargs={}, extra_context={},
150+
login_required=False, context_processors=None):
151151
"""
152152
Generic object-delete function.
153153
@@ -188,9 +188,9 @@ def delete_object(request, app_label, module_name, post_delete_redirect,
188188
if not template_name:
189189
template_name = "%s/%s_confirm_delete" % (app_label, module_name)
190190
t = template_loader.get_template(template_name)
191-
c = Context(request, {
192-
'object' : object,
193-
})
191+
c = DjangoContext(request, {
192+
'object': object,
193+
}, context_processors)
194194
for key, value in extra_context.items():
195195
if callable(value):
196196
c[key] = value()
@@ -199,4 +199,3 @@ def delete_object(request, app_label, module_name, post_delete_redirect,
199199
response = HttpResponse(t.render(c))
200200
populate_xheaders(request, response, app_label, module_name, getattr(object, object._meta.pk.name))
201201
return response
202-

‎django/views/generic/date_based.py‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
from django.core.template import loader
22
from django.core.exceptions import Http404, ObjectDoesNotExist
3-
from django.core.extensions import DjangoContext as Context
3+
from django.core.extensions import DjangoContext
44
from django.core.xheaders import populate_xheaders
55
from django.models import get_module
66
from django.utils.httpwrappers import HttpResponse
77
import datetime, time
88

99
def archive_index(request, app_label, module_name, date_field, num_latest=15,
10-
template_name=None, template_loader=loader,
11-
extra_lookup_kwargs={}, extra_context={}, allow_empty=False):
10+
template_name=None, template_loader=loader, extra_lookup_kwargs={},
11+
extra_context={}, allow_empty=False, context_processors=None):
1212
"""
1313
Generic top-level archive of date-based objects.
1414
@@ -38,10 +38,10 @@ def archive_index(request, app_label, module_name, date_field, num_latest=15,
3838
if not template_name:
3939
template_name = "%s/%s_archive" % (app_label, module_name)
4040
t = template_loader.get_template(template_name)
41-
c = Context(request, {
41+
c = DjangoContext(request, {
4242
'date_list' : date_list,
4343
'latest' : latest,
44-
})
44+
}, context_processors)
4545
for key, value in extra_context.items():
4646
if callable(value):
4747
c[key] = value()
@@ -50,8 +50,8 @@ def archive_index(request, app_label, module_name, date_field, num_latest=15,
5050
return HttpResponse(t.render(c))
5151

5252
def archive_year(request, year, app_label, module_name, date_field,
53-
template_name=None, template_loader=loader,
54-
extra_lookup_kwargs={}, extra_context={}):
53+
template_name=None, template_loader=loader, extra_lookup_kwargs={},
54+
extra_context={}, context_processors=None):
5555
"""
5656
Generic yearly archive view.
5757
@@ -75,10 +75,10 @@ def archive_year(request, year, app_label, module_name, date_field,
7575
if not template_name:
7676
template_name = "%s/%s_archive_year" % (app_label, module_name)
7777
t = template_loader.get_template(template_name)
78-
c = Context(request, {
78+
c = DjangoContext(request, {
7979
'date_list': date_list,
8080
'year': year,
81-
})
81+
}, context_processors)
8282
for key, value in extra_context.items():
8383
if callable(value):
8484
c[key] = value()
@@ -87,8 +87,8 @@ def archive_year(request, year, app_label, module_name, date_field,
8787
return HttpResponse(t.render(c))
8888

8989
def archive_month(request, year, month, app_label, module_name, date_field,
90-
month_format='%b', template_name=None, template_loader=loader,
91-
extra_lookup_kwargs={}, extra_context={}):
90+
month_format='%b', template_name=None, template_loader=loader,
91+
extra_lookup_kwargs={}, extra_context={}, context_processors=None):
9292
"""
9393
Generic monthly archive view.
9494
@@ -123,10 +123,10 @@ def archive_month(request, year, month, app_label, module_name, date_field,
123123
if not template_name:
124124
template_name = "%s/%s_archive_month" % (app_label, module_name)
125125
t = template_loader.get_template(template_name)
126-
c = Context(request, {
126+
c = DjangoContext(request, {
127127
'object_list': object_list,
128128
'month': date,
129-
})
129+
}, context_processors)
130130
for key, value in extra_context.items():
131131
if callable(value):
132132
c[key] = value()
@@ -135,9 +135,9 @@ def archive_month(request, year, month, app_label, module_name, date_field,
135135
return HttpResponse(t.render(c))
136136

137137
def archive_day(request, year, month, day, app_label, module_name, date_field,
138-
month_format='%b', day_format='%d', template_name=None,
139-
template_loader=loader, extra_lookup_kwargs={},
140-
extra_context={}, allow_empty=False):
138+
month_format='%b', day_format='%d', template_name=None,
139+
template_loader=loader, extra_lookup_kwargs={}, extra_context={},
140+
allow_empty=False, context_processors=None):
141141
"""
142142
Generic daily archive view.
143143
@@ -172,12 +172,12 @@ def archive_day(request, year, month, day, app_label, module_name, date_field,
172172
if not template_name:
173173
template_name = "%s/%s_archive_day" % (app_label, module_name)
174174
t = template_loader.get_template(template_name)
175-
c = Context(request, {
175+
c = DjangoContext(request, {
176176
'object_list': object_list,
177177
'day': date,
178178
'previous_day': date - datetime.timedelta(days=1),
179179
'next_day': (date < datetime.date.today()) and (date + datetime.timedelta(days=1)) or None,
180-
})
180+
}, context_processors)
181181
for key, value in extra_context.items():
182182
if callable(value):
183183
c[key] = value()
@@ -198,10 +198,10 @@ def archive_today(request, **kwargs):
198198
return archive_day(request, **kwargs)
199199

200200
def object_detail(request, year, month, day, app_label, module_name, date_field,
201-
month_format='%b', day_format='%d', object_id=None, slug=None,
202-
slug_field=None, template_name=None, template_name_field=None,
203-
template_loader=loader, extra_lookup_kwargs={},
204-
extra_context={}):
201+
month_format='%b', day_format='%d', object_id=None, slug=None,
202+
slug_field=None, template_name=None, template_name_field=None,
203+
template_loader=loader, extra_lookup_kwargs={}, extra_context={},
204+
context_processors=None):
205205
"""
206206
Generic detail view from year/month/day/slug or year/month/day/id structure.
207207
@@ -241,9 +241,9 @@ def object_detail(request, year, month, day, app_label, module_name, date_field,
241241
t = template_loader.select_template(template_name_list)
242242
else:
243243
t = template_loader.get_template(template_name)
244-
c = Context(request, {
244+
c = DjangoContext(request, {
245245
'object': object,
246-
})
246+
}, context_processors)
247247
for key, value in extra_context.items():
248248
if callable(value):
249249
c[key] = value()

‎django/views/generic/list_detail.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
from django.core.template import loader
33
from django.utils.httpwrappers import HttpResponse
44
from django.core.xheaders import populate_xheaders
5-
from django.core.extensions import DjangoContext as Context
5+
from django.core.extensions import DjangoContext
66
from django.core.paginator import ObjectPaginator, InvalidPage
77
from django.core.exceptions import Http404, ObjectDoesNotExist
88

99
def object_list(request, app_label, module_name, paginate_by=None, allow_empty=False,
10-
template_name=None, template_loader=loader,
11-
extra_lookup_kwargs={}, extra_context={}):
10+
template_name=None, template_loader=loader, extra_lookup_kwargs={},
11+
extra_context={}, context_processors=None):
1212
"""
1313
Generic list of objects.
1414
@@ -48,7 +48,7 @@ def object_list(request, app_label, module_name, paginate_by=None, allow_empty=F
4848
else:
4949
raise Http404
5050
page = int(page)
51-
c = Context(request, {
51+
c = DjangoContext(request, {
5252
'object_list': object_list,
5353
'is_paginated': paginator.pages > 1,
5454
'results_per_page': paginate_by,
@@ -59,13 +59,13 @@ def object_list(request, app_label, module_name, paginate_by=None, allow_empty=F
5959
'previous': page - 1,
6060
'pages': paginator.pages,
6161
'hits' : paginator.hits,
62-
})
62+
}, context_processors)
6363
else:
6464
object_list = mod.get_list(**lookup_kwargs)
65-
c = Context(request, {
65+
c = DjangoContext(request, {
6666
'object_list': object_list,
6767
'is_paginated': False
68-
})
68+
}, context_processors)
6969
if len(object_list) == 0 and not allow_empty:
7070
raise Http404
7171
for key, value in extra_context.items():
@@ -79,9 +79,9 @@ def object_list(request, app_label, module_name, paginate_by=None, allow_empty=F
7979
return HttpResponse(t.render(c))
8080

8181
def object_detail(request, app_label, module_name, object_id=None, slug=None,
82-
slug_field=None, template_name=None, template_name_field=None,
83-
template_loader=loader, extra_lookup_kwargs={},
84-
extra_context={}):
82+
slug_field=None, template_name=None, template_name_field=None,
83+
template_loader=loader, extra_lookup_kwargs={}, extra_context={},
84+
context_processors=None):
8585
"""
8686
Generic list of objects.
8787
@@ -110,9 +110,9 @@ def object_detail(request, app_label, module_name, object_id=None, slug=None,
110110
t = template_loader.select_template(template_name_list)
111111
else:
112112
t = template_loader.get_template(template_name)
113-
c = Context(request, {
113+
c = DjangoContext(request, {
114114
'object': object,
115-
})
115+
}, context_processors)
116116
for key, value in extra_context.items():
117117
if callable(value):
118118
c[key] = value()

0 commit comments

Comments
 (0)