Merge branch 'master' of https://github.com/django-debug-toolbar/django-debug-toolbar into sql-panel-refactor

nuklea · nuklea · commit 4c1c4f7a8873 · 2013-04-24T15:54:17.000+08:00
Conflicts:
	debug_toolbar/static/debug_toolbar/css/toolbar.min.css
	debug_toolbar/views.py
diff --git a/.travis.yml b/.travis.yml
@@ -3,8 +3,9 @@ python:
   - "2.6"
   - "2.7"
 env:
-  - DJANGO_VERSION=1.3.1
-  - DJANGO_VERSION=1.4
+  - DJANGO_VERSION=1.3.7
+  - DJANGO_VERSION=1.4.5
+  - DJANGO_VERSION=1.5
 install:
   - pip install Django==$DJANGO_VERSION
   - python setup.py install
diff --git a/Makefile b/Makefile
@@ -1,6 +1,10 @@
 # Make file to compress and join all JS files
 all: compress_js compress_css
 
+test:
+	pip install Django
+	python runtests.py
+
 compress_js:
 	java -jar ~/bin/yuicompressor.jar debug_toolbar/static/debug_toolbar/js/jquery.js > debug_toolbar/static/debug_toolbar/js/toolbar.min.js
 	java -jar ~/bin/yuicompressor.jar debug_toolbar/static/debug_toolbar/js/toolbar.js >> debug_toolbar/static/debug_toolbar/js/toolbar.min.js
diff --git a/README.rst b/README.rst
@@ -29,7 +29,7 @@ There is also one Django management command currently:
 
 If you have ideas for other panels please let us know.
 
-* Note: The Debug Toolbar only works on Django 1.2 and newer.
+* Note: The Debug Toolbar only works on Django 1.3 and newer.
 
 Installation
 ============
diff --git a/debug_toolbar/middleware.py b/debug_toolbar/middleware.py
@@ -119,7 +119,7 @@ def process_response(self, request, response):
         if not toolbar or request.is_ajax():
             return response
         if isinstance(response, HttpResponseRedirect):
-            if not toolbar.config['INTERCEPT_REDIRECTS']:
+            if not toolbar.config['INTERCEPT_REDIRECTS'] or request.is_ajax():
                 return response
             redirect_to = response.get('Location', None)
             if redirect_to:
diff --git a/debug_toolbar/panels/template.py b/debug_toolbar/panels/template.py
@@ -6,7 +6,7 @@
 from django.template.context import get_standard_processors
 from django.test.signals import template_rendered
 from django.utils.translation import ugettext_lazy as _
-from django.db.models.query import QuerySet
+from django.db.models.query import QuerySet, RawQuerySet
 from debug_toolbar.panels import DebugPanel
 from debug_toolbar.utils.tracking.db import recording, SQLQueryTriggered
 
@@ -76,9 +76,9 @@ def _store_template_info(self, sender, **kwargs):
                     elif key == 'LANGUAGES' and isinstance(value, tuple):
                         temp_layer[key] = '<<languages>>'
                     # QuerySet would trigger the database: user can run the query from SQL Panel
-                    elif isinstance(value, QuerySet):
+                    elif isinstance(value, (QuerySet, RawQuerySet)):
                         model_name = "%s.%s" % (value.model._meta.app_label, value.model.__name__)
-                        temp_layer[key] = '<<queryset of %s>>' % model_name
+                        temp_layer[key] = '<<%s of %s>>' % (value.__class__.__name__.lower(), model_name)
                     else:
                         try:
                             recording(False)
