cpython/Doc/library/html.parser.rst

: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

**Source code:** :source:`Lib/html/parser.py`

--------------

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=False)

   Create a parser instance.  If *strict* is ``False`` (the default), the parser
   will accept and parse invalid markup.  If *strict* is ``True`` the parser
   will raise an :exc:`~html.parser.HTMLParseError` exception instead [#]_ when
   it's not able to parse the markup.
   The use of ``strict=True`` is discouraged and the *strict* argument is
   deprecated.

   An :class:`.HTMLParser` instance is fed HTML data and calls handler methods
   when start tags, end tags, text, comments, and other markup elements are
   encountered.  The user should subclass :class:`.HTMLParser` and override its
   methods to implement the 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.

   .. deprecated-removed:: 3.3 3.5
      The *strict* argument and the strict mode have been deprecated.
      The parser is now able to accept and parse invalid markup too.

An exception is defined as well:


.. exception:: HTMLParseError

   Exception raised by the :class:`HTMLParser` class when it encounters an error
   while parsing and *strict* is ``True``.  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.

   .. deprecated-removed:: 3.3 3.5
      This exception has been deprecated because it's never raised by the parser
      (when the default non-strict mode is used).


Example HTML Parser Application
-------------------------------

As a basic example, below is a simple HTML parser that uses the
:class:`HTMLParser` class to print out start tags, end tags, and data
as they are encountered::

   from html.parser import HTMLParser

   class MyHTMLParser(HTMLParser):
       def handle_starttag(self, tag, attrs):
           print("Encountered a start tag:", tag)
       def handle_endtag(self, tag):
           print("Encountered an end tag :", tag)
       def handle_data(self, data):
           print("Encountered some data  :", data)

   parser = MyHTMLParser()
   parser.feed('<html><head><title>Test</title></head>'
               '<body><h1>Parse me!</h1></body></html>')

The output will then be::

   Encountered a start tag: html
   Encountered a start tag: head
   Encountered a start tag: title
   Encountered some data  : Test
   Encountered an end tag : title
   Encountered an end tag : head
   Encountered a start tag: body
   Encountered a start tag: h1
   Encountered some data  : Parse me!
   Encountered an end tag : h1
   Encountered an end tag : body
   Encountered an end tag : html


:class:`.HTMLParser` Methods
----------------------------

:class:`HTMLParser` instances have the following methods:


.. 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.  *data* must be :class:`str`.


.. 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.reset()

   Reset the instance.  Loses all unprocessed data.  This is called implicitly at
   instantiation time.


.. 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.).


The following methods are called when data or markup elements are encountered
and they are meant to be overridden in a subclass.  The base class
implementations do nothing (except for :meth:`~HTMLParser.handle_startendtag`):


.. method:: HTMLParser.handle_starttag(tag, attrs)

   This method is called to handle the start of a tag (e.g. ``<div id="main">``).

   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_endtag(tag)

   This method is called to handle the end tag of an element (e.g. ``</div>``).

   The *tag* argument is the name of the tag converted to lower case.


.. method:: HTMLParser.handle_startendtag(tag, attrs)

   Similar to :meth:`handle_starttag`, but called when the parser encounters an
   XHTML-style empty tag (``<img ... />``).  This method may be overridden by
   subclasses which require this particular lexical information; the default
   implementation simply calls :meth:`handle_starttag` and :meth:`handle_endtag`.


.. method:: HTMLParser.handle_data(data)

   This method is called to process arbitrary data (e.g. text nodes and the
   content of ``<script>...</script>`` and ``<style>...</style>``).


.. method:: HTMLParser.handle_entityref(name)

   This method is called to process a named character reference of the form
   ``&name;`` (e.g. ``&gt;``), where *name* is a general entity reference
   (e.g. ``'gt'``).


.. method:: HTMLParser.handle_charref(name)

   This method is called to process decimal and hexadecimal numeric character
   references of the form ``&#NNN;`` and ``&#xNNN;``.  For example, the decimal
   equivalent for ``&gt;`` is ``&#62;``, whereas the hexadecimal is ``&#x3E;``;
   in this case the method will receive ``'62'`` or ``'x3E'``.


