1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
:mod:`html.parser` --- Simple HTML and XHTML parser
===================================================
.. module:: html.parser
:synopsis: A simple parser that can handle HTML and XHTML.
.. index::
single: HTML
single: XHTML
This module defines a class :class:`HTMLParser` which serves as the basis for
parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML.
.. class:: HTMLParser(strict=True)
Create a parser instance. If *strict* is ``True`` (the default), invalid
html results in :exc:`~html.parser.HTMLParseError` exceptions [#]_. If
*strict* is ``False``, the parser uses heuristics to make a best guess at
the intention of any invalid html it encounters, similar to the way most
browsers do.
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.
This parser does not check that end tags match start tags or call the end-tag
handler for elements which are closed implicitly by closing an outer element.
.. versionchanged:: 3.2 *strict* keyword added
An exception is defined as well:
.. exception:: HTMLParseError
Exception raised by the :class:`HTMLParser` class when it encounters an error
while parsing. This exception provides three attributes: :attr:`msg` is a brief
message explaining the error, :attr:`lineno` is the number of the line on which
the broken construct was detected, and :attr:`offset` is the number of
characters into the line at which the construct starts.
:class:`HTMLParser` instances have the following methods:
.. method:: HTMLParser.reset()
Reset the instance. Loses all unprocessed data. This is called implicitly at
instantiation time.
.. method:: HTMLParser.feed(data)
Feed some text to the parser. It is processed insofar as it consists of
complete elements; incomplete data is buffered until more data is fed or
:meth:`close` is called.
.. method:: HTMLParser.close()
Force processing of all buffered data as if it were followed by an end-of-file
mark. This method may be redefined by a derived class to define additional
processing at the end of the input, but the redefined version should always call
the :class:`HTMLParser` base class method :meth:`close`.
.. method:: HTMLParser.getpos()
Return current line number and offset.
.. method:: HTMLParser.get_starttag_text()
Return the text of the most recently opened start tag. This should not normally
be needed for structured processing, but may be useful in dealing with HTML "as
deployed" or for re-generating input with minimal changes (whitespace between
attributes can be preserved, etc.).
.. method:: HTMLParser.handle_starttag(tag, attrs)
This method is called to handle the start of a tag. It is intended to be
overridden by a derived class; the base class implementation does nothing.
The *tag* argument is the name of the tag converted to lower case. The *attrs*
argument is a list of ``(name, value)`` pairs containing the attributes found
inside the tag's ``<>`` brackets. The *name* will be translated to lower case,
and quotes in the *value* have been removed, and character and entity references
have been replaced. For instance, for the tag ``<A
HREF="http://www.cwi.nl/">``, this method would be called as
``handle_starttag('a', [('href', 'http://www.cwi.nl/')])``.
All entity references from :mod:`html.entities` are replaced in the attribute
values.
.. method:: HTMLParser.handle_startendtag(tag, attrs)
Similar to :meth:`handle_starttag`, but called when the parser encounters an
XHTML-style empty tag (``<a .../>``). This method may be overridden by
subclasses which require this particular lexical information; the default
implementation simple calls :meth:`handle_starttag` and :meth:`handle_endtag`.
.. method:: HTMLParser.handle_endtag(tag)
This method is called to handle the end tag of an element. It is intended to be
overridden by a derived class; the base class implementation does nothing. The
*tag* argument is the name of the tag converted to lower case.
.. method:: HTMLParser.handle_data(data)
This method is called to process arbitrary data. It is intended to be
overridden by a derived class; the base class implementation does nothing.
.. method:: HTMLParser.handle_charref(name)
This method is called to process a character reference of the form ``&#ref;``.
It is intended to be overridden by a derived class; the base class
implementation does nothing.
.. method:: HTMLParser.handle_entityref(name)
This method is called to process a general entity reference of the form
``&name;`` where *name* is an general entity reference. It is intended to be
overridden by a derived class; the base class implementation does nothing.
.. method:: HTMLParser.handle_comment(data)
This method is called when a comment is encountered. The *comment* argument is
a string containing the text between the ``--`` and ``--`` delimiters, but not
the delimiters themselves. For example, the comment ``<!--text-->`` will cause
this method to be called with the argument ``'text'``. It is intended to be
overridden by a derived class; the base class implementation does nothing.
.. method:: HTMLParser.handle_decl(decl)
Method called when an SGML ``doctype`` declaration is read by the parser.
The *decl* parameter will be the entire contents of the declaration inside
the ``<!...>`` markup. It is intended to be overridden by a derived class;
the base class implementation does nothing.
.. method:: HTMLParser.unknown_decl(data)
Method called when an unrecognized SGML declaration is read by the parser.
The *data* parameter will be the entire contents of the declaration inside
the ``<!...>`` markup. It is sometimes useful to be be overridden by a
derived class; the base class implementation raises an :exc:`HTMLParseError`.
.. method:: HTMLParser.handle_pi(data)
Method called when a processing instruction is encountered. The *data*
parameter will contain the entire processing instruction. For example, for the
processing instruction ``<?proc color='red'>``, this method would be called as
``handle_pi("proc color='red'")``. It is intended to be overridden by a derived
class; the base class implementation does nothing.
.. note::
The :class:`HTMLParser` class uses the SGML syntactic rules for processing
instructions. An XHTML processing instruction using the trailing ``'?'`` will
cause the ``'?'`` to be included in *data*.
.. _htmlparser-example:
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 html.parser import HTMLParser
>>>
>>> class MyHTMLParser(HTMLParser):
... def handle_starttag(self, tag, attrs):
... print("Encountered a {} start tag".format(tag))
... def handle_endtag(self, tag):
... print("Encountered a {} end tag".format(tag))
...
>>> page = """<html><h1>Title</h1><p>I'm a paragraph!</p></html>"""
>>>
>>> myparser = MyHTMLParser()
>>> myparser.feed(page)
Encountered a html start tag
Encountered a h1 start tag
Encountered a h1 end tag
Encountered a p start tag
Encountered a p end tag
Encountered a html end tag
.. rubric:: Footnotes
.. [#] For backward compatibility reasons *strict* mode does not raise
exceptions for all non-compliant HTML. That is, some invalid HTML
is tolerated even in *strict* mode.
|
