nt2.formats.nestedtext

module documentation

(source)

NestedText format support.

Function	`dump_stdout`	Print the data as NestedText, without color, to stdout.
Function	`dump_str`	Return a string representation of the data as NestedText, without color.
Function	`load`	Wrap `nestedtext.load` with convenient configuration.
Function	`NTTError_from_NestedTextError`	Undocumented

def dump_stdout(data: JSONData, inline_width: int = 0): (source) ¶

Print the data as NestedText, without color, to stdout.

Parameters
data:`JSONData`	A `JSONData` to dump as NestedText.
inline_width:`int`	Maximum line length for inline dictionaries and lists.

def dump_str(data: JSONData, inline_width: int = 0) -> str: (source) ¶

Return a string representation of the data as NestedText, without color.

Parameters
data:`JSONData`	A `JSONData` to dump as NestedText.
inline_width:`int`	Maximum line length for inline dictionaries and lists.

Returns
`str`	A string representation of the data as NestedText.

def load(file: str | LocalPath | TextIO) -> StringyData: (source) ¶

Wrap nestedtext.load with convenient configuration.

Set top-level type constraint to 'any', and assure the type checker the result is StringyData.

Parameters
file:`str \| LocalPath \| TextIO`	NestedText file-like object, usually a `LocalPath` or `sys.stdin`.

Returns
`StringyData`	Parsed NestedText data as `StringyData`.

def NTTError_from_NestedTextError(exc: NestedTextError) -> NTTError: (source) ¶

Undocumented