pythondoc-elementtree.HTMLTreeBuilder.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  2. <html>
  3. <head>
  4. <meta http-equiv='Content-Type' content='text/html; charset=us-ascii' />
  5. <title>The elementtree.HTMLTreeBuilder Module</title>
  6. <link rel='stylesheet' href='effbot.css' type='text/css' />
  7. </head>
  8. <body>
  9. <h1>The elementtree.HTMLTreeBuilder Module</h1>
  10. <p>Tools to build element trees from HTML files.</p>
  11. <h2>Module Contents</h2>
  12. <dl>
  13. <dt><b>HTMLTreeBuilder(builder=None, encoding=None)</b> (class) [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder-class'>#</a>]</dt>
  14. <dd>
  15. <p>ElementTree builder for HTML source code.</p>
  16. <dl>
  17. <dt><i>builder=</i></dt>
  18. <dd>
  19. Optional builder object. If omitted, the parser
  20. uses the standard <b>elementtree</b> builder.
  21. </dd>
  22. <dt><i>encoding=</i></dt>
  23. <dd>
  24. Optional character encoding, if known. If omitted,
  25. the parser looks for META tags inside the document. If no tags
  26. are found, the parser defaults to ISO-8859-1. Note that if your
  27. document uses a non-ASCII compatible encoding, you must decode
  28. the document before parsing.</dd>
  29. </dl><br />
  30. <p>For more information about this class, see <a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder-class'><i>The HTMLTreeBuilder Class</i></a>.</p>
  31. </dd>
  32. <dt><a id='elementtree.HTMLTreeBuilder.parse-function' name='elementtree.HTMLTreeBuilder.parse-function'><b>parse(source, encoding=None)</b></a> [<a href='#elementtree.HTMLTreeBuilder.parse-function'>#</a>]</dt>
  33. <dd>
  34. <p>Parse an HTML document or document fragment.</p>
  35. <dl>
  36. <dt><i>source</i></dt>
  37. <dd>
  38. A filename or file object containing HTML data.</dd>
  39. <dt><i>encoding</i></dt>
  40. <dd>
  41. Optional character encoding, if known. If omitted,
  42. the parser looks for META tags inside the document. If no tags
  43. are found, the parser defaults to ISO-8859-1.</dd>
  44. <dt>Returns:</dt>
  45. <dd>
  46. An ElementTree instance</dd>
  47. </dl><br />
  48. </dd>
  49. <dt><a id='elementtree.HTMLTreeBuilder.TreeBuilder-variable' name='elementtree.HTMLTreeBuilder.TreeBuilder-variable'><b>TreeBuilder</b></a> (variable) [<a href='#elementtree.HTMLTreeBuilder.TreeBuilder-variable'>#</a>]</dt>
  50. <dd>
  51. <p>An alias for the <b>HTMLTreeBuilder</b> class.
  52. </p></dd>
  53. </dl>
  54. <h2><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder-class' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder-class'>The HTMLTreeBuilder Class</a></h2>
  55. <dl>
  56. <dt><b>HTMLTreeBuilder(builder=None, encoding=None)</b> (class) [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder-class'>#</a>]</dt>
  57. <dd>
  58. <p>ElementTree builder for HTML source code. This builder converts an
  59. HTML document or fragment to an ElementTree.
  60. </p><p>
  61. The parser is relatively picky, and requires balanced tags for most
  62. elements. However, elements belonging to the following group are
  63. automatically closed: P, LI, TR, TH, and TD. In addition, the
  64. parser automatically inserts end tags immediately after the start
  65. tag, and ignores any end tags for the following group: IMG, HR,
  66. META, and LINK.
  67. </p><dl>
  68. <dt><i>builder=</i></dt>
  69. <dd>
  70. Optional builder object. If omitted, the parser
  71. uses the standard <b>elementtree</b> builder.
  72. </dd>
  73. <dt><i>encoding=</i></dt>
  74. <dd>
  75. Optional character encoding, if known. If omitted,
  76. the parser looks for META tags inside the document. If no tags
  77. are found, the parser defaults to ISO-8859-1. Note that if your
  78. document uses a non-ASCII compatible encoding, you must decode
  79. the document before parsing.</dd>
  80. </dl><br />
  81. </dd>
  82. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.close-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.close-method'><b>close()</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.close-method'>#</a>]</dt>
  83. <dd>
  84. <p>Flushes parser buffers, and return the root element.</p>
  85. <dl>
  86. <dt>Returns:</dt>
  87. <dd>
  88. An Element instance.</dd>
  89. </dl><br />
  90. </dd>
  91. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_charref-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_charref-method'><b>handle_charref(char)</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_charref-method'>#</a>]</dt>
  92. <dd>
  93. <p>(Internal) Handles character references.</p>
  94. </dd>
  95. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_data-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_data-method'><b>handle_data(data)</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_data-method'>#</a>]</dt>
  96. <dd>
  97. <p>(Internal) Handles character data.</p>
  98. </dd>
  99. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_endtag-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_endtag-method'><b>handle_endtag(tag)</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_endtag-method'>#</a>]</dt>
  100. <dd>
  101. <p>(Internal) Handles end tags.</p>
  102. </dd>
  103. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_entityref-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_entityref-method'><b>handle_entityref(name)</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_entityref-method'>#</a>]</dt>
  104. <dd>
  105. <p>(Internal) Handles entity references.</p>
  106. </dd>
  107. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_starttag-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_starttag-method'><b>handle_starttag(tag, attrs)</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.handle_starttag-method'>#</a>]</dt>
  108. <dd>
  109. <p>(Internal) Handles start tags.</p>
  110. </dd>
  111. <dt><a id='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.unknown_entityref-method' name='elementtree.HTMLTreeBuilder.HTMLTreeBuilder.unknown_entityref-method'><b>unknown_entityref(name)</b></a> [<a href='#elementtree.HTMLTreeBuilder.HTMLTreeBuilder.unknown_entityref-method'>#</a>]</dt>
  112. <dd>
  113. <p>(Hook) Handles unknown entity references. The default action
  114. is to ignore unknown entities.</p>
  115. </dd>
  116. </dl>
  117. </body></html>