Skip to content

Resolving view name in Request Vars panel. #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions debug_toolbar/panels/request_vars.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
from debug_toolbar.panels import DebugPanel
from debug_toolbar.utils import get_name_from_obj

from django.core.urlresolvers import resolve
from django.http import Http404

class RequestVarsDebugPanel(DebugPanel):
"""
A panel to display request variables (POST/GET, session, cookies).
Expand All @@ -13,9 +16,6 @@ class RequestVarsDebugPanel(DebugPanel):

def __init__(self, *args, **kwargs):
DebugPanel.__init__(self, *args, **kwargs)
self.view_func = None
self.view_args = None
self.view_kwargs = None

def nav_title(self):
return _('Request Vars')
Expand All @@ -29,29 +29,33 @@ def url(self):
def process_request(self, request):
self.request = request

def process_view(self, request, view_func, view_args, view_kwargs):
self.view_func = view_func
self.view_args = view_args
self.view_kwargs = view_kwargs

def process_response(self, request, response):
self.record_stats({
'get': [(k, self.request.GET.getlist(k)) for k in self.request.GET],
'post': [(k, self.request.POST.getlist(k)) for k in self.request.POST],
'cookies': [(k, self.request.COOKIES.get(k)) for k in self.request.COOKIES],
})

if hasattr(self, 'view_func'):
if self.view_func is not None:
name = get_name_from_obj(self.view_func)
view_info = { }
view_info['view_func'] = '<no view>'
view_info['view_args'] = 'None'
view_info['view_kwargs'] = 'None'
view_info['view_urlname'] = 'None'

try:
match = resolve(self.request.path)
func, args, kwargs = match
view_info['view_func'] = get_name_from_obj(func)
view_info['view_args'] = args
view_info['view_kwargs'] = kwargs
if hasattr(match, 'url_name'): # Django >= 1.3
view_info['view_urlname'] = match.url_name
else:
name = '<no view>'

self.record_stats({
'view_func': name,
'view_args': self.view_args,
'view_kwargs': self.view_kwargs
})
view_info['view_urlname'] = '<unavailable>'
except Http404:
pass

self.record_stats(view_info)

if hasattr(self.request, 'session'):
self.record_stats({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ <h4>{% trans 'View information' %}</h4>
<thead>
<tr>
<th>{% trans 'View Function' %}</th>
<th>{% trans 'URL Name' %}</th>
<th>{% trans 'args' %}</th>
<th>{% trans 'kwargs' %}</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{ view_func }}</td>
<td>{{ view_urlname }}</td>
<td>{{ view_args|default:"None" }}</td>
<td>
{% if view_kwargs.items %}
Expand Down
57 changes: 34 additions & 23 deletions tests/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from django.http import HttpResponse
from django.test import TestCase
from django.template import Template, Context
from django import VERSION

from dingus import Dingus
import thread
Expand Down Expand Up @@ -147,31 +148,41 @@ def test_request_urlconf_module(self):
self.assertTrue(hasattr(request.urlconf.urlpatterns[1], '_callback_str'))
self.assertEquals(request.urlconf.urlpatterns[-1]._callback_str, 'tests.views.execute_sql')

def test_with_process_view(self):
request = self.request
response = self.response

def _test_view(request):
return HttpResponse('')

with Settings(DEBUG=True):
panel = self.toolbar.get_panel(RequestVarsDebugPanel)
panel.process_request(request)
panel.process_view(request, _test_view, [], {})
panel.process_response(request, response)
content = panel.content()
self.assertTrue('tests.tests._test_view' in content, content)

def test_without_process_view(self):
request = self.request
response = self.response

def _resolve_stats(self, path):
# takes stats from RequestVars panel
self.request.path = path
with Settings(DEBUG=True):
panel = self.toolbar.get_panel(RequestVarsDebugPanel)
panel.process_request(request)
panel.process_response(request, response)
content = panel.content()
self.assertTrue('&lt;no view&gt;' in content, content)
panel.process_request(self.request)
panel.process_response(self.request, self.response)
return self.toolbar.stats['requestvars']

def test_url_resolving_positional(self):
stats = self._resolve_stats('/resolving1/a/b/')
if tuple(VERSION[:2]) >= (1, 3):
self.assertEquals(stats['view_urlname'], 'positional-resolving') # Django >= 1.3
else:
self.assertEquals(stats['view_urlname'], '<unavailable>') # Django < 1.3
self.assertEquals(stats['view_func'], 'tests.views.resolving_view')
self.assertEquals(stats['view_args'], ('a', 'b') )
self.assertEquals(stats['view_kwargs'], { } )

def test_url_resolving_named(self):
stats = self._resolve_stats('/resolving2/a/b/')
self.assertEquals(stats['view_args'], tuple() )
self.assertEquals(stats['view_kwargs'], { 'arg1' : 'a', 'arg2' : 'b' })

def test_url_resolving_mixed(self):
stats = self._resolve_stats('/resolving3/a/')
self.assertEquals(stats['view_args'], ('a',) )
self.assertEquals(stats['view_kwargs'], { 'arg2' : 'default' } )

def test_url_resolving_bad(self):
stats = self._resolve_stats('/non-existing-url/')
self.assertEquals(stats['view_urlname'], 'None')
self.assertEquals(stats['view_args'], 'None')
self.assertEquals(stats['view_kwargs'], 'None')
self.assertEquals(stats['view_func'], '<no view>')

class DebugToolbarNameFromObjectTest(BaseTestCase):
def test_func(self):
Expand Down
3 changes: 3 additions & 0 deletions tests/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,8 @@

urlpatterns = patterns('',
# This pattern should be last to ensure tests still work
url(r'^resolving1/(.+)/(.+)/$', 'tests.views.resolving_view', name = 'positional-resolving'),
url(r'^resolving2/(?P<arg1>.+)/(?P<arg2>.+)/$', 'tests.views.resolving_view'),
url(r'^resolving3/(.+)/$', 'tests.views.resolving_view', { 'arg2' : 'default' }),
url(r'^execute_sql/$', 'tests.views.execute_sql'),
)
7 changes: 6 additions & 1 deletion tests/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@
def execute_sql(request):
list(User.objects.all())

return HttpResponse()
return HttpResponse()

def resolving_view(request, arg1, arg2):
# see test_url_resolving in tests.py
return HttpResponse()