Changes between Version 3 and Version 4 of TracDev/IWikiSyntaxProviderExample

Timestamp:

Sep 11, 2010, 11:41:13 AM (14 years ago)

Author:

Christian Boos

Comment:

Improve the sample code (​PEP:0008, TracDev/CodingStyle) and answer the question about regexp capture groups

TracDev/IWikiSyntaxProviderExample

@@ -135 +135 @@
 {{{
 #!python
-# encoding: utf-8
+# -*- coding: utf-8 -*-
 """
 WikiSyntaxProviderTest.py
@@ -143 +143 @@
 """
 
+from genshi.builder import tag
+
 from trac.core import *
 from trac.wiki import IWikiSyntaxProvider
-from genshi.builder import tag
+
 
 class WikiSyntaxProviderTest(Component):
-    '''This is a test Component to demonstrate the use of the IWikiSyntaxProvider Interface of Trac.'''
+    """This is a test Component to demonstrate the use of the 
+    IWikiSyntaxProvider Interface of Trac."""
     implements(IWikiSyntaxProvider)
 
@@ -157 +160 @@
 
     def get_wiki_syntax(self):
-        #group numbers dont work, why? Must use group names inside the regex.
-        yield ( r'\?(?P<domain>[tmw])_(?P<searchword>.+?)\?', self._format_regex_link)
+        # Note that group numbers don't work as the following is only a regexp 
+        # fragment which will be part of a larger regexp, therefore one must
+        # use group names, with reasonably unique names
+        yield (r'\?(?P<domain>[tmw])_(?P<searchword>.+?)\?', 
+               self._format_regex_link)
 
     def _format_regex_link(self, formatter, ns, match):