.. _f-xmltree:

module ``xmlhelper.xml_tree``
=============================





.. inheritance-diagram:: pyrsslocal.xmlhelper.xml_tree


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

module ``pyrsslocal.xmlhelper.xml_tree``

parsing XML


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| class                                                                  | truncated documentation                                                                                      |
+========================================================================+==============================================================================================================+
| :class:`XMLHandlerDict <pyrsslocal.xmlhelper.xml_tree.XMLHandlerDict>` | Overloads functions about XML, it produces objects at the end we assume the file contains a list of objects. |
+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :class:`XMLIterParser <pyrsslocal.xmlhelper.xml_tree.XMLIterParser>`   | To use a parser like an iterator. Example:                                                                   |
+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| method                                                                                        | truncated documentation                                        |
+===============================================================================================+================================================================+
| :py:meth:`__init__ <pyrsslocal.xmlhelper.xml_tree.XMLHandlerDict.__init__>`                   |                                                                |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :py:meth:`__init__ <pyrsslocal.xmlhelper.xml_tree.XMLIterParser.__init__>`                    |                                                                |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :py:meth:`_prepare_stringio <pyrsslocal.xmlhelper.xml_tree.XMLHandlerDict._prepare_stringio>` | prepare the StringIO stream                                    |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :meth:`characters <pyrsslocal.xmlhelper.xml_tree.XMLHandlerDict.characters>`                  | Adds characters.                                               |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :meth:`endElement <pyrsslocal.xmlhelper.xml_tree.XMLHandlerDict.endElement>`                  | After a tag.                                                   |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :meth:`parse <pyrsslocal.xmlhelper.xml_tree.XMLIterParser.parse>`                             | Parses an :epkg:`XML` document from a URL or an *InputSource*. |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :meth:`startElement <pyrsslocal.xmlhelper.xml_tree.XMLHandlerDict.startElement>`              | When enters a section.                                         |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------+


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

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