dumps element data to a string as xml

dumping a string

Dumps Element object data to a string formatted as XML.

Basic Example of dumping data to a string using default positional parameters

xml_string = maci.xmldumpstr(data)

In this example, we simply dump data to a string using the xmldumpstr function and pass data as an argument to the function, and assign the returned data to a variable.

To learn more about building out your xml ElementTree data in code, see xmlbuildmanual More information on using Element data: Youtube Video Search: Documentation:

partner functions

Functions that are related for ElementTree

maci.xmlload -> Loads xml data from a file as Element or ElementTree object 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.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

data: Element

First and only required positional argument. Accepts Element objects

Use this parameter to pass in the data you want to dump to a string.

encoding: str

Optional parameter. Accepts strings. Default = 'utf-8'

Use this parameter to dump the data with the desired codec of the data if needed. The default uses a common industry standard, so you don't have to use this, but you can if the data needs to be written with a specific codec.

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:

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

Last updated