Changeset 3056

Timestamp:

11/16/05 16:37:58 (8 years ago)

Author:

moschny

Message:

• Bugfix: Uncaught StopIteration, in case the toc is empty.
• Fix many pylint warnings (long lines, conventions for variable and method names, unused variables and imports, docstrings).

File:

• trac/trunk/wiki-macros/TracNav.py (modified) (10 diffs, 1 prop)

trac/trunk/wiki-macros/TracNav.py

@@ -68 +68 @@
 """
 
+__revision__ = "$Id$"
+
 import re
-import sys
 from trac.wiki.api import WikiSystem
 from trac.wiki.model import WikiPage
 
-listRule = re.compile(r"""^(?P<indent> *)\* +(?:(?P<wikilink>\[wiki:(?P<link>(&#34;([^&#34;]*)&#34;|'([^']*)')|([^ \]]+)) +(?P<label>[^\]]*)\])|(?P<text>.*))""", re.M)
-
-def getToc(hdf, env, curpage, name):
-    tocText = "* Table of contents"
+LISTRULE = re.compile(r"""^(?P<indent> *)\* +"""
+                      r"""(?:(?P<wikilink>\[wiki:"""
+                      r"""(?P<link>(&#34;([^&#34;]*)&#34;|"""
+                      r"""'([^']*)')|([^ \]]+))"""
+                      r"""+(?P<label>[^\]]*)\])|(?P<text>.*))""",
+                      re.M)
+
+TRACNAVHOME = "http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav"
+
+def get_toc(hdf, env, curpage, name):
+    """Fetch the wiki page containing the toc, if available."""
+    
+    toc_text = "* Table of contents"
 
     preview = hdf.getValue('args.preview', "")
     if preview and (name == curpage):
-        tocText = hdf.getValue('wiki.page_source', tocText);
+        toc_text = hdf.getValue('wiki.page_source', toc_text);
     else:
         if WikiSystem(env).has_page(name):
-            tocText = WikiPage(env, name).text
+            toc_text = WikiPage(env, name).text
 
     # env.log.debug(tocText)
-    return tocText
-
-
-def getTocEntry(tocText):
-    nextPos = 0
+    return toc_text
+
+
+def get_toc_entry(toc_text):
+    """Generator: returns the next toc entry. Each toc entry consists
+    of it's indentation level, label and link."""
+    next_pos = 0
     while 1:
-        match = listRule.search(tocText, nextPos)
+        match = LISTRULE.search(toc_text, next_pos)
         if not match:
             # env.log.debug("No more matches")
@@ -111 +123 @@
     
         yield indent, link, label
-        nextPos = match.end()
-
-
-def getTocEntryAndNextIndent(g):
-    indent, link, label = g.next()
+        next_pos = match.end()
+
+
+def get_toc_entry_and_indent(gen):
+    """Generator, to be used as a filter for get_toc_entry().  Returns
+    link and label of the current toc entry and the indentation level
+    of the next entry or -1 if there are no more entries. The first
+    call to next() returns the indentation of the first entry."""
+    
+    try:
+        indent, link, label = gen.next()
+    except StopIteration:
+        indent = -1
     yield indent
 
@@ -122 +142 @@
         yield link, label
         try:
-            indent, link, label = g.next()
+            indent, link, label = gen.next()
         except StopIteration:
             indent, ready = -1, True
@@ -128 +148 @@
 
 
-def _parseToc(g, nextIndent, level = 0):
-    list = []
-    if nextIndent > level:
-        subList, nextIndent = _parseToc(g, nextIndent, level + 1)
-        if nextIndent < level:
+def _parse_toc(gen, next_indent, level = 0):
+    toclist = []
+    if next_indent > level:
+        sublist, next_indent = _parse_toc(gen, next_indent, level + 1)
+        if next_indent < level:
             # level is empty
-            return subList, nextIndent
+            return sublist, next_indent
         else:
             # broken indentation structure
-            list.append((None, None, subList))
+            toclist.append((None, None, sublist))
     while 1:
-        if nextIndent == level:
-            (link, label), nextIndent = g.next(), g.next()
-            if nextIndent > level:
-                subList, nextIndent = _parseToc(g, nextIndent, level + 1)
-                list.append((link, label, subList))
-            else:
-                list.append((link, label, None))
-        else:
-            assert nextIndent < level
-            return list, nextIndent
-
-
-def parseToc(tocText):
-    g = getTocEntryAndNextIndent(getTocEntry(tocText))
-    list, _ = _parseToc(g, g.next())
-    return list
+        if next_indent == level:
+            (link, label), next_indent = gen.next(), gen.next()
+            if next_indent > level:
+                sublist, next_indent = _parse_toc(gen, next_indent, level + 1)
+                toclist.append((link, label, sublist))
+            else:
+                toclist.append((link, label, None))
+        else:
+            assert next_indent < level
+            return toclist, next_indent
+
+
+def parse_toc(toc_text):
+    gen = get_toc_entry_and_indent(get_toc_entry(toc_text))
+    toclist, _ = _parse_toc(gen, gen.next())
+    return toclist
    
 
@@ -164 +184 @@
         name = 'TOC'
 
-    db = env.get_db_cnx()
-    toc = parseToc(getToc(hdf, env, curpage, name))
+    toc = parse_toc(get_toc(hdf, env, curpage, name))
     if not toc:
-        msg = ''
-        msg += '<div class="system-message"><strong>Error: Table of contents does not exist.'
+        msg = '<div class="system-message">' \
+              "<strong>Error: Table of contents does not exist or is empty."
         if (not preview) and (hdf.getValue('trac.acl.WIKI_MODIFY', '')):
-            msg += ' Click here to <a href="%s?edit=yes">edit</a>.' % env.href.wiki(name)
+            msg += ' Click here to <a href="%s?edit=yes">edit</a>.' % \
+                   env.href.wiki(name)
         msg += '</strong></div>\n'
         return msg
 
-    (found, filtered) = filter(curpage, toc, 0)
+    (found, filtered) = filter_toc(curpage, toc, 0)
     if found:
-        return displayAll(hdf, env, name, curpage, filtered, 0)
+        return display_all(hdf, env, name, curpage, filtered, 0)
     else:
-        return displayAll(hdf, env, name, curpage, toc, 0)
-
-
-def filter(curpage, toc, level):
+        return display_all(hdf, env, name, curpage, toc, 0)
+
+
+def filter_toc(curpage, toc, level):
     found = 0
     result = []
@@ -190 +210 @@
             result.append((name, title, None))
         else:
-            (subfound, subtoc) = filter(curpage, sub, level + 1)
+            (subfound, subtoc) = filter_toc(curpage, sub, level + 1)
             if subfound:
                 found = 1
@@ -207 +227 @@
     return ' ' * col
 
-def displayAll(hdf, env, name, curpage, toc, col):
+def display_all(hdf, env, name, curpage, toc, col):
     preview = hdf.getValue('args.preview', "")
-    html = ''
-    html += '%s<div class="wiki-toc trac-nav">\n' % indentation(col)
+    html = '%s<div class="wiki-toc trac-nav">\n' % indentation(col)
     col += 1
-
-    html += '%s<h2><a href="http://svn.ipd.uka.de/trac/javaparty/wiki/TracNav">TracNav</a> menu</h2>' % indentation(col)
+    html += '%s<h2><a href="%s">TracNav</a> menu</h2>' % \
+            (indentation(col), TRACNAVHOME)
 
     if (not preview) and hdf.getValue('trac.acl.WIKI_MODIFY', ''):
-        html += '%s<div class="edit"><a href="%s?edit=yes">edit</a></div>\n' % (indentation(col), env.href.wiki(name))
+        html += '%s<div class="edit"><a href="%s?edit=yes">edit</a></div>\n' % \
+                (indentation(col), env.href.wiki(name))
     html += '%s<ul>\n' % indentation(col)
     col += 1
@@ -229 +249 @@
     html = ''
     for name, title, sub in toc:
-        liStyle = ' style="padding-left: %dem;"' % (depth + 1)
+        li_style = ' style="padding-left: %dem;"' % (depth + 1)
         if sub == None:
             if name == curpage:
@@ -235 +255 @@
             else:
                 cls = ''
-            html += '%s<li%s%s>' % (indentation(col), liStyle, cls)
+            html += '%s<li%s%s>' % (indentation(col), li_style, cls)
             if name == None:
                 html += title
@@ -242 +262 @@
             html += '</li>\n'
         else:
-            html += '%s<li%s>\n' % (indentation(col), liStyle)
+            html += '%s<li%s>\n' % (indentation(col), li_style)
             col += 1
             if name == None or len(sub) > 0:
                 html += '%s<h4>%s</h4>\n' % (indentation(col), title)
             else:
-                html += '%s<h4><a href="%s">%s</a>...</h4>\n' % (indentation(col), env.href.wiki(name), title)
+                html += '%s<h4><a href="%s">%s</a>...</h4>\n' % \
+                        (indentation(col), env.href.wiki(name), title)
             col -= 1
             html += '%s</li>\n' % indentation(col)