Docstring changes

jgraham · jgraham · commit 2224543f06b3 · 2007-05-10T08:54:52.000Z
--HG--
extra : convert_revision : svn%3Aacbfec75-9323-0410-a652-858a13e371e0/trunk%40556
diff --git a/src/html5parser.py b/src/html5parser.py
@@ -42,8 +42,8 @@ def __init__(self, strict = False, tree=simpletree.TreeBuilder):
         strict - raise an exception when a parse error is encountered
 
         tree - a treebuilder class controlling the type of tree that will be
-        returned. This class is almost always a subclass of
-        html5lib.treebuilders._base.TreeBuilder
+        returned. Built in treebuilders can be accessed through
+        html5lib.treebuilders.getTreeBuilder(treeType)
         """
 
         # Raise an exception on the first error encountered
diff --git a/src/treebuilders/__init__.py b/src/treebuilders/__init__.py
@@ -38,7 +38,23 @@
 import etree
 
 
-def getTreebuilder(treeType, implementation=None, **kwargs):
+def getTreeBuilder(treeType, implementation=None, **kwargs):
+    """Get a TreeBuilder class for various types of tree with built-in support
+    
+    treeType - the name of the tree type required (case-insensitive). Supported
+               values are "simpletree", "dom", "etree"
+               
+               "simpletree" - a built-in DOM-ish tree type with support for some
+                              more pythonic idioms.
+                "dom" - The xml.dom.minidom DOM implementation
+                "etree" - A generic builder for tree implementations exposing an
+                          elementtree-like interface (known to work with
+                          ElementTree, cElementTree and lxml.etree).
+               
+    implementation - (Currently applies to the "etree" tree type only). A module
+                      implementing the tree type e.g. xml.etree.ElementTree or
+                      lxml.etree."""
+    
     treeType = treeType.lower()
     if treeType in ("dom", "simpletree"):
         return globals()[treeType].TreeBuilder
diff --git a/src/treebuilders/etree.py b/src/treebuilders/etree.py
@@ -1,11 +1,18 @@
 import _base
 import new
 
+moduleCache = {}
+
 def getETreeModule(ElementTreeImplementation, fullTree=False):
-    mod = new.module("_" + ElementTreeImplementation.__name__+"builder")
-    objs = getETreeBuilder(ElementTreeImplementation, fullTree)
-    mod.__dict__.update(objs)
-    return mod
+    name = "_" + ElementTreeImplementation.__name__+"builder"
+    if name in moduleCache:
+        return moduleCache[name]
+    else:
+        mod = new.module("_" + ElementTreeImplementation.__name__+"builder")
+        objs = getETreeBuilder(ElementTreeImplementation, fullTree)
+        mod.__dict__.update(objs)
+        moduleCache[name] = mod    
+        return mod
 
 def getETreeBuilder(ElementTreeImplementation, fullTree=False):
     ElementTree = ElementTreeImplementation
diff --git a/src/treebuilders/etreefull.py b/src/treebuilders/etreefull.py
