~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/HTMLParser.HTMLParser-class.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>HTMLParser.HTMLParser</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        Module&nbsp;HTMLParser ::
 
33
        Class&nbsp;HTMLParser
 
34
      </b></font></br>
 
35
    </td>
 
36
    <td><table cellpadding="0" cellspacing="0">
 
37
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="HTMLParser.HTMLParser-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
38
    </table></td>
 
39
</tr></table>
 
40
 
 
41
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
42
<h2 class="class">Class HTMLParser</h2>
 
43
 
 
44
<pre class="base-tree">
 
45
<a href="markupbase.ParserBase-class.html"><code>ParserBase</code></a> --+
 
46
             |
 
47
            <b>HTMLParser</b>
 
48
</pre><br />
 
49
 
 
50
<hr/>
 
51
 
 
52
<pre class="literalblock">
 
53
Find tags and other markup and call handler functions.
 
54
 
 
55
Usage:
 
56
    p = HTMLParser()
 
57
    p.feed(data)
 
58
    ...
 
59
    p.close()
 
60
 
 
61
Start tags are handled by calling self.handle_starttag() or
 
62
self.handle_startendtag(); end tags by self.handle_endtag().  The
 
63
data between tags is passed from the parser to the derived class
 
64
by calling self.handle_data() with the data as argument (the data
 
65
may be split up in arbitrary chunks).  Entity references are
 
66
passed by calling self.handle_entityref() with the entity
 
67
reference as the argument.  Numeric character references are
 
68
passed to self.handle_charref() with the string containing the
 
69
reference as the argument.
 
70
</pre>
 
71
<hr/>
 
72
 
 
73
 
 
74
<!-- =========== START OF METHOD SUMMARY =========== -->
 
75
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
76
<tr bgcolor="#70b0f0" class="summary">
 
77
  <th colspan="2">Method Summary</th></tr>
 
78
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
79
  <td><code><span class="summary-sig"><a href="HTMLParser.HTMLParser-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
80
<br />
 
81
Initialize and reset this instance.</td></tr>
 
82
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
83
  <td><code><a name="check_for_whole_start_tag"></a><span class="summary-sig"><span class="summary-sig-name">check_for_whole_start_tag</span>(<span class=summary-sig-arg>self</span>,
 
84
          <span class=summary-sig-arg>i</span>)</span></code>
 
85
</td></tr>
 
86
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
87
  <td><code><a name="clear_cdata_mode"></a><span class="summary-sig"><span class="summary-sig-name">clear_cdata_mode</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
88
</td></tr>
 
89
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
90
  <td><code><span class="summary-sig"><a href="HTMLParser.HTMLParser-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
91
<br />
 
92
Handle any buffered data.</td></tr>
 
93
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
94
  <td><code><a name="error"></a><span class="summary-sig"><span class="summary-sig-name">error</span>(<span class=summary-sig-arg>self</span>,
 
95
          <span class=summary-sig-arg>message</span>)</span></code>
 
96
</td></tr>
 
97
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
98
  <td><code><span class="summary-sig"><a href="HTMLParser.HTMLParser-class.html#feed" class="summary-sig-name"><code>feed</code></a>(<span class=summary-sig-arg>self</span>,
 
99
          <span class=summary-sig-arg>data</span>)</span></code>
 
100
<br />
 
101
Feed data to the parser.</td></tr>
 
102
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
103
  <td><code><span class="summary-sig"><a href="HTMLParser.HTMLParser-class.html#get_starttag_text" class="summary-sig-name"><code>get_starttag_text</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
104
<br />
 
105
Return full source of start tag: '&lt;...&gt;'.</td></tr>
 
106
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
107
  <td><code><a name="goahead"></a><span class="summary-sig"><span class="summary-sig-name">goahead</span>(<span class=summary-sig-arg>self</span>,
 
108
          <span class=summary-sig-arg>end</span>)</span></code>
 
109
</td></tr>
 
110
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
111
  <td><code><a name="handle_charref"></a><span class="summary-sig"><span class="summary-sig-name">handle_charref</span>(<span class=summary-sig-arg>self</span>,
 
112
          <span class=summary-sig-arg>name</span>)</span></code>
 
113
</td></tr>
 
114
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
115
  <td><code><a name="handle_comment"></a><span class="summary-sig"><span class="summary-sig-name">handle_comment</span>(<span class=summary-sig-arg>self</span>,
 
116
          <span class=summary-sig-arg>data</span>)</span></code>
 
117
</td></tr>
 
118
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
119
  <td><code><a name="handle_data"></a><span class="summary-sig"><span class="summary-sig-name">handle_data</span>(<span class=summary-sig-arg>self</span>,
 
120
          <span class=summary-sig-arg>data</span>)</span></code>
 
121
</td></tr>
 
