.. _f-htmlparserjson:

module ``xmlhelper.html_parser_json``
=====================================





.. inheritance-diagram:: pyrsslocal.xmlhelper.html_parser_json


Short summary
+++++++++++++

module ``pyrsslocal.xmlhelper.html_parser_json``

parsing HTML to convert it into JSON


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| class                                                                              | truncated documentation                                           |
+====================================================================================+===================================================================+
| :class:`HTMLtoJSONParser <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser>` | Parses :epkg:`HTML` and output a :epkg:`JSON` structure. Example: |
+------------------------------------------------------------------------------------+-------------------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------+-----------------------------------------------------------------+
| function                                                                        | truncated documentation                                         |
+=================================================================================+=================================================================+
| :func:`iterate_on_json <pyrsslocal.xmlhelper.html_parser_json.iterate_on_json>` | Iterates on every field contains in the :epkg:`JSON` structure. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------+




Properties
++++++++++

+----------------------------------------------------------------------------+------------------------------------+
| property                                                                   | truncated documentation            |
+============================================================================+====================================+
| :meth:`json <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.json>` | Returns the :epkg:`JSON` strucure. |
+----------------------------------------------------------------------------+------------------------------------+




Static Methods
++++++++++++++

+----------------------------------------------------------------------------------+-----------------------------------------------------------------+
| staticmethod                                                                     | truncated documentation                                         |
+==================================================================================+=================================================================+
| :meth:`iterate <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.iterate>` | Iterates on every field contains in the :epkg:`JSON` structure. |
+----------------------------------------------------------------------------------+-----------------------------------------------------------------+
| :meth:`to_json <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.to_json>` | Converts :epkg:`HTML` into :epkg:`JSON`.                        |
+----------------------------------------------------------------------------------+-----------------------------------------------------------------+




Methods
+++++++

+--------------------------------------------------------------------------------------------------+----------------------------------+
| method                                                                                           | truncated documentation          |
+==================================================================================================+==================================+
| :py:meth:`__init__ <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.__init__>`            |                                  |
+--------------------------------------------------------------------------------------------------+----------------------------------+
| :meth:`clean <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.clean>`                     | Cleans a dictionary of value.    |
+--------------------------------------------------------------------------------------------------+----------------------------------+
| :meth:`handle_data <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.handle_data>`         | What to do with data.            |
+--------------------------------------------------------------------------------------------------+----------------------------------+
| :meth:`handle_endtag <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.handle_endtag>`     | What to do for the end of a tag. |
+--------------------------------------------------------------------------------------------------+----------------------------------+
| :meth:`handle_starttag <pyrsslocal.xmlhelper.html_parser_json.HTMLtoJSONParser.handle_starttag>` | What to do for a new tag.        |
+--------------------------------------------------------------------------------------------------+----------------------------------+


Documentation
+++++++++++++

.. automodule:: pyrsslocal.xmlhelper.html_parser_json
    :members:
    :special-members: __init__
    :show-inheritance: