xmlutils

Functions

pymisclib.xmlutils.elements_equal(element1: ~xml.etree.ElementTree.Element | ~xml.etree.ElementTree.ElementTree, element2: ~xml.etree.ElementTree.Element | ~xml.etree.ElementTree.ElementTree, logger: ~logging.Logger = <Logger pymisclib.xmlutils (WARNING)>) → bool

Check if two XML elements are equal.

Compares the tags, attributes, children (recursively), tail, and text of both elements, not their textual representations.

Parameters:

  • element1 (xml.etree.ElementTree.Element) – First XML element to compare.

  • element2 (xml.etree.ElementTree.Element) – Second XML element to compare.

  • logger (logging.Logger) – Logger for diagnostics.

Return type:

bool

Returns:

True if elements are equal, False otherwise.

New in version 1.6.0.

pymisclib.xmlutils.log_xml(fn_logger: Logger, xml_elem: Element | ElementTree, level: int = 10, indent: int = 0, indent_level_start: int = 0, indent_spaces: int = 2)

Log the XML as one or more log entries.

Parameters:

  • fn_logger (logging.Logger) – The logger to log to.

  • xml_elem (etree._Element) – The XML element to log.

  • level (int) – Level for logging (e.g logging.DEBUG, logging.INFO, …)

  • indent (int) – Number of spaces to indent all entries. This does not change the indentation added for nested elements (indent_spaces spaces per level).

  • indent_level_start (int) – Start indentation at this level. If > 0, the parameter “indent” is ignored.

  • indent_spaces (int) – Number of spaces to indent per level.

Note

indent is the old interface for indenting the entire xml_element. In order to be closer to the interface of the Python standard library, indent_level_start and indent_spaces have been introduced. Since there is no compatible way to deprecate indent, it will stay but the recommendation is to switch to the new parameters.

Changed in version 1.6.0: Moved here from pymisclib.utilities.log_xml().

Changed in version 1.6.2: Formatting improved.

Changed in version 1.7.1: Added parameters indent_level_start and indent_spaces.