nt2.formats.yaml

module documentation
(source)

Support for YAML.

Class NestedTextToYAML Undocumented
Class YAMLToNestedText Undocumented
Function NTTError_from_MarkedYAMLError Undocumented
Constant EXTENSIONS Undocumented
Constant SUBCOMMANDS Undocumented
Constant YAML_EDITOR Undocumented
Function _dump_stdout Print the data a a YAML string, without color.
Function _dump_str Return the data a a YAML string, without color.
Function _load_file Read YAML from input_file and return typed data.
@NTTError_from.register
@docstring_for_NTTError_from
def NTTError_from_MarkedYAMLError(exc: MarkedYAMLError) -> NTTError: (source)

Undocumented

EXTENSIONS: tuple[str, ...] = (source)

Undocumented

Value
('yml', 'yaml')
SUBCOMMANDS = (source)

Undocumented

Value
{'nt2': {'app': NestedTextToYAML, 'names': ('yaml')},
 '2nt': {'app': YAMLToNestedText, 'names': ('yaml')}}
YAML_EDITOR = (source)

Undocumented

Value
mk_yaml_editor()
def _dump_stdout(data: YAMLData): (source)

Print the data a a YAML string, without color.

Parameters
data:YAMLDataThe YAML data.
def _dump_str(data: YAMLData) -> str: (source)

Return the data a a YAML string, without color.

Parameters
data:YAMLDataThe YAML data.
Returns
strThe YAML string.
Raises
ExceptionIf there was an error.
def _load_file(input_file: LocalPath) -> YAMLData: (source)

Read YAML from input_file and return typed data.

Parameters
input_file:LocalPathThe YAML file.
Returns
YAMLDataThe YAML data.