diff --git a/debug_toolbar/static/debug_toolbar/css/toolbar.css b/debug_toolbar/static/debug_toolbar/css/toolbar.css
diff --git a/debug_toolbar/urls.py b/debug_toolbar/urls.py
@@ -4,7 +4,10 @@
 These should not be loaded explicitly; the debug toolbar middleware will patch
 this into the urlconf for the request.
 """
-from django.conf.urls.defaults import *
+try:
+    from django.conf.urls import patterns, url
+except ImportError: # django < 1.4
+    from django.conf.urls.defaults import patterns, url
 
 _PREFIX = '__debug__'
 
diff --git a/debug_toolbar/utils/__init__.py b/debug_toolbar/utils/__init__.py
@@ -56,9 +56,15 @@ def render_stacktrace(trace):
     stacktrace = []
     for frame in trace:
         params = map(escape, frame[0].rsplit(os.path.sep, 1) + list(frame[1:]))
+        params_dict = dict((unicode(idx), v) for idx, v in enumerate(params))
         try:
-            stacktrace.append(u'<span class="path">{0}/</span><span class="file">{1}</span> in <span class="func">{3}</span>(<span class="lineno">{2}</span>)\n  <span class="code">{4}</span>'.format(*params))
-        except IndexError:
+            stacktrace.append(u'<span class="path">%(0)s/</span>'
+                              u'<span class="file">%(1)s</span>'
+                              u' in <span class="func">%(3)s</span>'
+                              u'(<span class="lineno">%(2)s</span>)\n'
+                              u'  <span class="code">%(4)s</span>'
+                              % params_dict)
+        except KeyError:
             # This frame doesn't have the expected format, so skip it and move on to the next one
             continue
     return mark_safe('\n'.join(stacktrace))
diff --git a/debug_toolbar/utils/tracking/db.py b/debug_toolbar/utils/tracking/db.py
@@ -5,16 +5,20 @@
 
 from django.conf import settings
 from django.template import Node
-from django.utils import simplejson
 from django.utils.encoding import force_unicode, smart_str
 
 from debug_toolbar.utils import ms_from_timedelta, tidy_stacktrace, \
                                 get_template_info, get_stack
 from debug_toolbar.utils.compat.db import connections
 
+try:
+    import json
+except ImportError: # python < 2.6
+    from django.utils import simplejson as json
+
 try:
     from hashlib import sha1
-except ImportError:
+except ImportError: # python < 2.5
     from django.utils.hashcompat import sha_constructor as sha1
 
 # TODO:This should be set in the toolbar loader as a default and panels should
@@ -87,12 +91,25 @@ def _quote_params(self, params):
                             for key, value in params.iteritems())
         return map(self._quote_expr, params)
 
+    def _decode(self, param):
+        try:
+            return force_unicode(param, strings_only=True)
+        except UnicodeDecodeError:
+            return '(encoded string)'
+
     def execute(self, sql, params=()):
-        __traceback_hide__ = True
         start = datetime.now()
         try:
             return self.cursor.execute(sql, params)
         finally:
+            # FIXME: Sometimes connections which are not in the connections
+            # dict are used (for example in test database destroying).
+            # The code below (at least get_transaction_id(alias) needs to have
+            # the connection in the connections dict. It would be good to
+            # not have this requirement at all, but for now lets just skip
+            # these connections.
+            if self.db.alias not in connections:
+                return
             stop = datetime.now()
             duration = ms_from_timedelta(stop - start)
             enable_stacktraces = getattr(settings,
@@ -103,10 +120,8 @@ def execute(self, sql, params=()):
                 stacktrace = []
             _params = ''
             try:
-                _params = simplejson.dumps(
-                        [force_unicode(x, strings_only=True) for x in params]
-                            )
-            except TypeError:
+                _params = json.dumps(map(self._decode, params))
+            except Exception:
                 pass  # object not JSON serializable
 
             template_info = None
@@ -124,7 +139,7 @@ def execute(self, sql, params=()):
             del cur_frame
 
             alias = getattr(self.db, 'alias', 'default')
-            conn = connections[alias].connection
+            conn = self.db.connection
             # HACK: avoid imports
             if conn:
                 engine = conn.__class__.__module__.split('.', 1)[0]
@@ -148,11 +163,17 @@ def execute(self, sql, params=()):
             }
 
             if engine == 'psycopg2':
-                from psycopg2.extensions import TRANSACTION_STATUS_INERROR
+                # If an erroneous query was ran on the connection, it might
+                # be in a state where checking isolation_level raises an
+                # exception.
+                try:
+                    iso_level = conn.isolation_level
+                except conn.InternalError:
+                    iso_level = 'unknown'
                 params.update({
                     'trans_id': self.logger.get_transaction_id(alias),
                     'trans_status': conn.get_transaction_status(),
-                    'iso_level': conn.isolation_level if not conn.get_transaction_status() == TRANSACTION_STATUS_INERROR else "",
+                    'iso_level': iso_level,
                     'encoding': conn.encoding,
                 })
 
diff --git a/debug_toolbar/views.py b/debug_toolbar/views.py
@@ -8,9 +8,14 @@
 from django.shortcuts import render_to_response
 from django.views.decorators.csrf import csrf_exempt
 
+try:
+    import json
+except ImportError: # python < 2.6
+    from django.utils import simplejson as json
+
 try:
     from hashlib import sha1
-except ImportError:
+except ImportError: # python < 2.5
     from django.utils.hashcompat import sha_constructor as sha1
 
 from debug_toolbar.forms import SQLSelectForm
@@ -58,6 +63,8 @@ def sql_explain(request):
             # EXPLAIN QUERY PLAN dumps a more human-readable summary
             # See http://www.sqlite.org/lang_explain.html for details
             cursor.execute("EXPLAIN QUERY PLAN %s" % (sql,), params)
+        elif engine == "psycopg2":
+            cursor.execute("EXPLAIN ANALYZE %s" % (sql,), params)
         else:
             cursor.execute("EXPLAIN %s" % (sql,), params)
 
diff --git a/example/urls.py b/example/urls.py
@@ -1,15 +1,15 @@
 from django.conf import settings
 from django.conf.urls.defaults import *
 from django.contrib import admin
-from django.views.generic.simple import direct_to_template
+from django.views.generic import TemplateView
 
 admin.autodiscover()
 
 urlpatterns = patterns('',
-    (r'^$', direct_to_template, {'template': 'index.html'}),
-    (r'^jquery/index/$', direct_to_template, {'template': 'jquery/index.html'}),
-    (r'^mootools/index/$', direct_to_template, {'template': 'mootools/index.html'}),
-    (r'^prototype/index/$', direct_to_template, {'template': 'prototype/index.html'}),
+    (r'^$', TemplateView.as_view(template_name='index.html')),
+    (r'^jquery/index/$', TemplateView.as_view(template_name='jquery/index.html')),
+    (r'^mootools/index/$', TemplateView.as_view(template_name='mootools/index.html')),
+    (r'^prototype/index/$', TemplateView.as_view(template_name='prototype/index.html')),
     (r'^admin/', include(admin.site.urls)),
 )
 
diff --git a/runtests.py b/runtests.py
@@ -1,11 +1,14 @@
 #!/usr/bin/env python
 import sys
+import os
 from os.path import dirname, abspath
 from optparse import OptionParser
 
 from django.conf import settings, global_settings
 
-if not settings.configured:
+# For convenience configure settings if they are not pre-configured or if we
+# haven't been provided settings to use by environment variable.
+if not settings.configured and not os.environ.get('DJANGO_SETTINGS_MODULE'):
     settings.configure(
         DATABASES={
             'default': {
diff --git a/test_pgsql.py b/test_pgsql.py
@@ -0,0 +1,28 @@
+from django.conf import global_settings
+DATABASES={
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        # Edit the below settings before use...
+        'USER': '',
+        'NAME': '',
+        'HOST': '',
+        'PASSWORD': '',
+    }
+}
+INSTALLED_APPS=[
+    'django.contrib.auth',
+    'django.contrib.admin',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+
+    'debug_toolbar',
+
+    'tests',
+]
+MIDDLEWARE_CLASSES=global_settings.MIDDLEWARE_CLASSES + (
+    'debug_toolbar.middleware.DebugToolbarMiddleware',
+)
+ROOT_URLCONF=''
+DEBUG=False
+SITE_ID=1
diff --git a/tests/tests.py b/tests/tests.py
@@ -1,10 +1,13 @@
+from __future__ import with_statement
 import thread
 
 from django.conf import settings
 from django.contrib.auth.models import User
+from django.db import connection
 from django.http import HttpResponse
 from django.test import TestCase, RequestFactory
 from django.template import Template, Context
+from django.utils import unittest
 
 from debug_toolbar.middleware import DebugToolbarMiddleware
 from debug_toolbar.panels.sql import SQLDebugPanel
@@ -214,6 +217,19 @@ def test_recording(self):
         # ensure the stacktrace is populated
         self.assertTrue(len(query[1]['stacktrace']) > 0)
 
+    @unittest.skipUnless(connection.vendor=='postgresql',
+                         'Test valid only on PostgreSQL')
+    def test_erroneous_query(self):
+        """
+        Test that an error in the query isn't swallowed by the middleware.
+        """
+        from django.db import connection
+        from django.db.utils import DatabaseError
+        try:
+            connection.cursor().execute("erroneous query")
+        except DatabaseError as e:
+            self.assertTrue('erroneous query' in str(e))
+
     def test_disable_stacktraces(self):
         panel = self.toolbar.get_panel(SQLDebugPanel)
         self.assertEquals(len(panel._queries), 0)
diff --git a/tests/urls.py b/tests/urls.py
@@ -4,14 +4,17 @@
 These should not be loaded explicitly; the debug toolbar middleware will patch
 this into the urlconf for the request.
 """
-from django.conf.urls.defaults import *
 from django.contrib import admin
+try:
+    from django.conf.urls import patterns, url
+except ImportError: # django < 1.4
+    from django.conf.urls.defaults import patterns, url
 
 admin.autodiscover()
 
 urlpatterns = patterns('',
     # This pattern should be last to ensure tests still work
-    url(r'^resolving1/(.+)/(.+)/$', 'tests.views.resolving_view', name = 'positional-resolving'),
+    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'),
