ats_utilities.config_io.yaml.iyaml_processor module

Module

iyaml_processor.py

Copyright

Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com> ats_utilities is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. ats_utilities is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Defines abstract class IYAMLProcessor with method(s). Creates an interface for processing YAML content.

class ats_utilities.config_io.yaml.iyaml_processor.IYAMLProcessor

Bases: ABC

Defines abstract class IYAMLProcessor with method(s). Interface for processing YAML content.

It defines:

attributes:

None

methods:

decode - Converts raw YAML text to an internal object/structure.

encode - Converts an internal object/structure back to a YAML string.

to_dict - Returns configuration as a flat dictionary.

__str__ - Returns the YAML processor as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod decode(yaml_string: str) → bool

Converts raw YAML text to an internal object/structure.

Parameters:

yaml_string (<str>) – Raw YAML text

Returns:

True (success) | False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.

abstractmethod encode() → str

Converts an internal object/structure back to a YAML string.

Returns:

YAML content as string

Return type:

<str>

Exceptions:

NotImplementedError.

abstractmethod to_dict() → dict[str, str]

Returns configuration as a flat dictionary.

Returns:

Dictionary with YAML configuration

Return type:

<dict[str, str]>

Exceptions:

NotImplementedError.