Changeset 1379

Timestamp:

11/23/05 17:10:17 (2 years ago)

Author:

adrian

Message:

Fixed #603 -- Added template debugging errors to pretty error-page output, if TEMPLATE_DEBUG setting is True. Also refactored FilterParser? for a significant speed increase and changed the template_loader interface so that it returns information about the loader. Taken from new-admin. Thanks rjwittams and crew

Files:

• django/trunk/django/conf/global_settings.py (modified) (1 diff)
• django/trunk/django/conf/project_template/settings.py (modified) (1 diff)
• django/trunk/django/core/template/defaulttags.py (modified) (2 diffs)
• django/trunk/django/core/template/__init__.py (modified) (13 diffs)
• django/trunk/django/core/template/loader.py (modified) (8 diffs)
• django/trunk/django/core/template/loaders/app_directories.py (modified) (1 diff)
• django/trunk/django/core/template/loaders/eggs.py (modified) (1 diff)
• django/trunk/django/core/template/loaders/filesystem.py (modified) (1 diff)
• django/trunk/django/views/debug.py (modified) (7 diffs)
• django/trunk/tests/othertests/templates.py (modified) (4 diffs)

django/trunk/django/conf/global_settings.py

@@ -9 +9 @@
-
-DEBUG = False
+TEMPLATE_DEBUG = False
-
-# Whether to use the "Etag" header. This saves bandwidth but slows down performance.

django/trunk/django/conf/project_template/settings.py

