Merge lp:~alecu/openobject-server/django-tracebacks into lp:openobject-server

[Alejandro J. Cura]

[Alejandro J. Cura (alecu)]

The code is inspired in Django's traceback.

[Christophe CHAUVET (christophe-chauvet)]

Hi

why i see this (os.environ["DJANGO_SETTINGS_MODULE"]) in the code

Does we installed django dependancies ?

Regards,

[Alejandro J. Cura (alecu)]

The prototype version of the code used to depend on Django's templating module, so that why that "os.environ" line was there. I've now removed it from the code, and cleaned up a few imports. Thanks Christophe!

[lp:~alecu/openobject-server/django-tracebacks]

1872. By Alejandro J. Cura <email address hidden> on 2009-11-10

clean up imports

[Christophe CHAUVET (christophe-chauvet)]

I think there is a license issue, the new license to the trunk branch are AGPLv3

Which license use by Dajngo project ?

[Alejandro J. Cura (alecu)]

Django's license [1] is the modified BSD license [2] (with no advertising clause)

From what I've researched, you can use BSD code in AGPL projects, but not the other way around: http://fi.am/entry/agplv3-explained/
So it's ok to use this module from OpenObject.

--
[1] http://code.djangoproject.com/browser/django/trunk/LICENSE
[2] http://www.opensource.org/licenses/bsd-license.php

[Antony Lesuisse (OpenERP) (al-openerp)]

I prefer that we stick to plain text default python traceback so this will never be merged.

review: Disapprove

Unmerged revisions

1872. By Alejandro J. Cura <email address hidden> on 2009-11-10

clean up imports

1871. By Alejandro J. Cura <email address hidden> on 2009-11-02

adapted django error template to openerp

