ats_utilities.config_io.cfg.icfg_processor module

Module

icfg_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 ICFGProcessor with method(s). Creates an interface for processing CFG content.

class ats_utilities.config_io.cfg.icfg_processor.ICFGProcessor[source]

Bases: ABC

Defines abstract class ICFGProcessor with method(s). Interface for processing CFG content.

It defines:

attributes:

None

methods:
from_lines - Loads CFG configuration from lines.
to_string - Converts CFG configuration to string.
to_dict - Converts CFG configuration to dictionary.
__str__ - Returns the CFG processor as string representation.
_abc_impl = <_abc._abc_data object>
abstractmethod from_lines(lines: list[str]) → bool[source]

Loads CFG configuration from lines.

Parameters:

lines (<list[str]>) – CFG content as a list of strings

Returns:

True (success) | False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.

abstractmethod to_dict() → dict[str, str][source]

Converts CFG configuration to dictionary.

Returns:

Dictionary with ATS information

Return type:

<dict[str, str]>

Exceptions:

NotImplementedError.

abstractmethod to_string() → str[source]

Converts CFG configuration to string.

Returns:

CFG content as string

Return type:

<str>

Exceptions:

NotImplementedError.