@@ -2 +2 @@
-
-DEBUG = True
+TEMPLATE_DEBUG = DEBUG
-
-ADMINS = (

django/trunk/django/core/template/defaulttags.py

@@ -193 +193 @@
-            grouper = resolve_variable_with_filters('var.%s' % self.expression, \
-                Context({'var': obj}))
+            # TODO: Is this a sensible way to determine equality?
-            if output and repr(output[-1]['grouper']) == repr(grouper):
-                output[-1]['list'].append(obj)
@@ -629 +630 @@
-    try:
-        LoadNode.load_taglib(taglib)
-
-" % taglib
+, e
+: %s" % (taglib, e)
-    return LoadNode(taglib)
-

django/trunk/django/core/template/__init__.py

@@ -56 +56 @@
-"""
-import re
-
+, TEMPLATE_DEBUG
-
-__all__ = ('Template','Context','compile_string')
@@ -75 +75 @@
-ALLOWED_VARIABLE_CHARS = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.'
-
+# what to report as the origin for templates that come from non-loader sources
+# (e.g. strings)
+UNKNOWN_SOURCE="<unknown source>"
+
-# match a variable or block tag and capture the entire tag, including start/end delimiters
-tag_re = re.compile('(%s.*?%s|%s.*?%s)' % (re.escape(BLOCK_TAG_START), re.escape(BLOCK_TAG_END),
@@ -102 +106 @@
-    pass
-
+class Origin(object):
+    def __init__(self, name):
+        self.name = name
+
+    def reload(self):
+        raise NotImplementedException
+
+    def __str__(self):
+        return self.name
+
+class StringOrigin(Origin):
+    def __init__(self, source):
+        super(StringOrigin, self).__init__(UNKNOWN_SOURCE)
+        self.source = source
+
+    def reload(self):
+        return self.source
+
-class Template:
-
+, origin=None
-        "Compilation stage"
-
+
+
+
+
+
-
-    def __iter__(self):
@@ -116 +142 @@
-        return self.nodelist.render(context)
-
-
+, origin
-    "Compiles template_string into NodeList ready for rendering"
-tokens = tokenize(template_string
-Parser(tokens
+lexer = lexer_factory(template_string, origin
+parser_factory(lexer.tokenize()
-    return parser.parse()
-
@@ -164 +190 @@
-        return False
-
+    def get(self, key, otherwise):
+        for dict in self.dicts:
+            if dict.has_key(key):
+                return dict[key]
+        return otherwise
+
-    def update(self, other_dict):
-        "Like dict.update(). Pushes an entire dictionary's keys and values onto the context."
@@ -175 +207 @@
-    def __str__(self):
-        return '<%s token: "%s...">' % (
-'Text', TOKEN_VAR:'Var', TOKEN_BLOCK:
+ 'Text', TOKEN_VAR: 'Var', TOKEN_BLOCK: 
-            self.contents[:20].replace('\n', '')
-            )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def __init__(self, tokens):
-        self.tokens = tokens
-
-    def parse(self, parse_until=[]):
-NodeL
+self.create_nodel
-        while self.tokens:
-            token = self.next_token()
-            if token.token_type == TOKEN_TEXT:
-nodelist.append(TextNode(token.contents)
+self.extend_nodelist(nodelist, TextNode(token.contents), token
-            elif token.token_type == TOKEN_VAR:
-                if not token.contents:
-
-
+
+
+
-            elif token.token_type == TOKEN_BLOCK:
-                if token.contents in parse_until:
@@ -216 +285 @@
-                    command = token.contents.split()[0]
-                except IndexError:
-
+
+
+
-                try:
-
-
+
-                except KeyError:
-
+
+
+
+
+
+
+
+
-        if parse_until:
-raise TemplateSyntaxError, "Unclosed tag(s): '%s'" % ', '.join
+self.unclosed_block_tag
-        return nodelist
+
+    def create_variable_node(self, contents):
+        return VariableNode(contents)
+
+    def create_nodelist(self):
+        return NodeList()
+
+    def extend_nodelist(self, nodelist, node, token):
+        nodelist.append(node)
+
+    def enter_command(self, command, token):
+        pass
+
+    def exit_command(self):
+        pass
+
+    def error(self, token, msg ):
+        return TemplateSyntaxError(msg)
+
+    def empty_variable(self, token):
+        raise self.error( token, "Empty variable tag")
+
+    def empty_block_tag(self, token):
+        raise self.error( token, "Empty block tag")
+
+    def invalid_block_tag(self, token, command):
+        raise self.error( token, "Invalid block tag: '%s'" % command)
+
+    def unclosed_block_tag(self, parse_until):
+        raise self.error(None, "Unclosed tags: %s " %  ', '.join(parse_until))
+
+    def compile_function_error(self, token, e):
+        pass
-
-    def next_token(self):
@@ -234 +344 @@
-    def delete_first_token(self):
-        del self.tokens[0]
+
+class DebugParser(Parser):
+    def __init__(self, lexer):
+        super(DebugParser, self).__init__(lexer)
+        self.command_stack = []
+
+    def enter_command(self, command, token):
+        self.command_stack.append( (command, token.source) )
+
+    def exit_command(self):
+        self.command_stack.pop()
+
+    def error(self, token, msg):
+        return self.source_error(token.source, msg)
+
+    def source_error(self, source,msg):
+        e = TemplateSyntaxError(msg)
+        e.source = source
+        return e
+
+    def create_nodelist(self):
+        return DebugNodeList()
+
+    def create_variable_node(self, contents):
+        return DebugVariableNode(contents)
+
+    def extend_nodelist(self, nodelist, node, token):
+        node.source = token.source
+        super(DebugParser, self).extend_nodelist(nodelist, node, token)
+
+    def unclosed_block_tag(self, parse_until):
+        (command, source) = self.command_stack.pop()
+        msg = "Unclosed tag '%s'. Looking for one of: %s " % (command, ', '.join(parse_until))
+        raise self.source_error( source, msg)
+
+    def compile_function_error(self, token, e):
+        if not hasattr(e, 'source'):
+            e.source = token.source
+
+if TEMPLATE_DEBUG:
+    lexer_factory = DebugLexer
+    parser_factory = DebugParser
+else:
+    lexer_factory = Lexer
+    parser_factory = Parser
-
-class TokenParser:
@@ -317 +472 @@
-            return s
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    """
-    Parses a variable token and its optional filters (all as a single string),
@@ -332 +514 @@
-    get_filters_from_token helper function.
-    """
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-def get_filters_from_token(token):
@@ -581 +646 @@
-        for node in self:
-            if isinstance(node, Node):
-node.render(
+self.render_node(node, 
-            else:
-                bits.append(node)
@@ -593 +658 @@
-        return nodes
-
+    def render_node(self, node, context):
+        return(node.render(context))
+
+class DebugNodeList(NodeList):
+    def render_node(self, node, context):
+        try:
+            result = node.render(context)
+        except TemplateSyntaxError, e:
+            if not hasattr(e, 'source'):
+                e.source = node.source
+            raise
+        except Exception:
+            from sys import exc_info
+            wrapped = TemplateSyntaxError('Caught an exception while rendering.')
+            wrapped.source = node.source
+            wrapped.exc_info = exc_info()
+            raise wrapped
+        return result
+
-class TextNode(Node):
-    def __init__(self, s):
@@ -610 +694 @@
-        return "<Variable Node: %s>" % self.var_string
-
+    def encode_output(self, output):
+        # Check type so that we don't run str() on a Unicode object
+        if not isinstance(output, basestring):
+            return str(output)
+        elif isinstance(output, unicode):
+            return output.encode(DEFAULT_CHARSET)
+        else:
+            return output
+
-    def render(self, context):
-        output = resolve_variable_with_filters(self.var_string, context)
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-def register_tag(token_command, callback_function):

django/trunk/django/core/template/loader.py

@@ -8 +8 @@
-# name is the template name.
-# dirs is an optional list of directories to search instead of TEMPLATE_DIRS.
+#
+# The loader should return a tuple of (template_source, path). The path returned
+# might be shown to the user for debugging purposes, so it should identify where
+# the template was loaded from.
-#
-# Each loader should have an "is_usable" attribute set. This is a boolean that
@@ -18 +22 @@
-
-from django.core.exceptions import ImproperlyConfigured
-
-
+Origin, StringOrigin, 
+, TEMPLATE_DEBUG
-
-template_source_loaders = []
@@ -39 +43 @@
-        template_source_loaders.append(func)
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    for loader in template_source_loaders:
-        try:
-
+
+
-        except TemplateDoesNotExist:
-            pass
-    raise TemplateDoesNotExist, name
-
+def load_template_source(name, dirs=None):
+    find_template_source(name, dirs)[0]
+
-class ExtendsError(Exception):
-    pass
@@ -55 +77 @@
-    handling template inheritance recursively.
-    """
-loa
-
-
+*fin
+
+, origin=None 
-    """
-    Returns a compiled Template object for the given template code,
-    handling template inheritance recursively.
-    """
-
+, origin
-
-def render_to_string(template_name, dictionary=None, context_instance=None):
@@ -135 +157 @@
-            raise TemplateSyntaxError, error_msg
-        try:
-loa
+*fin
-        except TemplateDoesNotExist:
-            raise TemplateSyntaxError, "Template %r cannot be extended, because it doesn't exist" % parent
@@ -166 +188 @@
-            t = get_template(template_path)
-            self.template = t
-
+
+
+
-            self.template = None
-
@@ -184 +208 @@
-             t = get_template(template_name)
-             return t.render(context)
+         except TemplateSyntaxError, e:
+             if TEMPLATE_DEBUG:
+                 raise
+             return ''
-         except:
-             return '' # Fail silently for invalid included templates.
@@ -237 +265 @@
-        {% include "foo/some_include" %}
-    """
+
-    bits = token.contents.split()
-    if len(bits) != 2:

django/trunk/django/core/template/loaders/app_directories.py

@@ -32 +32 @@
-        filepath = os.path.join(template_dir, template_name) + TEMPLATE_FILE_EXTENSION
-        try:
-open(filepath).read(
+(open(filepath).read(), filepath
-        except IOError:
-            pass

django/trunk/django/core/template/loaders/eggs.py

@@ -19 +19 @@
-        for app in INSTALLED_APPS:
-            try:
-resource_string(app, pkg_name
+(resource_string(app, pkg_name), 'egg:%s:%s ' % (app, pkg_name)
-            except:
-                pass

django/trunk/django/core/template/loaders/filesystem.py

@@ -12 +12 @@
-        filepath = os.path.join(template_dir, template_name) + TEMPLATE_FILE_EXTENSION
-        try:
-open(filepath).read(
+(open(filepath).read(), filepath
-        except IOError:
-            tried.append(filepath)

django/trunk/django/views/debug.py

@@ -1 @@
-import re
-import os
-import sys
-import inspect
-from django.conf import settings
+from django.core.template import Template, Context
+from django.utils.html import escape
+from django.utils.httpwrappers import HttpResponseServerError, HttpResponseNotFound
+import inspect, os, re, sys
+from itertools import count, izip
-from os.path import dirname, join as pathjoin
-from django.core.template import Template, Context
-from django.utils.httpwrappers import HttpResponseServerError, HttpResponseNotFound
-
-HIDDEN_SETTINGS = re.compile('SECRET|PASSWORD')
+
+def linebreak_iter(template_source):
+    newline_re = re.compile("^", re.M)
+    for match in newline_re.finditer(template_source):
+        yield match.start()
+    yield len(template_source) + 1
+
+def get_template_exception_info(exc_type, exc_value, tb):
+    origin, (start, end) = exc_value.source
+    template_source = origin.reload()
+    context_lines = 10
+    line = 0
+    upto = 0
+    source_lines = []
+    linebreaks = izip(count(0), linebreak_iter(template_source))
+    linebreaks.next() # skip the nothing before initial line start
+    for num, next in linebreaks:
+        if start >= upto and end <= next:
+            line = num
+            before = escape(template_source[upto:start])
+            during = escape(template_source[start:end])
+            after = escape(template_source[end:next - 1])
+        source_lines.append( (num, escape(template_source[upto:next - 1])) )
+        upto = next
+    total = len(source_lines)
+
+    top = max(0, line - context_lines)
+    bottom = min(total, line + 1 + context_lines)
+
+    template_info = {
+        'message': exc_value.args[0],
+        'source_lines': source_lines[top:bottom],
+        'before': before,
+        'during': during,
+        'after': after,
+        'top': top ,
+        'bottom': bottom ,
+        'total': total,
+        'line': line,
+        'name': origin.name,
+    }
+    exc_info = hasattr(exc_value, 'exc_info') and exc_value.exc_info or (exc_type, exc_value, tb)
+    return exc_info + (template_info,)
-
-def technical_500_response(request, exc_type, exc_value, tb):
@@ -15 +57 @@
-    the values returned from sys.exc_info() and friends.
-    """
+    template_info = None
+    if settings.TEMPLATE_DEBUG and hasattr(exc_value, 'source'):
+        exc_type, exc_value, tb, template_info = get_template_exception_info(exc_type, exc_value, tb)
-    frames = []
-    while tb is not None:
@@ -22 +67 @@
-        pre_context_lineno, pre_context, context_line, post_context = _get_lines_from_file(filename, lineno, 7)
-        frames.append({
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+
+
+
+
+
+
+
+
+
+
-        })
-        tb = tb.tb_next
@@ -47 +92 @@
-    t = Template(TECHNICAL_500_TEMPLATE)
-    c = Context({
- 
- 
- 
- 
- 
- 
- 
-
+
+
+
+
+
+
+
+
-    })
-    return HttpResponseServerError(t.render(c), mimetype='text/html')
@@ -70 +115 @@
-    t = Template(TECHNICAL_404_TEMPLATE)
-    c = Context({
- 
- 
- 
- 
- 
- 
+
+
+
+
+
+
-    })
-    return HttpResponseNotFound(t.render(c), mimetype='text/html')
@@ -145 +190 @@
-    #requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
-    #requestinfo h3 { margin-bottom:-1em; }
+    table.source td { font-family: monospace; white-space: pre; }
+    span.specific { background:#ffcab7; }
+    .error { background: #ffc; }
-  </style>
-  <script type="text/javascript">
@@ -222 +270 @@
-  </table>
-</div>
-
+
+
+
+
+
+
+