=== added file 'bin/htmltraceback.py'
--- bin/htmltraceback.py	1970-01-01 00:00:00 +0000
+++ bin/htmltraceback.py	2009-11-10 14:04:09 +0000
@@ -0,0 +1,468 @@
+#
+# by Alejandro J. Cura - [e-mail]
+# based on Django's debug.py, copyright notice follows
+#
+# Copyright (c) Django Software Foundation and individual contributors.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+#     1. Redistributions of source code must retain the above copyright notice, 
+#        this list of conditions and the following disclaimer.
+#     
+#     2. Redistributions in binary form must reproduce the above copyright 
+#        notice, this list of conditions and the following disclaimer in the
+#        documentation and/or other materials provided with the distribution.
+# 
+#     3. Neither the name of Django nor the names of its contributors may be used
+#        to endorse or promote products derived from this software without
+#        specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import re
+import cgi
+import traceback
+import string
+import pprint
+import datetime
+
+UNICODE_HINT_TEMPLATE = """
+<div id="unicode-hint">
+    <h2>Unicode error hint</h2>
+    <p>The string that could not be encoded/decoded was: <strong>${hint}</strong></p>
+</div>
+"""
+
+FRAME_LINE_TEMPLATE = """
+                <li onclick="toggle('pre${id}', 'post${id}')">${line}</li>"""
+
+FRAME_PRE_HTML = """
+              <ol start="${pre_context_lineno}" class="pre-context" id="pre${id}">${pre_lines_html}
+              </ol>
+"""
+
+FRAME_POST_HTML = """
+              <ol start="${post_context_lineno}" class="post-context" id="post${id}">${post_lines_html}
+              </ol>
+"""
+
+FRAME_CONTEXT_TEMPLATE = """
+            <div class="context" id="c${id}">
+              ${pre_context_html}
+              <ol start="${lineno}" class="context-line">
+                <li onclick="toggle('pre${id}', 'post${id}')">${context_line} <span>...</span></li>
+              </ol>
+              ${post_context_html}
+            </div>
+"""
+
+FRAME_VARS_ROW = """
+                  <tr>
+                    <td>${var_name}</td>
+                    <td class="code"><div>${var_value}</div></td>
+                  </tr>
+"""
+
+FRAME_VARS_TEMPLATE = """
+            <div class="commands">
+                <a href="#" onclick="return varToggle(this, '${id}')"><span>&#x25b6;</span> Local vars</a>
+            </div>
+            <table class="vars" id="v${id}">
+              <thead>
+                <tr>
+                  <th>Variable</th>
+                  <th>Value</th>
+                </tr>
+              </thead>
+              <tbody>
+                ${frame_vars_rows}
+              </tbody>
+            </table>
+"""
+
+FRAME_TEMPLATE = """
+        <li class="frame">
+          <code>${filename}</code> in <code>${function}</code>
+          ${frame_context}
+          ${frame_vars}
+        </li>
+"""
+
+HTML_TRACEBACK_TEMPLATE = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+  <meta name="robots" content="NONE,NOARCHIVE"/>
+  <title>${exception_type}</title>
+  <style type="text/css">
+    html * { padding:0; margin:0; }
+    body * { padding:10px 20px; }
+    body * * { padding:0; }
+    body { font:small sans-serif; }
+    body>div { border-bottom:1px solid #ddd; }
+    h1 { font-weight:normal; }
+    h2 { margin-bottom:.8em; }
+    h2 span { font-size:80%; color:#666; font-weight:normal; }
+    h3 { margin:1em 0 .5em 0; }
+    h4 { margin:0 0 .5em 0; font-weight: normal; }
+    table { border:1px solid #ccc; border-collapse: collapse; width:100%; background:white; }
+    tbody td, tbody th { vertical-align:top; padding:2px 3px; }
+    thead th { padding:1px 6px 1px 3px; background:#fefefe; text-align:left; font-weight:normal; font-size:11px; border:1px solid #ddd; }
+    tbody th { width:12em; text-align:right; color:#666; padding-right:.5em; }
+    table.vars { margin:5px 0 2px 40px; }
+    table.vars td, table.req td { font-family:monospace; }
+    table td.code { width:100%; }
+    table td.code div { overflow:hidden; }
+    table.source th { color:#666; }
+    table.source td { font-family:monospace; white-space:pre; border-bottom:1px solid #eee; }
+    ul.traceback { list-style-type:none; }
+    ul.traceback li.frame { margin-bottom:1em; }
+    div.context { margin: 10px 0; }
+    div.context ol { padding-left:30px; margin:0 10px; list-style-position: inside; }
+    div.context ol li { font-family:monospace; white-space:pre; color:#666; cursor:pointer; }
+    div.context ol.context-line li { color:black; background-color:#ccc; }
+    div.context ol.context-line li span { float: right; }
+    div.commands { margin-left: 40px; }
+    div.commands a { color:black; text-decoration:none; }
+    #summary { background: #ffc; }
+    #summary h2 { font-weight: normal; color: #666; }
+    #template, #template-not-exist { background:#f6f6f6; }
+    #unicode-hint { background:#eee; }
+    #traceback { background:#eee; }
+    #summary table { border:none; background:transparent; }
+    .error { background: #ffc; }
+    .specific { color:#cc3300; font-weight:bold; }
+    h2 span.commands { font-size:.7em;}
+    span.commands a:link {color:#5E5694;}
+    pre.exception_value { font-family: sans-serif; color: #666; font-size: 1.5em; margin: 10px 0 10px 0; }
+    pre.textdetails {display:none}
+  </style>
+  <script type="text/javascript">
+  //<!--
+    function getElementsByClassName(oElm, strTagName, strClassName){
+        // Written by Jonathan Snook, http://www.snook.ca/jon; Add-ons by Robert Nyman, http://www.robertnyman.com
+        var arrElements = (strTagName == "*" && document.all)? document.all :
+        oElm.getElementsByTagName(strTagName);
+        var arrReturnElements = new Array();
+        strClassName = strClassName.replace(/\-/g, "\\-");
+        var oRegExp = new RegExp("(^|\\s)" + strClassName + "(\\s|$$)");
+        var oElement;
+        for(var i=0; i<arrElements.length; i++){
+            oElement = arrElements[i];
+            if(oRegExp.test(oElement.className)){
+                arrReturnElements.push(oElement);
+            }
+        }
+        return (arrReturnElements)
+    }
+    function hideAll(elems) {
+      for (var e = 0; e < elems.length; e++) {
+        elems[e].style.display = 'none';
+      }
+    }
+    window.onload = function() {
+      hideAll(getElementsByClassName(document, 'table', 'vars'));
+      hideAll(getElementsByClassName(document, 'ol', 'pre-context'));
+      hideAll(getElementsByClassName(document, 'ol', 'post-context'));
+    }
+    function toggle() {
+      for (var i = 0; i < arguments.length; i++) {
+        var e = document.getElementById(arguments[i]);
+        if (e) {
+          e.style.display = e.style.display == 'none' ? 'block' : 'none';
+        }
+      }
+      return false;
+    }
+    function varToggle(link, id) {
+      toggle('v' + id);
+      var s = link.getElementsByTagName('span')[0];
+      var uarr = String.fromCharCode(0x25b6);
+      var darr = String.fromCharCode(0x25bc);
+      s.innerHTML = s.innerHTML == uarr ? darr : uarr;
+      return false;
+    }
+    //-->
+  </script>
+</head>
+<body>
+<pre class="textdetails">
+${text_details}
+</pre>
+<div id="summary">
+  <h1>${exception_type}</h1>
+  <pre class="exception_value">${exception_value}</pre>
+</div>
+${unicode_hint}
+<div id="traceback">
+  <h2>Traceback</h2>
+  <div id="browserTraceback">
+    <ul class="traceback">
+      ${frames}
+    </ul>
+  </div>
+</div>
+
+</body>
+</html>
+"""
+
+class DjangoUnicodeDecodeError(UnicodeDecodeError):
+    def __init__(self, obj, *args):
+        self.obj = obj
+        UnicodeDecodeError.__init__(self, *args)
+
+    def __str__(self):
+        original = UnicodeDecodeError.__str__(self)
+        return '%s. You passed in %r (%s)' % (original, self.obj,
+                type(self.obj))
+
+def force_unicode(s, encoding='utf-8', strings_only=False, errors='strict'):
+    if strings_only and isinstance(s, (types.NoneType, int, long, datetime.datetime, datetime.date, datetime.time, float)):
+        return s
+    try:
+        if not isinstance(s, basestring,):
+            if hasattr(s, '__unicode__'):
+                s = unicode(s)
+            else:
+                try:
+                    s = unicode(str(s), encoding, errors)
+                except UnicodeEncodeError:
+                    if not isinstance(s, Exception):
+                        raise
+                    # If we get to here, the caller has passed in an Exception
+                    # subclass populated with non-ASCII data without special
+                    # handling to display as a string. We need to handle this
+                    # without raising a further exception. We do an
+                    # approximation to what the Exception's standard str()
+                    # output should be.
+                    s = ' '.join([force_unicode(arg, encoding, strings_only,
+                            errors) for arg in s])
+        elif not isinstance(s, unicode):
+            # Note: We use .decode() here, instead of unicode(s, encoding,
+            # errors), so that if s is a SafeString, it ends up being a
+            # SafeUnicode at the end.
+            s = s.decode(encoding, errors)
+    except UnicodeDecodeError, e:
+        raise DjangoUnicodeDecodeError(s, *e.args)
+    return s
+
+def render_template(t, params):
+    st = string.Template(t)
+    return st.substitute(params)
+
+class ExceptionReporter:
+    def __init__(self, exc_type, exc_value, tb):
+        self.exc_type = exc_type
+        self.exc_value = exc_value
+        self.tb = tb
+
+        # Handle deprecated string exceptions
+        if isinstance(self.exc_type, basestring):
+            self.exc_value = Exception('Deprecated String Exception: %r' % self.exc_type)
+            self.exc_type = type(self.exc_value)
+
+    def _get_lines_from_file(self, filename, lineno, context_lines, loader=None, module_name=None):
+        """
+        Returns context_lines before and after lineno from file.
+        Returns (pre_context_lineno, pre_context, context_line, post_context).
+        """
+        source = None
+        if loader is not None and hasattr(loader, "get_source"):
+            source = loader.get_source(module_name)
+            if source is not None:
+                source = source.splitlines()
+        if source is None:
+            try:
+                f = open(filename)
+                try:
+                    source = f.readlines()
+                finally:
+                    f.close()
+            except (OSError, IOError):
+                pass
+        if source is None:
+            return None, [], None, []
+
+        encoding = 'ascii'
+        for line in source[:2]:
+            # File coding may be specified. Match pattern from PEP-263
+            # (http://www.python.org/dev/peps/pep-0263/)
+            match = re.search(r'coding[:=]\s*([-\w.]+)', line)
+            if match:
+                encoding = match.group(1)
+                break
+        source = [unicode(sline, encoding, 'replace') for sline in source]
+
+        lower_bound = max(0, lineno - context_lines)
+        upper_bound = lineno + context_lines
+
+        pre_context = [line.strip('\n') for line in source[lower_bound:lineno]]
+        context_line = source[lineno].strip('\n')
+        post_context = [line.strip('\n') for line in source[lineno+1:upper_bound]]
+
+        return lower_bound, pre_context, context_line, post_context
+
+    def get_traceback_frames(self):
+        frames = []
+        tb = self.tb
+        while tb is not None:
+            # support for __traceback_hide__ which is used by a few libraries
+            # to hide internal frames.
+            if tb.tb_frame.f_locals.get('__traceback_hide__'):
+                tb = tb.tb_next
+                continue
+            filename = tb.tb_frame.f_code.co_filename
+            function = tb.tb_frame.f_code.co_name
+            lineno = tb.tb_lineno - 1
+            loader = tb.tb_frame.f_globals.get('__loader__')
+            module_name = tb.tb_frame.f_globals.get('__name__')
+            pre_context_lineno, pre_context, context_line, post_context = self._get_lines_from_file(filename, lineno, 7, loader, module_name)
+            if pre_context_lineno is not None:
+                frames.append({
+                    'tb': tb,
+                    'filename': cgi.escape(filename),
+                    'function': cgi.escape(function),
+                    'lineno': lineno + 1,
+                    'vars': tb.tb_frame.f_locals.items(),
+                    'id': id(tb),
+                    'pre_context': pre_context,
+                    'context_line': context_line,
+                    'post_context': post_context,
+                    'pre_context_lineno': pre_context_lineno + 1,
+                })
+            tb = tb.tb_next
+
+        if not frames:
+            frames = [{
+                'filename': '&lt;unknown&gt;',
+                'function': '?',
+                'lineno': '?',
+                'context_line': '???',
+            }]
+
+        return frames
+
+    def get_traceback_html(self):
+        frames = self.get_traceback_frames()
+        unicode_hint = ''
+        if issubclass(self.exc_type, UnicodeError):
+            start = getattr(self.exc_value, 'start', None)
+            end = getattr(self.exc_value, 'end', None)
+            if start is not None and end is not None:
+                unicode_str = self.exc_value.args[1]
+                unicode_hint = force_unicode(unicode_str[max(start-5, 0):min(end+5, len(unicode_str))], 'ascii', errors='replace')
+
+        unicode_hint_html = render_template(UNICODE_HINT_TEMPLATE, {'hint':cgi.escape(unicode_hint)}) if unicode_hint else ""
+    
+        frames_html = []
+        for frame in frames:
+            frame_vars_rows = []
+            
+            for var_name, var_value in sorted(frame['vars']):
+                c = {
+                    'var_name': cgi.escape(var_name),
+                    'var_value': cgi.escape(pprint.pformat(var_value)),
+                }
+                frame_vars_rows.append( render_template(FRAME_VARS_ROW, c) )
+
+            c = {
+                'id': frame['id'],
+                'frame_vars_rows': "".join(frame_vars_rows),
+            }
+            frame_vars_html = render_template(FRAME_VARS_TEMPLATE, c)
+
+            pre_lines = []
+            for line in frame['pre_context']:
+                c = {
+                    'id': frame['id'],
+                    'line': cgi.escape(line),
+                }
+                pre_lines.append(render_template(FRAME_LINE_TEMPLATE, c))
+            pre_lines_html = "".join(pre_lines)
+
+            c = {
+                'id': frame['id'],
+                'pre_context_lineno': frame['pre_context_lineno'],
+                'pre_lines_html': pre_lines_html,
+            }
+            pre_context_html = render_template(FRAME_PRE_HTML, c)
+
+            post_lines = []
+            for line in frame['post_context']:
+                c = {
+                    'id': frame['id'],
+                    'line': cgi.escape(line),
+                }
+                post_lines.append(render_template(FRAME_LINE_TEMPLATE, c))
+            post_lines_html = "".join(pre_lines)
+
+            c = {
+                'id': frame['id'],
+                'post_context_lineno': int(frame['lineno'])+1,
+                'post_lines_html': post_lines_html,
+            }
+            post_context_html = render_template(FRAME_POST_HTML, c)
+
+            c = {
+                'id': frame['id'],
+                'pre_context_html': pre_context_html if frame['pre_context'] else "",
+                'lineno': frame['lineno'],
+                'context_line': cgi.escape(frame['context_line']),
+                'post_context_html': post_context_html if frame['post_context'] else "",
+            }
+            frame_context_html = render_template(FRAME_CONTEXT_TEMPLATE, c)
+
+            c = {
+                'filename': frame['filename'],
+                'function': frame['function'],
+                'frame_context': frame_context_html if frame['context_line'] else "",
+                'frame_vars': frame_vars_html if frame['vars'] else "",
+            }
+            frames_html.append( render_template(FRAME_TEMPLATE, c) )
+
+        frames_html = "".join(frames_html)
+
+        c = {
+            'exception_type': self.exc_type.__name__,
+            'exception_value': cgi.escape(force_unicode(self.exc_value, errors='replace')),
+            'unicode_hint': unicode_hint_html,
+            'frames': frames_html,
+            'lastframe': frames[-1],
+            'text_details': force_unicode("".join(traceback.format_exception(self.exc_type, self.exc_value, self.tb))),
+        }
+        return render_template(HTML_TRACEBACK_TEMPLATE,c)
+
+
+def format_exception(*a):
+    return ExceptionReporter(*a).get_traceback_html()
+
+
+def test():
+    def inner_function(s):
+        a = u"\u26a7".encode("ascii")
+        assert False
+
+    def outer_function(d):
+        inner_function(d)
+
+    try:
+        outer_function("some string")
+    except:
+        import sys
+        t, v, tb = sys.exc_info()
+        print format_exception(t, v, tb)
+
+if __name__ == "__main__":
+    test()

=== modified file 'bin/netsvc.py'
--- bin/netsvc.py	2009-11-06 10:06:23 +0000
+++ bin/netsvc.py	2009-11-10 14:04:09 +0000
@@ -216,7 +216,7 @@
     def quit(cls):
         cls.cancel(None)
 
-import traceback
+import htmltraceback
 
 class xmlrpc(object):
     class RpcGateway(object):
@@ -249,7 +249,7 @@
                 tb = e.traceback
             else:
                 tb = sys.exc_info()
-            tb_s = "".join(traceback.format_exception(*tb))
+            tb_s = "".join(htmltraceback.format_exception(*tb))
             if tools.config['debug_mode']:
                 import pdb
                 pdb.post_mortem(tb[2])