YmlProjectIo

class glotaran.builtin.io.yml.yml.YmlProjectIo(format_name: str)

Bases: glotaran.io.interface.ProjectIoInterface

Initialize a Project IO plugin with the name of the format.

Parameters

format_name (str) – Name of the supported format an instance uses.

Methods Summary

load_model	parse_yaml_file reads the given file and parses its content as YML.
load_parameters	Create a ParameterGroup instance from the specs defined in a file (NOT IMPLEMENTED).
load_result	Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).
load_scheme	Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).
save_model	Save a Model instance to a spec file (NOT IMPLEMENTED).
save_parameters	Save a ParameterGroup instance to a spec file (NOT IMPLEMENTED).
save_result	Save a Result instance to a spec file (NOT IMPLEMENTED).
save_scheme	Save a Scheme instance to a spec file (NOT IMPLEMENTED).

Methods Documentation

load_model(file_name: str) → Model

parse_yaml_file reads the given file and parses its content as YML.

Parameters

filename (str) – filename is the of the file to parse.

Returns

The content of the file as dictionary.

Return type

Model

load_parameters(file_name: str) → glotaran.parameter.parameter_group.ParameterGroup

Create a ParameterGroup instance from the specs defined in a file (NOT IMPLEMENTED).

Parameters

file_name (str) – File containing the parameter specs.

Returns

ParameterGroup instance created from the file.

Return type

ParameterGroup

load_result(result_path: str) → Result

Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).

Parameters

result_path (str) – Path containing the result data.

Returns

Result instance created from the file.

Return type

Result

load_scheme(file_name: str) → glotaran.project.scheme.Scheme

Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).

Parameters

file_name (str) – File containing the parameter specs.

Returns

• Scheme – Scheme instance created from the file.

• .. # noqa (DAR202)

• .. # noqa (DAR401)

save_model(model: Model, file_name: str)

Save a Model instance to a spec file (NOT IMPLEMENTED).

Parameters

• model (Model) – Model instance to save to specs file.

• file_name (str) – File to write the model specs to.

save_parameters(parameters: ParameterGroup, file_name: str)

Save a ParameterGroup instance to a spec file (NOT IMPLEMENTED).

Parameters

• parameters (ParameterGroup) – ParameterGroup instance to save to specs file.

• file_name (str) – File to write the parameter specs to.

save_result(result: Result, result_path: str)

Save a Result instance to a spec file (NOT IMPLEMENTED).

Parameters

• result (Result) – Result instance to save to specs file.

• result_path (str) – Path to write the result data to.

save_scheme(scheme: glotaran.project.scheme.Scheme, file_name: str)

Save a Scheme instance to a spec file (NOT IMPLEMENTED).

Parameters

• scheme (Scheme) – Scheme instance to save to specs file.

• file_name (str) – File to write the scheme specs to.