122
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
123
  <td><code><a name="handle_decl"></a><span class="summary-sig"><span class="summary-sig-name">handle_decl</span>(<span class=summary-sig-arg>self</span>,
 
124
          <span class=summary-sig-arg>decl</span>)</span></code>
 
125
</td></tr>
 
126
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
127
  <td><code><a name="handle_endtag"></a><span class="summary-sig"><span class="summary-sig-name">handle_endtag</span>(<span class=summary-sig-arg>self</span>,
 
128
          <span class=summary-sig-arg>tag</span>)</span></code>
 
129
</td></tr>
 
130
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
131
  <td><code><a name="handle_entityref"></a><span class="summary-sig"><span class="summary-sig-name">handle_entityref</span>(<span class=summary-sig-arg>self</span>,
 
132
          <span class=summary-sig-arg>name</span>)</span></code>
 
133
</td></tr>
 
134
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
135
  <td><code><a name="handle_pi"></a><span class="summary-sig"><span class="summary-sig-name">handle_pi</span>(<span class=summary-sig-arg>self</span>,
 
136
          <span class=summary-sig-arg>data</span>)</span></code>
 
137
</td></tr>
 
138
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
139
  <td><code><a name="handle_startendtag"></a><span class="summary-sig"><span class="summary-sig-name">handle_startendtag</span>(<span class=summary-sig-arg>self</span>,
 
140
          <span class=summary-sig-arg>tag</span>,
 
141
          <span class=summary-sig-arg>attrs</span>)</span></code>
 
142
</td></tr>
 
143
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
144
  <td><code><a name="handle_starttag"></a><span class="summary-sig"><span class="summary-sig-name">handle_starttag</span>(<span class=summary-sig-arg>self</span>,
 
145
          <span class=summary-sig-arg>tag</span>,
 
146
          <span class=summary-sig-arg>attrs</span>)</span></code>
 
147
</td></tr>
 
148
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
149
  <td><code><a name="parse_endtag"></a><span class="summary-sig"><span class="summary-sig-name">parse_endtag</span>(<span class=summary-sig-arg>self</span>,
 
150
          <span class=summary-sig-arg>i</span>)</span></code>
 
151
</td></tr>
 
152
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
153
  <td><code><a name="parse_pi"></a><span class="summary-sig"><span class="summary-sig-name">parse_pi</span>(<span class=summary-sig-arg>self</span>,
 
154
          <span class=summary-sig-arg>i</span>)</span></code>
 
155
</td></tr>
 
156
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
157
  <td><code><a name="parse_starttag"></a><span class="summary-sig"><span class="summary-sig-name">parse_starttag</span>(<span class=summary-sig-arg>self</span>,
 
158
          <span class=summary-sig-arg>i</span>)</span></code>
 
159
</td></tr>
 
160
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
161
  <td><code><span class="summary-sig"><a href="HTMLParser.HTMLParser-class.html#reset" class="summary-sig-name"><code>reset</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
162
<br />
 
163
Reset this instance.</td></tr>
 
164
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
165
  <td><code><a name="set_cdata_mode"></a><span class="summary-sig"><span class="summary-sig-name">set_cdata_mode</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
166
</td></tr>
 
167
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
168
  <td><code><a name="unescape"></a><span class="summary-sig"><span class="summary-sig-name">unescape</span>(<span class=summary-sig-arg>self</span>,
 
169
          <span class=summary-sig-arg>s</span>)</span></code>
 
170
</td></tr>
 
171
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
172
  <td><code><a name="unknown_decl"></a><span class="summary-sig"><span class="summary-sig-name">unknown_decl</span>(<span class=summary-sig-arg>self</span>,
 
173
          <span class=summary-sig-arg>data</span>)</span></code>
 
174
</td></tr>
 
175
  <tr><td colspan="2">
 
176
    <b>Inherited from <a href="markupbase.ParserBase-class.html"><code>ParserBase</code></a>:</b>
 
177
      <a href="markupbase.ParserBase-class.html#getpos"><code>getpos</code></a>, 
 
178
      <a href="markupbase.ParserBase-class.html#parse_comment"><code>parse_comment</code></a>, 
 
179
      <a href="markupbase.ParserBase-class.html#parse_declaration"><code>parse_declaration</code></a>, 
 
180
      <a href="markupbase.ParserBase-class.html#parse_marked_section"><code>parse_marked_section</code></a>, 
 
181
      <a href="markupbase.ParserBase-class.html#updatepos"><code>updatepos</code></a>
 
182
    </td></tr>
 
183
</table><br />
 
184
 
 
185
 
 
186
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
187
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
188
<tr bgcolor="#70b0f0" class="summary">
 
189
  <th colspan="2">Class Variable Summary</th></tr>
 
190
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
 