.. method:: HTMLParser.handle_comment(data)

   This method is called when a comment is encountered (e.g. ``<!--comment-->``).

   For example, the comment ``<!-- comment -->`` will cause this method to be
   called with the argument ``' comment '``.

   The content of Internet Explorer conditional comments (condcoms) will also be
   sent to this method, so, for ``<!--[if IE 9]>IE9-specific content<![endif]-->``,
   this method will receive ``'[if IE 9]>IE-specific content<![endif]'``.


.. method:: HTMLParser.handle_decl(decl)

   This method is called to handle an HTML doctype declaration (e.g.
   ``<!DOCTYPE html>``).

   The *decl* parameter will be the entire contents of the declaration inside
   the ``<!...>`` markup (e.g. ``'DOCTYPE html'``).


.. 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*.


.. method:: HTMLParser.unknown_decl(data)

   This method is called when an unrecognized 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 overridden by a
   derived class.  The base class implementation raises an :exc:`HTMLParseError`
   when *strict* is ``True``.


.. _htmlparser-examples:

Examples
--------

The following class implements a parser that will be used to illustrate more
examples::

   from html.parser import HTMLParser
   from html.entities import name2codepoint

   class MyHTMLParser(HTMLParser):
       def handle_starttag(self, tag, attrs):
           print("Start tag:", tag)
           for attr in attrs:
               print("     attr:", attr)
       def handle_endtag(self, tag):
           print("End tag  :", tag)
       def handle_data(self, data):
           print("Data     :", data)
       def handle_comment(self, data):
           print("Comment  :", data)
       def handle_entityref(self, name):
           c = chr(name2codepoint[name])
           print("Named ent:", c)
       def handle_charref(self, name):
           if name.startswith('x'):
               c = chr(int(name[1:], 16))
           else:
               c = chr(int(name))
           print("Num ent  :", c)
       def handle_decl(self, data):
           print("Decl     :", data)

   parser = MyHTMLParser()

Parsing a doctype::

   >>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '
   ...             '"http://www.w3.org/TR/html4/strict.dtd">')
   Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"

Parsing an element with a few attributes and a title::

   >>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
   Start tag: img
        attr: ('src', 'python-logo.png')
        attr: ('alt', 'The Python logo')
   >>>
   >>> parser.feed('<h1>Python</h1>')
   Start tag: h1
   Data     : Python
   End tag  : h1

The content of ``script`` and ``style`` elements is returned as is, without
further parsing::

   >>> parser.feed('<style type="text/css">#python { color: green }</style>')
   Start tag: style
        attr: ('type', 'text/css')
   Data     : #python { color: green }
   End tag  : style
   >>>
   >>> parser.feed('<script type="text/javascript">'
   ...             'alert("<strong>hello!</strong>");</script>')
   Start tag: script
        attr: ('type', 'text/javascript')
   Data     : alert("<strong>hello!</strong>");
   End tag  : script

Parsing comments::

   >>> parser.feed('<!-- a comment -->'
   ...             '<!--[if IE 9]>IE-specific content<![endif]-->')
   Comment  :  a comment
   Comment  : [if IE 9]>IE-specific content<![endif]

Parsing named and numeric character references and converting them to the
correct char (note: these 3 references are all equivalent to ``'>'``)::

   >>> parser.feed('&gt;&#62;&#x3E;')
   Named ent: >
   Num ent  : >
   Num ent  : >

Feeding incomplete chunks to :meth:`~HTMLParser.feed` works, but
:meth:`~HTMLParser.handle_data` might be called more than once::

   >>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:
   ...     parser.feed(chunk)
   ...
   Start tag: span
   Data     : buff
   Data     : ered
   Data     : text
   End tag  : span

Parsing invalid HTML (e.g. unquoted attributes) also works::

   >>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
   Start tag: p
   Start tag: a
        attr: ('class', 'link')
        attr: ('href', '#main')
   Data     : tag soup
   End tag  : p
   End tag  : a

.. 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.
rename HTMLParser to html.parser and htmlentitydefs to html.entities; includes merge of trunk revision 63432 2008-05-17 19:02:32 -03:00			:mod:`html.parser` --- Simple HTML and XHTML parser
			`===================================================`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
rename HTMLParser to html.parser and htmlentitydefs to html.entities; includes merge of trunk revision 63432 2008-05-17 19:02:32 -03:00			`.. module:: html.parser`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			`:synopsis: A simple parser that can handle HTML and XHTML.`


