castep_outputs.utilities.dumpers

Module containing dumpers for formats.

Module Attributes

Dumper	Dumping function protocol.
SUPPORTED_FORMATS	Currently supported dumpers.

Functions

get_dumpers(dump_fmt)	Get appropriate dump for unified interface.
json_dumper(data, file)	JSON format dumper.
pprint_dumper(data, file)	Pretty print dumper.
print_dumper(data, file)	Python print dumper.
pyyaml_dumper(data, file)	YAML (pyyaml) format dumper.
ruamel_dumper(data, file)	YAML (ruamel.yaml) format dumper.

castep_outputs.utilities.dumpers.Dumper

Dumping function protocol.

castep_outputs.utilities.dumpers.get_dumpers(dump_fmt)

Get appropriate dump for unified interface.

Parameters:

dump_fmt (str) – Formats to dump to.

Returns:

Dumping function.

Raises:

• ValueError – Invalid dump_fmt provided.

• ImportError – No valid YAML dumper and yaml requested.

Return type:

Callable[[Any, TextIO], None]

See also

SUPPORTED_FORMATS

Acceptable values for dump_fmt.

castep_outputs.utilities.dumpers.json_dumper(data, file)

JSON format dumper.

Parameters:

• data (Any) – Data to dump.

• file (TextIO) – File to dump to.

Return type:

None

castep_outputs.utilities.dumpers.pprint_dumper(data, file)

Pretty print dumper.

Parameters:

• data (Any) – Data to dump.

• file (TextIO) – File to dump to.

Return type:

None

castep_outputs.utilities.dumpers.print_dumper(data, file)

Python print dumper.

Parameters:

• data (Any) – Data to dump.

• file (TextIO) – File to dump to.

Return type:

None

castep_outputs.utilities.dumpers.pyyaml_dumper(data, file)

YAML (pyyaml) format dumper.

Parameters:

• data (Any) – Data to dump.

• file (TextIO) – File to dump to.

Return type:

None

castep_outputs.utilities.dumpers.ruamel_dumper(data, file)

YAML (ruamel.yaml) format dumper.

Parameters:

• data (Any) – Data to dump.

• file (TextIO) – File to dump to.

Return type:

None

castep_outputs.utilities.dumpers.SUPPORTED_FORMATS: dict[str, Callable[[Any, TextIO], None]] = {'json': <function json_dumper>, 'pprint': <function pprint_dumper>, 'print': <function print_dumper>, 'pyyaml': <function pyyaml_dumper>, 'ruamel': <function ruamel_dumper>}

Currently supported dumpers.