.. _f-xmlfilewalk:

module ``xmlhelper.xmlfilewalk``
================================







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

module ``pyrsslocal.xmlhelper.xmlfilewalk``

functions related to XML files representing objects


:githublink:`%|py|6`






Functions
+++++++++

+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                                     | truncated documentation                                                                                                       |
+==============================================================================================================================+===============================================================================================================================+
| :func:`_iteration_values <pyrsslocal.xmlhelper.xmlfilewalk._iteration_values>`                                               | Iterators on all possible tuple of values taken into a list. Let's assume you have two rows:                                  |
+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`table_extraction_from_xml_files <pyrsslocal.xmlhelper.xmlfilewalk.table_extraction_from_xml_files>`                   | Goes through a :epkg:`XML` file, extracts values and put them into a flat file.                                               |
+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`table_extraction_from_xml_files_iterator <pyrsslocal.xmlhelper.xmlfilewalk.table_extraction_from_xml_files_iterator>` | Goes through a XML file, extracts values and put them into an iterator.                                                       |
+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`xml_filter <pyrsslocal.xmlhelper.xmlfilewalk.xml_filter>`                                                             | Goes through a :epkg:`XML` file, returns :epkg:`XML` content if a condition is verified, the result is put into a stream. ... |
+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`xml_filter_iterator <pyrsslocal.xmlhelper.xmlfilewalk.xml_filter_iterator>`                                           | Goes through a :epkg:`XML` file, returns :epkg:`XML` content if a condition is verified, the result is an iterator. ...       |
+------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+








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

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