PageRenderTime 41ms CodeModel.GetById 14ms RepoModel.GetById 0ms app.codeStats 0ms

/public_html/apidocs/pymine.beautifulsoup.BeautifulSoup.html

http://pymine.googlecode.com/
HTML | 285 lines | 198 code | 87 blank | 0 comment | 0 complexity | 3c41824f53c257653825649eb3bd4256 MD5 | raw file
Possible License(s): Apache-2.0, LGPL-2.1 
    

  1. <!DOCTYPE html
    2. 

  2.   PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    3. 

  3.   "DTD/xhtml1-strict.dtd">
    4. 

  4. <html>
    5. 

  5.   <head>
    6. 

  6.     <title>API docs for &ldquo;pymine.beautifulsoup.BeautifulSoup&rdquo;</title>
    7. 

  7.     <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    8. 

  8.     <link href="apidocs.css" type="text/css" rel="stylesheet" />
    9. 

  9.     
    10. 

  10.     
    11. 

  11.   </head>
    12. 

  12.   <body>
    13. 

  13.     <h1 class="module">Module p.b.BeautifulSoup</h1>
    14. 

  14.     <p>
    15. 

  15.       <span id="part">Part of <a href="pymine.html">pymine</a>.<a href="pymine.beautifulsoup.html">beautifulsoup</a></span>
    16. 

  16.       
    17. 

  17.       
    18. 

  18.     </p>
    19. 

  19.     <div>
    20. 

  20.       
    21. 

  21.     </div>
    22. 

  22.     <pre>Beautiful Soup
    23. 

  23. Elixir and Tonic
    24. 

  24. "The Screen-Scraper's Friend"
    25. 

  25. http://www.crummy.com/software/BeautifulSoup/
    26. 

  26. 

  27. Beautiful Soup parses a (possibly invalid) XML or HTML document into a
    28. 

  28. tree representation. It provides methods and Pythonic idioms that make
    29. 

  29. it easy to navigate, search, and modify the tree.
    30. 

  30. 

  31. A well-formed XML/HTML document yields a well-formed data
    32. 

  32. structure. An ill-formed XML/HTML document yields a correspondingly
    33. 

  33. ill-formed data structure. If your document is only locally
    34. 

  34. well-formed, you can use this library to find and process the
    35. 

  35. well-formed part of it.
    36. 

  36. 

  37. Beautiful Soup works with Python 2.2 and up. It has no external
    38. 

  38. dependencies, but you'll have more success at converting data to UTF-8
    39. 

  39. if you also install these three packages:
    40. 

  40. 

  41. * chardet, for auto-detecting character encodings
    42. 

  42.   http://chardet.feedparser.org/
    43. 

  43. * cjkcodecs and iconv_codec, which add more encodings to the ones supported
    44. 

  44.   by stock Python.
    45. 

  45.   http://cjkpython.i18n.org/
    46. 

  46. 

  47. Beautiful Soup defines classes for two main parsing strategies:
    48. 

  48. 

  49.  * BeautifulStoneSoup, for parsing XML, SGML, or your domain-specific
    50. 

  50.    language that kind of looks like XML.
    51. 

  51. 

  52.  * BeautifulSoup, for parsing run-of-the-mill HTML code, be it valid
    53. 

  53.    or invalid. This class has web browser-like heuristics for
    54. 

  54.    obtaining a sensible parse tree in the face of common HTML errors.
    55. 

  55. 

  56. Beautiful Soup also defines a class (UnicodeDammit) for autodetecting
    57. 

  57. the encoding of an HTML or XML document, and converting it to
    58. 

  58. Unicode. Much of this code is taken from Mark Pilgrim's Universal Feed Parser.
    59. 

    60. 

  60. For more than you ever wanted to know about Beautiful Soup, see the
    61. 

  61. documentation:
    62. 

  62. http://www.crummy.com/software/BeautifulSoup/documentation.html
    63. 

  63. 

  64. Here, have some legalese:
    65. 

  65. 

  66. Copyright (c) 2004-2009, Leonard Richardson
    67. 

  67. 

  68. All rights reserved.
    69. 

  69. 

  70. Redistribution and use in source and binary forms, with or without
    71. 

  71. modification, are permitted provided that the following conditions are
    72. 

  72. met:
    73. 

  73. 

  74.   * Redistributions of source code must retain the above copyright
    75. 

  75.     notice, this list of conditions and the following disclaimer.
    76. 

  76. 

  77.   * Redistributions in binary form must reproduce the above
    78. 

  78.     copyright notice, this list of conditions and the following
    79. 

  79.     disclaimer in the documentation and/or other materials provided
    80. 

  80.     with the distribution.
    81. 

  81. 

  82.   * Neither the name of the the Beautiful Soup Consortium and All
    83. 

  83.     Night Kosher Bakery nor the names of its contributors may be
    84. 

  84.     used to endorse or promote products derived from this software
    85. 

  85.     without specific prior written permission.
    86. 

  86. 

  87. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    88. 

  88. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    89. 

  89. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    90. 

  90. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    91. 

  91. CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    92. 

  92. EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    93. 

  93. PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    94. 

  94. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    95. 

  95. LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    96. 

  96. NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    97. 

  97. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE, DAMMIT.</pre>
    98. 

  98.     
    99. 

  99.     
    100. 

  100.     <div id="splitTables">
    101. 

  101.       <table class="children sortable" id="id44">
    102. 

  102.   
    103. 

  103.   
    104. 

  104.   
    105. 

  105.   
    106. 

  106.   <tr class="function">
    107. 

  107.     
    108. 

  108.     
    109. 

  109.     <td>Function</td>
    110. 

  110.     <td><a href="pymine.beautifulsoup.BeautifulSoup.html#_match_css_class">_match_css_class</a></td>
    111. 

  111.     <td><span>Build a RE to match the given CSS class.</span></td>
    112. 

  112.   </tr><tr class="class">
    113. 

  113.     
    114. 

  114.     
    115. 

  115.     <td>Class</td>
    116. 

  116.     <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html">PageElement</a></td>
    117. 

  117.     <td><span>Contains the navigational information for some part of the page</span></td>
    118. 

  118.   </tr><tr class="class">
    119. 

  119.     
    120. 

  120.     
    121. 

  121.     <td>Class</td>
    122. 

  122.     <td><a href="pymine.beautifulsoup.BeautifulSoup.NavigableString.html">NavigableString</a></td>
    123. 

  123.     <td><span class="undocumented">No class docstring; 2/5 methods documented</span></td>
    124. 

  124.   </tr><tr class="class">
    125. 

  125.     
    126. 

  126.     
    127. 

  127.     <td>Class</td>
    128. 

  128.     <td><a href="pymine.beautifulsoup.BeautifulSoup.CData.html">CData</a></td>
    129. 

  129.     <td><span class="undocumented">Undocumented</span></td>
    130. 

  130.   </tr><tr class="class">
    131. 

  131.     
    132. 

  132.     
    133. 

  133.     <td>Class</td>
    134. 

  134.     <td><a href="pymine.beautifulsoup.BeautifulSoup.ProcessingInstruction.html">ProcessingInstruction</a></td>
    135. 

  135.     <td><span class="undocumented">Undocumented</span></td>
    136. 

  136.   </tr><tr class="class">
    137. 

  137.     
    138. 

  138.     
    139. 

  139.     <td>Class</td>
    140. 

  140.     <td><a href="pymine.beautifulsoup.BeautifulSoup.Comment.html">Comment</a></td>
    141. 

  141.     <td><span class="undocumented">Undocumented</span></td>
    142. 

  142.   </tr><tr class="class">
    143. 

  143.     
    144. 

  144.     
    145. 

  145.     <td>Class</td>
    146. 

  146.     <td><a href="pymine.beautifulsoup.BeautifulSoup.Declaration.html">Declaration</a></td>
    147. 

  147.     <td><span class="undocumented">Undocumented</span></td>
    148. 

  148.   </tr><tr class="class">
    149. 

  149.     
    150. 

  150.     
    151. 

  151.     <td>Class</td>
    152. 

  152.     <td><a href="pymine.beautifulsoup.BeautifulSoup.Tag.html">Tag</a></td>
    153. 

  153.     <td><span>Represents a found HTML tag with its attributes and contents.</span></td>
    154. 

  154.   </tr><tr class="class">
    155. 

  155.     
    156. 

  156.     
    157. 

  157.     <td>Class</td>
    158. 

  158.     <td><a href="pymine.beautifulsoup.BeautifulSoup.SoupStrainer.html">SoupStrainer</a></td>
    159. 

  159.     <td><span>Encapsulates a number of ways of matching a markup element (tag or</span></td>
    160. 

  160.   </tr><tr class="class">
    161. 

  161.     
    162. 

  162.     
    163. 

  163.     <td>Class</td>
    164. 

  164.     <td><a href="pymine.beautifulsoup.BeautifulSoup.ResultSet.html">ResultSet</a></td>
    165. 

  165.     <td><span>A ResultSet is just a list that keeps track of the SoupStrainer</span></td>
    166. 

  166.   </tr><tr class="function">
    167. 

  167.     
    168. 

  168.     
    169. 

  169.     <td>Function</td>
    170. 

  170.     <td><a href="pymine.beautifulsoup.BeautifulSoup.html#buildTagMap">buildTagMap</a></td>
    171. 

  171.     <td><span>Turns a list of maps, lists, or scalars into a single map.</span></td>
    172. 

  172.   </tr><tr class="class">
    173. 

  173.     
    174. 

  174.     
    175. 

  175.     <td>Class</td>
    176. 

  176.     <td><a href="pymine.beautifulsoup.BeautifulSoup.BeautifulStoneSoup.html">BeautifulStoneSoup</a></td>
    177. 

  177.     <td><span>This class contains the basic parser and search code. It defines</span></td>
    178. 

  178.   </tr><tr class="class">
    179. 

  179.     
    180. 

  180.     
    181. 

  181.     <td>Class</td>
    182. 

  182.     <td><a href="pymine.beautifulsoup.BeautifulSoup.BeautifulSoup.html">BeautifulSoup</a></td>
    183. 

  183.     <td><span>This parser knows the following facts about HTML:</span></td>
    184. 

  184.   </tr><tr class="class">
    185. 

  185.     
    186. 

  186.     
    187. 

  187.     <td>Class</td>
    188. 

  188.     <td><a href="pymine.beautifulsoup.BeautifulSoup.StopParsing.html">StopParsing</a></td>
    189. 

  189.     <td><span class="undocumented">Undocumented</span></td>
    190. 

  190.   </tr><tr class="class">
    191. 

  191.     
    192. 

  192.     
    193. 

  193.     <td>Class</td>
    194. 

  194.     <td><a href="pymine.beautifulsoup.BeautifulSoup.ICantBelieveItsBeautifulSoup.html">ICantBelieveItsBeautifulSoup</a></td>
    195. 

  195.     <td><span>The BeautifulSoup class is oriented towards skipping over</span></td>
    196. 

  196.   </tr><tr class="class">
    197. 

  197.     
    198. 

  198.     
    199. 

  199.     <td>Class</td>
    200. 

  200.     <td><a href="pymine.beautifulsoup.BeautifulSoup.MinimalSoup.html">MinimalSoup</a></td>
    201. 

  201.     <td><span>The MinimalSoup class is for parsing HTML that contains</span></td>
    202. 

  202.   </tr><tr class="class">
    203. 

  203.     
    204. 

  204.     
    205. 

  205.     <td>Class</td>
    206. 

  206.     <td><a href="pymine.beautifulsoup.BeautifulSoup.BeautifulSOAP.html">BeautifulSOAP</a></td>
    207. 

  207.     <td><span>This class will push a tag with only a single string child into</span></td>
    208. 

  208.   </tr><tr class="class">
    209. 

  209.     
    210. 

  210.     
    211. 

  211.     <td>Class</td>
    212. 

  212.     <td><a href="pymine.beautifulsoup.BeautifulSoup.RobustXMLParser.html">RobustXMLParser</a></td>
    213. 

  213.     <td><span class="undocumented">Undocumented</span></td>
    214. 

  214.   </tr><tr class="class">
    215. 

  215.     
    216. 

  216.     
    217. 

  217.     <td>Class</td>
    218. 

  218.     <td><a href="pymine.beautifulsoup.BeautifulSoup.RobustHTMLParser.html">RobustHTMLParser</a></td>
    219. 

  219.     <td><span class="undocumented">Undocumented</span></td>
    220. 

  220.   </tr><tr class="class">
    221. 

  221.     
    222. 

  222.     
    223. 

  223.     <td>Class</td>
    224. 

  224.     <td><a href="pymine.beautifulsoup.BeautifulSoup.RobustWackAssHTMLParser.html">RobustWackAssHTMLParser</a></td>
    225. 

  225.     <td><span class="undocumented">Undocumented</span></td>
    226. 

  226.   </tr><tr class="class">
    227. 

  227.     
    228. 

  228.     
    229. 

  229.     <td>Class</td>
    230. 

  230.     <td><a href="pymine.beautifulsoup.BeautifulSoup.RobustInsanelyWackAssHTMLParser.html">RobustInsanelyWackAssHTMLParser</a></td>
    231. 

  231.     <td><span class="undocumented">Undocumented</span></td>
    232. 

  232.   </tr><tr class="class">
    233. 

  233.     
    234. 

  234.     
    235. 

  235.     <td>Class</td>
    236. 

  236.     <td><a href="pymine.beautifulsoup.BeautifulSoup.SimplifyingSOAPParser.html">SimplifyingSOAPParser</a></td>
    237. 

  237.     <td><span class="undocumented">Undocumented</span></td>
    238. 

  238.   </tr><tr class="class">
    239. 

  239.     
    240. 

  240.     
    241. 

  241.     <td>Class</td>
    242. 

  242.     <td><a href="pymine.beautifulsoup.BeautifulSoup.UnicodeDammit.html">UnicodeDammit</a></td>
    243. 

  243.     <td><span>A class for detecting the encoding of a *ML document and</span></td>
    244. 

  244.   </tr>
    245. 

  245.   
    246. 

  246. </table>
    247. 

  247.       
    248. 

  248.       
    249. 

  249.     </div>
    250. 

  250.     
    251. 

  251.     
    252. 

  252.     
    253. 

  253.     <div class="function">
    254. 

  254.         <a name="pymine.beautifulsoup.BeautifulSoup._match_css_class"></a>
    255. 

  255.         <a name="_match_css_class"></a>
    256. 

  256.         <div class="functionHeader">
    257. 

  257.         
    258. 

  258.         def _match_css_class(str):
    259. 

  259.         
    260. 

  260.       </div>
    261. 

  261.         <div class="functionBody">
    262. 

  262.           
    263. 

  263.           <div>Build a RE to match the given CSS class.<table class="fieldTable"></table></div>
    264. 

  264.         </div>
    265. 

  265.       </div><div class="function">
    266. 

  266.         <a name="pymine.beautifulsoup.BeautifulSoup.buildTagMap"></a>
    267. 

  267.         <a name="buildTagMap"></a>
    268. 

  268.         <div class="functionHeader">
    269. 

  269.         
    270. 

  270.         def buildTagMap(default, *args):
    271. 

  271.         
    272. 

  272.       </div>
    273. 

  273.         <div class="functionBody">
    274. 

  274.           
    275. 

  275.           <div>Turns a list of maps, lists, or scalars into a single map. Used to build
    276. 

  276. the SELF_CLOSING_TAGS, NESTABLE_TAGS, and NESTING_RESET_TAGS maps out of 
    277. 

  277. lists and partial maps.<table class="fieldTable"></table></div>
    278. 

  278.         </div>
    279. 

  279.       </div>
    280. 

  280.     
    281. 

  281.     <address>
    282. 

  282.       <a href="index.html">API Documentation</a> for pymine, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2010-04-07 23:15:24.
    283. 

  283.     </address>
    284. 

  284.   </body>
    285. 

  285. </html>
    286.