191
<td><b><a href="HTMLParser.HTMLParser-class.html#CDATA_CONTENT_ELEMENTS"><code>CDATA_CONTENT_ELEMENTS</code></a></b> = <span title="('script', 'style')"><code>('script',&nbsp;'style')             </code>
 
192
</span></td></tr>
 
193
  <tr><td colspan="2">
 
194
 
 
195
    </td></tr>
 
196
</table><br />
 
197
 
 
198
 
 
199
<!-- =========== START OF METHOD DETAILS =========== -->
 
200
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
201
<tr bgcolor="#70b0f0" class="details">
 
202
  <th colspan="2">Method Details</th></tr>
 
203
</table>
 
204
 
 
205
<a name="__init__"></a>
 
206
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
207
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>)</span>
 
208
    <br /><i>(Constructor)</i>
 
209
  </h3>
 
210
  Initialize and reset this instance.
 
211
  <dl><dt></dt><dd>
 
212
    <dl><dt><b>Overrides:</b></dt>
 
213
      <dd><a href="markupbase.ParserBase-class.html#__init__"><code>markupbase.ParserBase.__init__</code></a></dd>
 
214
    </dl>
 
215
  </dd></dl>
 
216
</td></tr></table>
 
217
 
 
218
<a name="close"></a>
 
219
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
220
  <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span>
 
221
  </h3>
 
222
  Handle any buffered data.
 
223
  <dl><dt></dt><dd>
 
224
  </dd></dl>
 
225
</td></tr></table>
 
226
 
 
227
<a name="feed"></a>
 
228
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
229
  <h3><span class="sig"><span class="sig-name">feed</span>(<span class=sig-arg>self</span>,
 
230
          <span class=sig-arg>data</span>)</span>
 
231
  </h3>
 
232
<pre class="literalblock">
 
233
Feed data to the parser.
 
234
 
 
235
        Call this as often as you want, with as little or as much text
 
236
        as you want (may include '
 
237
').
 
238
</pre>
 
239
  <dl><dt></dt><dd>
 
240
  </dd></dl>
 
241
</td></tr></table>
 
242
 
 
243
<a name="get_starttag_text"></a>
 
244
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
245
  <h3><span class="sig"><span class="sig-name">get_starttag_text</span>(<span class=sig-arg>self</span>)</span>
 
246
  </h3>
 
247
  Return full source of start tag: '&lt;...&gt;'.
 
248
  <dl><dt></dt><dd>
 
249
  </dd></dl>
 
250
</td></tr></table>
 
251
 
 
252
<a name="reset"></a>
 
253
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
254
  <h3><span class="sig"><span class="sig-name">reset</span>(<span class=sig-arg>self</span>)</span>
 
255
  </h3>
 
256
  Reset this instance. Loses all unprocessed data.
 
257
  <dl><dt></dt><dd>
 
258
    <dl><dt><b>Overrides:</b></dt>
 
259
      <dd><a href="markupbase.ParserBase-class.html#reset"><code>markupbase.ParserBase.reset</code></a></dd>
 
260
    </dl>
 
261
  </dd></dl>
 
262
</td></tr></table>
 
263
<br />
 
264
 
 
265
 
 
266
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
267
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
268
<tr bgcolor="#70b0f0" class="details">
 
269
  <th colspan="2">Class Variable Details</th></tr>
 
270
</table>
 
271
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
272
<a name="CDATA_CONTENT_ELEMENTS"></a>
 
273
<h3>CDATA_CONTENT_ELEMENTS</h3>
 
274
<dl>
 
275
  <dt></dt>
 
276
  <dd>
 
277
    <dl>
 
278
      <dt><b>Type:</b></dt>
 
279
      <dd>
 
280
          <code>tuple</code>
 
281
 
 
282
      </dd>
 
283
<span title="('script', 'style')">      <dt><b>Value:</b></dt>
 
284
      <dd><table><tr><td>
 
285
<pre class="variable">
 
286
('script', 'style')                                                    </pre>
 
287
        </td></tr></table></dd>
 
288
</span>    </dl>
 
289
  </dd>
 
290
</dl></td></tr></table>
 
291
<br />
 
292
 
 
293
 
 
294
<!-- =========== START OF NAVBAR =========== -->
 
295
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
296
  <tr valign="center">
 
297
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
298
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
299
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
300
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
301
    <th class="navbar" align="right" width="100%">
 
302
      <table border="0" cellpadding="0" cellspacing="0">
 
303
      <tr><th class="navbar" align="center">
 
304
        <p class="nomargin">
 
305
          <a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
 
306
      </p></th></tr></table>
 
307
    </th>
 
308
  </tr>
 
309
</table>
 
310
 
 
311
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
312
  <tr>
 
313
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:13 2007</font></td>
 
314
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
315
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
316
  </tr>
 
317
</table>
 
318
</body>
 
319
</html>