maci.xmldumpdict

dumps dict data to a file as xml

dumping a file

Dumps a dictionary to a file formatted as XML. Nothing is returned. Creates a new or overwrites an existing file by default (See append parameter to change mode).

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

maci.xmldumpdict('mydata.xml', data)

In this example, we simply dump data to a file using the xmldumpdict function and pass a string of the filepath to the file as the first argument to the function, then pass the dictionary data as the second argument to the function.

partner functions

Functions that are related for xml as dict

maci.xmlloaddict -> Loads xml data from a file as dict maci.xmlloadstrdict -> Loads xml data from a string as dict maci.xmldumpstrdict -> Dumps xml data to a string from dict

parameters & arguments

Describes all parameter functionality and accepted data types

filename: str | Path

First required positional argument. Accepts strings and Path objects

Use this parameter to point to your filepath

data: dict[str, Any]

Second required positional argument. Accepts dictionaries

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

append: bool

Optional parameter. Accepts booleans. Default = False

Use this parameter to enable appending mode to write by appending data to the file. A new file will be created if the filename does not exist. Default is disabled which writes new or overwrites a file.

pretty: bool

Optional parameter. Accepts booleans. Default = True

Use this parameter to enable automatic indentation writes on sub-elements. Disable if you want all xml data to be in one line.

full_doc: bool

Optional parameter. Accepts booleans. Default = True

Use this parameter to enable output to be a complete xml document, which includes the xml declaration at the top. Default is enabled for formal xml document info. Disabling is useful when you only need a portion of an XML document or when you are generating xml.

This function uses the xmltodict library installed as a dependency from pypi for its underlying functionality. For more information on xmltodict, visit: https://pypi.org/project/xmltodict/

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.