maci.tomldumpstr

dumps data to a string as toml

dumping a string

Dumps a dictionary to a string formatted as TOML.

maci.tomldumpstr -> str

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

toml_string = maci.tomldumpstr(data)

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

parameters & arguments

Describes all parameter functionality and accepted data types

data: dict[str, Any]

First and only required positional argument. Accepts dictionaries

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

multi_line_str: bool

Optional parameter. Accepts booleans. Default = False

Use this parameter to enable writing string values as a multiline string. Default behavior is disabled matching the default for the tomli-w library.

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