maci.xmlload

loads xml data to element or elementtree from a file

loading a file

Loads xml file data, and returns an Element or ElementTree object.

maci.xmlload -> Element | ElementTree

Basic Example of loading a xml file using default positional parameter

data = maci.xmlload('mydata.xml')

In this example, we simply load xml data from a file using the xmlload function and pass a string of the filepath to the file as an argument to the function to load the xml data, and assign the returned data to a variable.

Basic Example of xml data in file and accessing element data

file example

<mydata>
    <data1>one</data1>
</mydata>

accessing in code

data.find('data1').text

Note: All values in a xml file are returned as strings.

More information on using Element and ElementTree data: Youtube Video Search: https://www.youtube.com/results?search_query=python+xml+etree Documentation: https://docs.python.org/3/library/xml.etree.elementtree.html

partner functions

Functions that are related for ElementTree

maci.xmlloadstr -> Loads xml data from a string as Element object maci.xmldump -> Dumps xml data to a file from xml etree ElementTree or Element object maci.xmldumpstr -> Dumps xml data to a string from xml etree Element object maci.xmlbuildmanual -> Returns empty xml ElementTree object to manually build xml data maci._defuse_xml_stdlib -> Monkey patch and defuse all stdlib packages [security use]

parameters & arguments

Describes all parameter functionality and accepted data types

filename: str | Path

First and only required positional argument. Accepts strings and Path objects

Use this parameter to point to your filepath

auto_get_root: bool

Optional parameter. Accepts booleans. Default = True

Returns the root Element object of the ElementTree parsed from a xml file. Default is enabled to simplify data navigation steps. Disable it to get the main ElementTree object.

This function uses the native xml library etree shipped with the python standard library for its underlying functionality. For more information on the xml.etree api, visit: https://docs.python.org/3/library/xml.etree.elementtree.html

Security awareness: It is important to evaluate handling XML data carefully as there are known vulnerabilities in dealing with XML data. Please refer to the official python documentation above.

Additionally, see the provided tooling to potentially assist with vulnerabilities _defuse_xml_stdlib