Merged revisions 63438 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r63438 \| georg.brandl \| 2008-05-17 23:54:03 +0200 (Sat, 17 May 2008) \| 3 lines Rename html.parser file, and split html.entities from htmllib to ease removal of the latter in Py3k. ........ 2008-05-18 04:53:01 -03:00			`.. index::`
			`single: HTML`
			`single: XHTML`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
More source links. 2011-01-26 21:20:32 -04:00			Source code: :source:`Lib/html/parser.py`

			`--------------`

Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			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.`

#15114: the strict mode of HTMLParser and the HTMLParseError exception are deprecated now that the parser is able to parse invalid markup. 2012-06-23 10:27:51 -03:00			`.. class:: HTMLParser(strict=False)`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#15114: the strict mode of HTMLParser and the HTMLParseError exception are deprecated now that the parser is able to parse invalid markup. 2012-06-23 10:27:51 -03:00			Create a parser instance. If strict is ``False`` (the default), the parser
			will accept and parse invalid markup. If strict is ``True`` the parser
			will raise an :exc:`~html.parser.HTMLParseError` exception instead [#]_ when
			`it's not able to parse the markup.`
			The use of ``strict=True`` is discouraged and the strict argument is
			`deprecated.`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			An :class:`.HTMLParser` instance is fed HTML data and calls handler methods
			`when start tags, end tags, text, comments, and other markup elements are`
			encountered. The user should subclass :class:`.HTMLParser` and override its
			`methods to implement the desired behavior.`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
Remove the htmllib and sgmllib modules as per PEP 3108. 2008-06-01 18:25:55 -03:00			`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.`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
Fix a couple of versionadded/versionchanged related markup errors. 2012-06-24 17:48:30 -03:00			`.. versionchanged:: 3.2`
			`strict keyword added.`
Add missing versionchanged, correct 'throw' wording to 'raise'. 2010-12-03 00:26:18 -04:00
#15114: the strict mode of HTMLParser and the HTMLParseError exception are deprecated now that the parser is able to parse invalid markup. 2012-06-23 10:27:51 -03:00			`.. deprecated-removed:: 3.3 3.5`
			`The strict argument and the strict mode have been deprecated.`
			`The parser is now able to accept and parse invalid markup too.`

Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			`An exception is defined as well:`


			`.. exception:: HTMLParseError`

			Exception raised by the :class:`HTMLParser` class when it encounters an error
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			while parsing and strict is ``True``. 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.`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#15114: the strict mode of HTMLParser and the HTMLParseError exception are deprecated now that the parser is able to parse invalid markup. 2012-06-23 10:27:51 -03:00			`.. deprecated-removed:: 3.3 3.5`
			`This exception has been deprecated because it's never raised by the parser`
			`(when the default non-strict mode is used).`

Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`Example HTML Parser Application`
			`-------------------------------`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`As a basic example, below is a simple HTML parser that uses the`
			:class:`HTMLParser` class to print out start tags, end tags, and data
			`as they are encountered::`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`from html.parser import HTMLParser`

			`class MyHTMLParser(HTMLParser):`
			`def handle_starttag(self, tag, attrs):`
			`print("Encountered a start tag:", tag)`
			`def handle_endtag(self, tag):`
			`print("Encountered an end tag :", tag)`
			`def handle_data(self, data):`
			`print("Encountered some data :", data)`

#15114: The html.parser module now raises a DeprecationWarning when the strict argument of HTMLParser or the HTMLParser.error method are used. 2013-11-02 12:08:24 -03:00			`parser = MyHTMLParser()`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`parser.feed('<html><head><title>Test</title></head>'`
			`'<body><h1>Parse me!</h1></body></html>')`

			`The output will then be::`

			`Encountered a start tag: html`
			`Encountered a start tag: head`
			`Encountered a start tag: title`
			`Encountered some data : Test`
			`Encountered an end tag : title`
			`Encountered an end tag : head`
			`Encountered a start tag: body`
			`Encountered a start tag: h1`
			`Encountered some data : Parse me!`
			`Encountered an end tag : h1`
			`Encountered an end tag : body`
			`Encountered an end tag : html`


			:class:`.HTMLParser` Methods
			`----------------------------`

			:class:`HTMLParser` instances have the following methods:
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

			`.. 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`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			:meth:`close` is called. data must be :class:`str`.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

			`.. 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`.


#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`.. method:: HTMLParser.reset()`

			`Reset the instance. Loses all unprocessed data. This is called implicitly at`
			`instantiation time.`


Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			`.. 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.).`


