]> granicus.if.org Git - python/commitdiff
update references and documentation for modules in the new html package
authorFred Drake <fdrake@acm.org>
Sat, 17 May 2008 21:14:05 +0000 (21:14 +0000)
committerFred Drake <fdrake@acm.org>
Sat, 17 May 2008 21:14:05 +0000 (21:14 +0000)
(http://bugs.python.org/issue2882)

Doc/library/htmllib.rst
Doc/library/htmlparser.rst
Lib/html/parser.py
Lib/htmllib.py
Lib/test/test_codeccallbacks.py
Lib/test/test_multibytecodec_support.py
Lib/test/test_sundry.py

index 96a7d0812598aabfa5fa3e363f18cb8072be2224..ffaaaece6da9b2ad23d21975cc902ae0cf11c348 100644 (file)
@@ -77,12 +77,12 @@ The module defines a parser class and an exception:
       Interface definition for transforming an abstract flow of formatting events into
       specific output events on writer objects.
 
-   Module :mod:`HTMLParser`
+   Module :mod:`html.parser`
       Alternate HTML parser that offers a slightly lower-level view of the input, but
       is designed to work with XHTML, and does not implement some of the SGML syntax
       not used in "HTML as deployed" and which isn't legal for XHTML.
 
-   Module :mod:`htmlentitydefs`
+   Module :mod:`html.entities`
       Definition of replacement text for XHTML 1.0  entities.
 
    Module :mod:`sgmllib`
@@ -149,10 +149,10 @@ additional methods and instance variables for use within tag methods.
    :meth:`save_bgn` will raise a :exc:`TypeError` exception.
 
 
-:mod:`htmlentitydefs` --- Definitions of HTML general entities
-==============================================================
+:mod:`html.entities` --- Definitions of HTML general entities
+=============================================================
 
-.. module:: htmlentitydefs
+.. module:: html.entities
    :synopsis: Definitions of HTML general entities.
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
 
index 85a38fbe981672cb53f49a9207d754602c833d3e..ee3e1f27b0a5fd2483a4c1860402151da2767a63 100644 (file)
@@ -1,8 +1,8 @@
 
-:mod:`HTMLParser` --- Simple HTML and XHTML parser
-==================================================
+:mod:`html.parser` --- Simple HTML and XHTML parser
+===================================================
 
-.. module:: HTMLParser
+.. module:: html.parser
    :synopsis: A simple parser that can handle HTML and XHTML.
 
 
@@ -22,7 +22,7 @@ in :mod:`sgmllib`.
 
    The :class:`HTMLParser` class is instantiated without arguments.
 
-   An HTMLParser instance is fed HTML data and calls handler functions when tags
+   An :class:`HTMLParser` instance is fed HTML data and calls handler functions when tags
    begin and end.  The :class:`HTMLParser` class is meant to be overridden by the
    user to provide a desired behavior.
 
@@ -92,8 +92,8 @@ An exception is defined as well:
    ``handle_starttag('a', [('href', 'http://www.cwi.nl/')])``.
 
    .. versionchanged:: 2.6
-      All entity references from htmlentitydefs are now replaced in the attribute
-      values.
+      All entity references from :mod:`html.entities` are now replaced in the
+      attribute values.
 
 
 .. method:: HTMLParser.handle_startendtag(tag, attrs)
@@ -171,7 +171,7 @@ Example HTML Parser Application
 As a basic example, below is a very basic HTML parser that uses the
 :class:`HTMLParser` class to print out tags as they are encountered::
 
-   from HTMLParser import HTMLParser
+   from html.parser import HTMLParser
 
    class MyHTMLParser(HTMLParser):
 
index 2cbc2ecbc7326c1cdeeebd6596ac97eb67ff6601..b5010ac0970d6903c0084e7ccd8686156b470201 100644 (file)
@@ -372,16 +372,17 @@ class HTMLParser(markupbase.ParserBase):
                     c = int(s)
                 return unichr(c)
             else:
-                # Cannot use name2codepoint directly, because HTMLParser supports apos,
-                # which is not part of HTML 4
-                import htmlentitydefs
+                # Cannot use name2codepoint directly, because HTMLParser
+                # supports apos, which is not part of HTML 4
+                import html.entities
                 if HTMLParser.entitydefs is None:
                     entitydefs = HTMLParser.entitydefs = {'apos':u"'"}
-                    for k, v in htmlentitydefs.name2codepoint.iteritems():
+                    for k, v in html.entities.name2codepoint.iteritems():
                         entitydefs[k] = unichr(v)
                 try:
                     return self.entitydefs[s]
                 except KeyError:
                     return '&'+s+';'
 
-        return re.sub(r"&(#?[xX]?(?:[0-9a-fA-F]+|\w{1,8}));", replaceEntities, s)
+        return re.sub(r"&(#?[xX]?(?:[0-9a-fA-F]+|\w{1,8}));",
+                      replaceEntities, s)
index 24a2e2f3c71ff45f9649519a81cf46cc99162028..7ebb622e89a50cecfe184cdf08f2853f4cd0930a 100644 (file)
@@ -24,7 +24,7 @@ class HTMLParser(sgmllib.SGMLParser):
 
     """
 
-    from htmlentitydefs import entitydefs
+    from html.entities import entitydefs
 
     def __init__(self, formatter, verbose=0):
         """Creates an instance of the HTMLParser class.
index 656551d7c0fecfeff95bd2732e0d315412809784..a0fa34347deb05e25ca4e13dd02436dca85a1831 100644 (file)
@@ -1,5 +1,5 @@
 import test.test_support, unittest
-import sys, codecs, htmlentitydefs, unicodedata
+import sys, codecs, html.entities, unicodedata
 
 class PosReturn:
     # this can be used for configurable callbacks
@@ -86,7 +86,7 @@ class CodecCallbackTest(unittest.TestCase):
             l = []
             for c in exc.object[exc.start:exc.end]:
                 try:
-                    l.append(u"&%s;" % htmlentitydefs.codepoint2name[ord(c)])
+                    l.append(u"&%s;" % html.entities.codepoint2name[ord(c)])
                 except KeyError:
                     l.append(u"&#%d;" % ord(c))
             return (u"".join(l), exc.end)
index 60557640be3f5745c2f8e45e0948d4cbda33d78c..b9aa34b44418b615170b7b08bad22021f1766d84 100644 (file)
@@ -64,7 +64,7 @@ class TestBase:
         if self.has_iso10646:
             return
 
-        from htmlentitydefs import codepoint2name
+        from html.entities import codepoint2name
 
         def xmlcharnamereplace(exc):
             if not isinstance(exc, UnicodeEncodeError):
index 404a405de5ec87bf0d920ed0f510aa79b05216a3..c2fb66d99ec203ffeb7ea703d99072ef0f6aa5ad 100644 (file)
@@ -50,7 +50,7 @@ class TestUntestedModules(unittest.TestCase):
             import encodings
             import formatter
             import getpass
-            import htmlentitydefs
+            import html.entities
             import ihooks
             import imghdr
             import imputil