PageRenderTime 27ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

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

http://pymine.googlecode.com/
HTML | 525 lines | 379 code | 146 blank | 0 comment | 0 complexity | e488db75f9d55883739b05f5896c7a13 MD5 | raw file
Possible License(s): Apache-2.0, LGPL-2.1
  1. <!DOCTYPE html
  2. PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3. "DTD/xhtml1-strict.dtd">
  4. <html>
  5. <head>
  6. <title>API docs for &ldquo;pymine.beautifulsoup.BeautifulSoup.PageElement&rdquo;</title>
  7. <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
  8. <link href="apidocs.css" type="text/css" rel="stylesheet" />
  9. </head>
  10. <body>
  11. <h1 class="class">Class p.b.B.PageElement(<span title="object">object</span>):</h1>
  12. <p>
  13. <span id="part">Part of <a href="pymine.html">pymine</a>.<a href="pymine.beautifulsoup.html">beautifulsoup</a>.<a href="pymine.beautifulsoup.BeautifulSoup.html">BeautifulSoup</a></span>
  14. <a href="classIndex.html#pymine.beautifulsoup.BeautifulSoup.PageElement">View In Hierarchy</a>
  15. </p>
  16. <div>
  17. <p>Known subclasses: <a href="pymine.beautifulsoup.BeautifulSoup.NavigableString.html">pymine.beautifulsoup.BeautifulSoup.NavigableString</a>, <a href="pymine.beautifulsoup.BeautifulSoup.Tag.html">pymine.beautifulsoup.BeautifulSoup.Tag</a></p>
  18. </div>
  19. <div>Contains the navigational information for some part of the page (either
  20. a tag or a piece of text)<table class="fieldTable"></table></div>
  21. <div id="splitTables">
  22. <table class="children sortable" id="id45">
  23. <tr class="method">
  24. <td>Method</td>
  25. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#setup">setup</a></td>
  26. <td><span>Sets up the initial relations between this element and</span></td>
  27. </tr><tr class="method">
  28. <td>Method</td>
  29. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#replaceWith">replaceWith</a></td>
  30. <td><span class="undocumented">Undocumented</span></td>
  31. </tr><tr class="method">
  32. <td>Method</td>
  33. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#replaceWithChildren">replaceWithChildren</a></td>
  34. <td><span class="undocumented">Undocumented</span></td>
  35. </tr><tr class="method">
  36. <td>Method</td>
  37. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#extract">extract</a></td>
  38. <td><span>Destructively rips this element out of the tree.</span></td>
  39. </tr><tr class="method">
  40. <td>Method</td>
  41. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#_lastRecursiveChild">_lastRecursiveChild</a></td>
  42. <td><span>Finds the last element beneath this object to be parsed.</span></td>
  43. </tr><tr class="method">
  44. <td>Method</td>
  45. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#insert">insert</a></td>
  46. <td><span class="undocumented">Undocumented</span></td>
  47. </tr><tr class="method">
  48. <td>Method</td>
  49. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#append">append</a></td>
  50. <td><span>Appends the given tag to the contents of this tag.</span></td>
  51. </tr><tr class="method">
  52. <td>Method</td>
  53. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findNext">findNext</a></td>
  54. <td><span>Returns the first item that matches the given criteria and</span></td>
  55. </tr><tr class="method">
  56. <td>Method</td>
  57. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findAllNext">findAllNext</a></td>
  58. <td><span>Returns all items that match the given criteria and appear</span></td>
  59. </tr><tr class="method">
  60. <td>Method</td>
  61. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findNextSibling">findNextSibling</a></td>
  62. <td><span>Returns the closest sibling to this Tag that matches the</span></td>
  63. </tr><tr class="method">
  64. <td>Method</td>
  65. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findNextSiblings">findNextSiblings</a></td>
  66. <td><span>Returns the siblings of this Tag that match the given</span></td>
  67. </tr><tr class="method">
  68. <td>Method</td>
  69. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findPrevious">findPrevious</a></td>
  70. <td><span>Returns the first item that matches the given criteria and</span></td>
  71. </tr><tr class="method">
  72. <td>Method</td>
  73. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findAllPrevious">findAllPrevious</a></td>
  74. <td><span>Returns all items that match the given criteria and appear</span></td>
  75. </tr><tr class="method">
  76. <td>Method</td>
  77. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findPreviousSibling">findPreviousSibling</a></td>
  78. <td><span>Returns the closest sibling to this Tag that matches the</span></td>
  79. </tr><tr class="method">
  80. <td>Method</td>
  81. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findPreviousSiblings">findPreviousSiblings</a></td>
  82. <td><span>Returns the siblings of this Tag that match the given</span></td>
  83. </tr><tr class="method">
  84. <td>Method</td>
  85. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findParent">findParent</a></td>
  86. <td><span>Returns the closest parent of this Tag that matches the given</span></td>
  87. </tr><tr class="method">
  88. <td>Method</td>
  89. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#findParents">findParents</a></td>
  90. <td><span>Returns the parents of this Tag that match the given</span></td>
  91. </tr><tr class="method">
  92. <td>Method</td>
  93. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#_findOne">_findOne</a></td>
  94. <td><span class="undocumented">Undocumented</span></td>
  95. </tr><tr class="method">
  96. <td>Method</td>
  97. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#_findAll">_findAll</a></td>
  98. <td><span>Iterates over a generator looking for things that match.</span></td>
  99. </tr><tr class="method">
  100. <td>Method</td>
  101. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#nextGenerator">nextGenerator</a></td>
  102. <td><span class="undocumented">Undocumented</span></td>
  103. </tr><tr class="method">
  104. <td>Method</td>
  105. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#nextSiblingGenerator">nextSiblingGenerator</a></td>
  106. <td><span class="undocumented">Undocumented</span></td>
  107. </tr><tr class="method">
  108. <td>Method</td>
  109. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#previousGenerator">previousGenerator</a></td>
  110. <td><span class="undocumented">Undocumented</span></td>
  111. </tr><tr class="method">
  112. <td>Method</td>
  113. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#previousSiblingGenerator">previousSiblingGenerator</a></td>
  114. <td><span class="undocumented">Undocumented</span></td>
  115. </tr><tr class="method">
  116. <td>Method</td>
  117. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#parentGenerator">parentGenerator</a></td>
  118. <td><span class="undocumented">Undocumented</span></td>
  119. </tr><tr class="method">
  120. <td>Method</td>
  121. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#substituteEncoding">substituteEncoding</a></td>
  122. <td><span class="undocumented">Undocumented</span></td>
  123. </tr><tr class="method">
  124. <td>Method</td>
  125. <td><a href="pymine.beautifulsoup.BeautifulSoup.PageElement.html#toEncoding">toEncoding</a></td>
  126. <td><span>Encodes an object to a string in some encoding, or to Unicode.</span></td>
  127. </tr>
  128. </table>
  129. </div>
  130. <div class="function">
  131. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.setup"></a>
  132. <a name="setup"></a>
  133. <div class="functionHeader">
  134. def setup(self, parent=None, previous=None):
  135. </div>
  136. <div class="functionBody">
  137. <div>Sets up the initial relations between this element and other
  138. elements.<table class="fieldTable"></table></div>
  139. </div>
  140. </div><div class="function">
  141. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.replaceWith"></a>
  142. <a name="replaceWith"></a>
  143. <div class="functionHeader">
  144. def replaceWith(self, replaceWith):
  145. </div>
  146. <div class="functionBody">
  147. <div class="undocumented">Undocumented</div>
  148. </div>
  149. </div><div class="function">
  150. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.replaceWithChildren"></a>
  151. <a name="replaceWithChildren"></a>
  152. <div class="functionHeader">
  153. def replaceWithChildren(self):
  154. </div>
  155. <div class="functionBody">
  156. <div class="undocumented">Undocumented</div>
  157. </div>
  158. </div><div class="function">
  159. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.extract"></a>
  160. <a name="extract"></a>
  161. <div class="functionHeader">
  162. def extract(self):
  163. </div>
  164. <div class="functionBody">
  165. <div>Destructively rips this element out of the tree.<table class="fieldTable"></table></div>
  166. </div>
  167. </div><div class="function">
  168. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement._lastRecursiveChild"></a>
  169. <a name="_lastRecursiveChild"></a>
  170. <div class="functionHeader">
  171. def _lastRecursiveChild(self):
  172. </div>
  173. <div class="functionBody">
  174. <div>Finds the last element beneath this object to be parsed.<table class="fieldTable"></table></div>
  175. </div>
  176. </div><div class="function">
  177. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.insert"></a>
  178. <a name="insert"></a>
  179. <div class="functionHeader">
  180. def insert(self, position, newChild):
  181. </div>
  182. <div class="functionBody">
  183. <div class="undocumented">Undocumented</div>
  184. </div>
  185. </div><div class="function">
  186. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.append"></a>
  187. <a name="append"></a>
  188. <div class="functionHeader">
  189. def append(self, tag):
  190. </div>
  191. <div class="functionBody">
  192. <div>Appends the given tag to the contents of this tag.<table class="fieldTable"></table></div>
  193. </div>
  194. </div><div class="function">
  195. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findNext"></a>
  196. <a name="findNext"></a>
  197. <div class="functionHeader">
  198. def findNext(self, name=None, attrs={}, text=None, **kwargs):
  199. </div>
  200. <div class="functionBody">
  201. <div>Returns the first item that matches the given criteria and appears after
  202. this Tag in the document.<table class="fieldTable"></table></div>
  203. </div>
  204. </div><div class="function">
  205. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findAllNext"></a>
  206. <a name="findAllNext"></a>
  207. <div class="functionHeader">
  208. def findAllNext(self, name=None, attrs={}, text=None, limit=None, **kwargs):
  209. </div>
  210. <div class="functionBody">
  211. <div>Returns all items that match the given criteria and appear after this
  212. Tag in the document.<table class="fieldTable"></table></div>
  213. </div>
  214. </div><div class="function">
  215. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findNextSibling"></a>
  216. <a name="findNextSibling"></a>
  217. <div class="functionHeader">
  218. def findNextSibling(self, name=None, attrs={}, text=None, **kwargs):
  219. </div>
  220. <div class="functionBody">
  221. <div>Returns the closest sibling to this Tag that matches the given criteria
  222. and appears after this Tag in the document.<table class="fieldTable"></table></div>
  223. </div>
  224. </div><div class="function">
  225. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findNextSiblings"></a>
  226. <a name="findNextSiblings"></a>
  227. <div class="functionHeader">
  228. def findNextSiblings(self, name=None, attrs={}, text=None, limit=None, **kwargs):
  229. </div>
  230. <div class="functionBody">
  231. <div>Returns the siblings of this Tag that match the given criteria and
  232. appear after this Tag in the document.<table class="fieldTable"></table></div>
  233. </div>
  234. </div><div class="function">
  235. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findPrevious"></a>
  236. <a name="findPrevious"></a>
  237. <div class="functionHeader">
  238. def findPrevious(self, name=None, attrs={}, text=None, **kwargs):
  239. </div>
  240. <div class="functionBody">
  241. <div>Returns the first item that matches the given criteria and appears
  242. before this Tag in the document.<table class="fieldTable"></table></div>
  243. </div>
  244. </div><div class="function">
  245. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findAllPrevious"></a>
  246. <a name="findAllPrevious"></a>
  247. <div class="functionHeader">
  248. def findAllPrevious(self, name=None, attrs={}, text=None, limit=None, **kwargs):
  249. </div>
  250. <div class="functionBody">
  251. <div>Returns all items that match the given criteria and appear before this
  252. Tag in the document.<table class="fieldTable"></table></div>
  253. </div>
  254. </div><div class="function">
  255. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findPreviousSibling"></a>
  256. <a name="findPreviousSibling"></a>
  257. <div class="functionHeader">
  258. def findPreviousSibling(self, name=None, attrs={}, text=None, **kwargs):
  259. </div>
  260. <div class="functionBody">
  261. <div>Returns the closest sibling to this Tag that matches the given criteria
  262. and appears before this Tag in the document.<table class="fieldTable"></table></div>
  263. </div>
  264. </div><div class="function">
  265. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findPreviousSiblings"></a>
  266. <a name="findPreviousSiblings"></a>
  267. <div class="functionHeader">
  268. def findPreviousSiblings(self, name=None, attrs={}, text=None, limit=None, **kwargs):
  269. </div>
  270. <div class="functionBody">
  271. <div>Returns the siblings of this Tag that match the given criteria and
  272. appear before this Tag in the document.<table class="fieldTable"></table></div>
  273. </div>
  274. </div><div class="function">
  275. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findParent"></a>
  276. <a name="findParent"></a>
  277. <div class="functionHeader">
  278. def findParent(self, name=None, attrs={}, **kwargs):
  279. </div>
  280. <div class="functionBody">
  281. <div>Returns the closest parent of this Tag that matches the given
  282. criteria.<table class="fieldTable"></table></div>
  283. </div>
  284. </div><div class="function">
  285. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.findParents"></a>
  286. <a name="findParents"></a>
  287. <div class="functionHeader">
  288. def findParents(self, name=None, attrs={}, limit=None, **kwargs):
  289. </div>
  290. <div class="functionBody">
  291. <div>Returns the parents of this Tag that match the given criteria.<table class="fieldTable"></table></div>
  292. </div>
  293. </div><div class="function">
  294. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement._findOne"></a>
  295. <a name="_findOne"></a>
  296. <div class="functionHeader">
  297. def _findOne(self, method, name, attrs, text, **kwargs):
  298. </div>
  299. <div class="functionBody">
  300. <div class="undocumented">Undocumented</div>
  301. </div>
  302. </div><div class="function">
  303. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement._findAll"></a>
  304. <a name="_findAll"></a>
  305. <div class="functionHeader">
  306. def _findAll(self, name, attrs, text, limit, generator, **kwargs):
  307. </div>
  308. <div class="functionBody">
  309. <div>Iterates over a generator looking for things that match.<table class="fieldTable"></table></div>
  310. </div>
  311. </div><div class="function">
  312. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.nextGenerator"></a>
  313. <a name="nextGenerator"></a>
  314. <div class="functionHeader">
  315. def nextGenerator(self):
  316. </div>
  317. <div class="functionBody">
  318. <div class="undocumented">Undocumented</div>
  319. </div>
  320. </div><div class="function">
  321. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.nextSiblingGenerator"></a>
  322. <a name="nextSiblingGenerator"></a>
  323. <div class="functionHeader">
  324. def nextSiblingGenerator(self):
  325. </div>
  326. <div class="functionBody">
  327. <div class="undocumented">Undocumented</div>
  328. </div>
  329. </div><div class="function">
  330. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.previousGenerator"></a>
  331. <a name="previousGenerator"></a>
  332. <div class="functionHeader">
  333. def previousGenerator(self):
  334. </div>
  335. <div class="functionBody">
  336. <div class="undocumented">Undocumented</div>
  337. </div>
  338. </div><div class="function">
  339. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.previousSiblingGenerator"></a>
  340. <a name="previousSiblingGenerator"></a>
  341. <div class="functionHeader">
  342. def previousSiblingGenerator(self):
  343. </div>
  344. <div class="functionBody">
  345. <div class="undocumented">Undocumented</div>
  346. </div>
  347. </div><div class="function">
  348. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.parentGenerator"></a>
  349. <a name="parentGenerator"></a>
  350. <div class="functionHeader">
  351. def parentGenerator(self):
  352. </div>
  353. <div class="functionBody">
  354. <div class="undocumented">Undocumented</div>
  355. </div>
  356. </div><div class="function">
  357. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.substituteEncoding"></a>
  358. <a name="substituteEncoding"></a>
  359. <div class="functionHeader">
  360. def substituteEncoding(self, str, encoding=None):
  361. </div>
  362. <div class="functionBody">
  363. <div class="undocumented">Undocumented</div>
  364. </div>
  365. </div><div class="function">
  366. <a name="pymine.beautifulsoup.BeautifulSoup.PageElement.toEncoding"></a>
  367. <a name="toEncoding"></a>
  368. <div class="functionHeader">
  369. def toEncoding(self, s, encoding=None):
  370. </div>
  371. <div class="functionBody">
  372. <div>Encodes an object to a string in some encoding, or to Unicode. .<table class="fieldTable"></table></div>
  373. </div>
  374. </div>
  375. <address>
  376. <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.
  377. </address>
  378. </body>
  379. </html>