[patch] trac.wiki.formatter.wiki_to_outline misses req=None keyword argument.

[trbs <trbs@…>]

If one tries to use wiki_to_outline from trac.wiki.formatter if raises an exception because req variable is not found in scope.

Simple fix for this forgotten keyword argument is:

formatter.py

@@ -1440 +1440 @@
     return Markup(out.getvalue())
 
 def wiki_to_outline(wikitext, env, db=None,
-                    absurls=False, max_depth=None, min_depth=None):
+                    absurls=False, max_depth=None, min_depth=None,
+                    req=None):
     if not wikitext:
         return Markup()
     abs_ref, href = (req or env).abs_href, (req or env).href

[Remy Blank]

Patch applied on 0.11-stable in [9411]. However, you really shouldn't be using the wiki_to_* functions anymore, and use the format_to* functions instead.

Actually, as the wiki_to_* functions were pre-0.11, I would even suggest removing them in 0.12. They are actually partly broken:

• The abs_href and href locals are not used.
• The context is created from req, which can be None in wiki_to_oneliner() and certainly is None in wiki_to_outline(). In that case, absurls isn't used either, and context.href is None, which will certainly be problematic further down.

So we should either remove them, or fix them correctly (which I'm not sure how to do). Thoughts?

[trbs <trbs@…>]

I've seen that as well. But did not comment on that, only trying to fix the obvious error.

Found the obviously missing keyword argument because I was looking for a way to easily parse wiki markup (including macro's) from a macro. But ended up using a subclass of Template in my macro and doing the basic wrapping code myself.

Maybe I did approach my problem the wrong way but some convenience functions would be useful.

Saying that I would be in favour of removing these particular functions.

There's two reasons I can think of not too; (1) not to put more tickets on 0.12 milestone (2) not to create backward incompatibility for plugin/macro writers.

Usage of wiki_to_* functions on trac-hack:

$ find trac-hacks-trunk -type f -regex ".*0\.11.*\.py" -exec grep -H 'import wiki_to_' {} \; | wc -l
40

$ find trac-hacks-trunk -type f -regex ".*0\.12.*\.py" -exec grep -H 'import wiki_to_' {} \; | wc -l
2

(there not many 0.12 plugins in the repository but still :)

[Christian Boos]

I'll mark those functions as deprecated.

[Christian Boos]

Done in [9427].