#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`The following methods are called when data or markup elements are encountered`
			`and they are meant to be overridden in a subclass. The base class`
			implementations do nothing (except for :meth:`~HTMLParser.handle_startendtag`):


Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			`.. method:: HTMLParser.handle_starttag(tag, attrs)`

#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			This method is called to handle the start of a tag (e.g. ``<div id="main">``).
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
			`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`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`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/')])``.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
Merged revisions 63438 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r63438 \| georg.brandl \| 2008-05-17 23:54:03 +0200 (Sat, 17 May 2008) \| 3 lines Rename html.parser file, and split html.entities from htmllib to ease removal of the latter in Py3k. ........ 2008-05-18 04:53:01 -03:00			All entity references from :mod:`html.entities` are replaced in the attribute
			`values.`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`.. method:: HTMLParser.handle_endtag(tag)`

			This method is called to handle the end tag of an element (e.g. ``</div>``).

			`The tag argument is the name of the tag converted to lower case.`


Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			`.. method:: HTMLParser.handle_startendtag(tag, attrs)`

			Similar to :meth:`handle_starttag`, but called when the parser encounters an
Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 08:34:56 -03:00			XHTML-style empty tag (``<img ... />``). This method may be overridden by
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00			`subclasses which require this particular lexical information; the default`
Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 08:34:56 -03:00			implementation simply calls :meth:`handle_starttag` and :meth:`handle_endtag`.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

			`.. method:: HTMLParser.handle_data(data)`

#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`This method is called to process arbitrary data (e.g. text nodes and the`
			content of ``<script>...</script>`` and ``<style>...</style>``).
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`.. method:: HTMLParser.handle_entityref(name)`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`This method is called to process a named character reference of the form`
			``&name;`` (e.g. ``>``), where name is a general entity reference
			(e.g. ``'gt'``).
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`.. method:: HTMLParser.handle_charref(name)`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`This method is called to process decimal and hexadecimal numeric character`
			references of the form ``&#NNN;`` and ``&#xNNN;``. For example, the decimal
			equivalent for ``>`` is ``>``, whereas the hexadecimal is ``>``;
			in this case the method will receive ``'62'`` or ``'x3E'``.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

			`.. method:: HTMLParser.handle_comment(data)`

#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			This method is called when a comment is encountered (e.g. ``<!--comment-->``).
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			For example, the comment ``<!-- comment -->`` will cause this method to be
			called with the argument ``' comment '``.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`The content of Internet Explorer conditional comments (condcoms) will also be`
			sent to this method, so, for ``<!--[if IE 9]>IE9-specific content<![endif]-->``,
			this method will receive ``'[if IE 9]>IE-specific content<![endif]'``.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#3874: document HTMLParser.unknown_decl(). 2010-07-29 10:38:37 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`.. method:: HTMLParser.handle_decl(decl)`
#3874: document HTMLParser.unknown_decl(). 2010-07-29 10:38:37 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`This method is called to handle an HTML doctype declaration (e.g.`
			``<!DOCTYPE html>``).
#3874: document HTMLParser.unknown_decl(). 2010-07-29 10:38:37 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`The decl parameter will be the entire contents of the declaration inside`
			the ``<!...>`` markup (e.g. ``'DOCTYPE html'``).
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00

			`.. 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.


#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`.. method:: HTMLParser.unknown_decl(data)`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`This method is called when an unrecognized 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 overridden by a
			derived class. The base class implementation raises an :exc:`HTMLParseError`
			when strict is ``True``.
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00
			`.. _htmlparser-examples:`

			`Examples`
			`--------`

			`The following class implements a parser that will be used to illustrate more`
			`examples::`
Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 08:34:56 -03:00
			`from html.parser import HTMLParser`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`from html.entities import name2codepoint`
Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 08:34:56 -03:00
			`class MyHTMLParser(HTMLParser):`
			`def handle_starttag(self, tag, attrs):`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`print("Start tag:", tag)`
			`for attr in attrs:`
			`print(" attr:", attr)`
Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 08:34:56 -03:00			`def handle_endtag(self, tag):`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`print("End tag :", tag)`
Improve HTMLParser example in the doc and fix a couple minor things. 2011-10-28 08:34:56 -03:00			`def handle_data(self, data):`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00			`print("Data :", data)`
			`def handle_comment(self, data):`
			`print("Comment :", data)`
			`def handle_entityref(self, name):`
			`c = chr(name2codepoint[name])`
			`print("Named ent:", c)`
			`def handle_charref(self, name):`
			`if name.startswith('x'):`
			`c = chr(int(name[1:], 16))`
			`else:`
			`c = chr(int(name))`
			`print("Num ent :", c)`
			`def handle_decl(self, data):`
			`print("Decl :", data)`

#15114: The html.parser module now raises a DeprecationWarning when the strict argument of HTMLParser or the HTMLParser.error method are used. 2013-11-02 12:08:24 -03:00			`parser = MyHTMLParser()`
#14020: improve HTMLParser documentation. 2012-02-17 20:01:36 -04:00
			`Parsing a doctype::`

			`>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '`
			`... '"http://www.w3.org/TR/html4/strict.dtd">')`
			`Decl : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"`

			`Parsing an element with a few attributes and a title::`

			`>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')`
			`Start tag: img`
			`attr: ('src', 'python-logo.png')`
			`attr: ('alt', 'The Python logo')`
			`>>>`
			`>>> parser.feed('<h1>Python</h1>')`
			`Start tag: h1`
			`Data : Python`
			`End tag : h1`

			The content of ``script`` and ``style`` elements is returned as is, without
			`further parsing::`

			`>>> parser.feed('<style type="text/css">#python { color: green }</style>')`
			`Start tag: style`
			`attr: ('type', 'text/css')`
			`Data : #python { color: green }`
			`End tag : style`
			`>>>`
			`>>> parser.feed('<script type="text/javascript">'`
			`... 'alert("<strong>hello!</strong>");</script>')`
			`Start tag: script`
			`attr: ('type', 'text/javascript')`
			`Data : alert("<strong>hello!</strong>");`
			`End tag : script`

			`Parsing comments::`

			`>>> parser.feed('<!-- a comment -->'`
			`... '<!--[if IE 9]>IE-specific content<![endif]-->')`
			`Comment : a comment`
			`Comment : [if IE 9]>IE-specific content<![endif]`

			`Parsing named and numeric character references and converting them to the`
			correct char (note: these 3 references are all equivalent to ``'>'``)::

			`>>> parser.feed('>>>')`
			`Named ent: >`
			`Num ent : >`
			`Num ent : >`

			Feeding incomplete chunks to :meth:`~HTMLParser.feed` works, but
			:meth:`~HTMLParser.handle_data` might be called more than once::

			`>>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']:`
			`... parser.feed(chunk)`
			`...`
			`Start tag: span`
			`Data : buff`
			`Data : ered`
			`Data : text`
			`End tag : span`

			`Parsing invalid HTML (e.g. unquoted attributes) also works::`

			`>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')`
			`Start tag: p`
			`Start tag: a`
			`attr: ('class', 'link')`
			`attr: ('href', '#main')`
			`Data : tag soup`
			`End tag : p`
			`End tag : a`
Move the 3k reST doc tree in place. 2007-08-15 11:28:22 -03:00
#1486713: Add a tolerant mode to HTMLParser. The motivation for adding this option is that the the functionality it provides used to be provided by sgmllib in Python2, and was used by, for example, BeautifulSoup. Without this option, the Python3 version of BeautifulSoup and the many programs that use it are crippled. The original patch was by 'kxroberto'. I modified it heavily but kept his heuristics and test. I also added additional heuristics to fix #975556, #1046092, and part of #6191. This patch should be completely backward compatible: the behavior with the default strict=True is unchanged. 2010-12-03 00:06:39 -04:00			`.. rubric:: Footnotes`

Add missing versionchanged, correct 'throw' wording to 'raise'. 2010-12-03 00:26:18 -04:00			`.. [#] For backward compatibility reasons strict mode does not raise`
			`exceptions for all non-compliant HTML. That is, some invalid HTML`
#1486713: Add a tolerant mode to HTMLParser. The motivation for adding this option is that the the functionality it provides used to be provided by sgmllib in Python2, and was used by, for example, BeautifulSoup. Without this option, the Python3 version of BeautifulSoup and the many programs that use it are crippled. The original patch was by 'kxroberto'. I modified it heavily but kept his heuristics and test. I also added additional heuristics to fix #975556, #1046092, and part of #6191. This patch should be completely backward compatible: the behavior with the default strict=True is unchanged. 2010-12-03 00:06:39 -04:00			`is tolerated even in strict mode.`