[Epydoc-commits] SF.net SVN: epydoc: [1437] trunk/epydoc/src/epydoc/docbuilder.py

[<dva...@us...>]

Revision: 1437
          http://svn.sourceforge.net/epydoc/?rev=1437&view=rev
Author:   dvarrazzo
Date:     2007-02-04 18:37:15 -0800 (Sun, 04 Feb 2007)

Log Message:
-----------
- Added a guard against malformed pattern in regular expressions.

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/docbuilder.py

Modified: trunk/epydoc/src/epydoc/docbuilder.py
===================================================================
--- trunk/epydoc/src/epydoc/docbuilder.py	2007-02-05 02:22:16 UTC (rev 1436)
+++ trunk/epydoc/src/epydoc/docbuilder.py	2007-02-05 02:37:15 UTC (rev 1437)
@@ -93,6 +93,16 @@
         self.exclude_parse = exclude_parse
         self.add_submodules = add_submodules
 
+        # Test for pattern syntax and compile them into pattern objects.
+        try:
+            self._introspect_regexp = (exclude_introspect
+                and re.compile(exclude_introspect))
+            self._parse_regexp = (exclude_parse
+                and re.compile(exclude_parse))
+        except Exception, exc:
+            log.error('Error in regular expression pattern: %s' % exc)
+            raise
+
     def must_introspect(self, name):
         """
         Return C{True} if a module is to be introsepcted with the current
@@ -102,7 +112,7 @@
         @type name: L{DottedName} or C{str}
         """
         return self.introspect \
-            and not self._matches_filter(name, self.exclude_introspect)
+            and not self._matches_filter(name, self._introspect_regexp)
 
     def must_parse(self, name):
         """
@@ -112,27 +122,27 @@
         @type name: L{DottedName} or C{str}
         """
         return self.parse \
-            and not self._matches_filter(name, self.exclude_parse)
+            and not self._matches_filter(name, self._parse_regexp)
 
-    def _matches_filter(self, name, pattern):
+    def _matches_filter(self, name, regexp):
         """
         Test if a module name matches a pattern.
 
         @param name: The name of the module to test
         @type name: L{DottedName} or C{str}
-        @param pattern: The pattern to match C{name} againts.
+        @param regexp: The pattern object to match C{name} against.
             If C{None}, return C{False}
-        @type pattern: C{str}
-        @return: C{True} if C{name} in dotted format matches C{pattern},
+        @type regexp: C{pattern}
+        @return: C{True} if C{name} in dotted format matches C{regexp},
             else C{False}
         @rtype: C{bool}
         """
-        if not pattern: return False
+        if regexp is None: return False
 
         if isinstance(name, DottedName):
             name = str(name)
 
-        return bool(re.search(pattern, name))
+        return bool(regexp.search(name))
 
 
 def build_doc(item, introspect=True, parse=True, add_submodules=True,
@@ -184,9 +194,12 @@
     @param parse: If true, then use parsing to examine the specified
         items.  Otherwise, just use introspection.
     """
-    options = BuildOptions(parse=parse, introspect=introspect,
-        exclude_introspect=exclude_introspect, exclude_parse=exclude_parse,
-        add_submodules=add_submodules)
+    try:
+        options = BuildOptions(parse=parse, introspect=introspect,
+            exclude_introspect=exclude_introspect, exclude_parse=exclude_parse,
+            add_submodules=add_submodules)
+    except Exception:
+        return None
 
     # Get the basic docs for each item.
     doc_pairs = _get_docs_from_items(items, options)


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.