ats_utilities.config_io.ini.ini_processor module

Module

ini_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 class INIProcessor with attribute(s) and method(s). Default implementation for processing INI content.

class ats_utilities.config_io.ini.ini_processor.INIProcessor[source]

Bases: IINIProcessor

Defines class INIProcessor with attribute(s) and method(s). Default implementation for processing INI content.

It defines:

attributes:
_SECTION - Section name for ATS configuration.
_NAME - Option name for ATS configuration.
_VERSION - Option version for ATS configuration.
_BUILD_DATE - Option build date for ATS configuration.
_LICENCE - Option licence for ATS configuration.
_config - ConfigParser instance for INI parsing.
methods:
__init__ - Initializes INIProcessor constructor.
from_stream - Loads INI configuration from a stream.
to_stream - Converts INI configuration to a stream.
to_dict - Converts INI configuration to dictionary.
__str__ - Returns the INIProcessor as string representation.
_BUILD_DATE: str = 'ats_build_date'
_LICENCE: str = 'ats_licence'
_NAME: str = 'ats_name'
_SECTION: str = 'ats_info'
_VERSION: str = 'ats_version'
_abc_impl = <_abc._abc_data object>
from_stream(stream: Any) → bool[source]

Loads INI configuration from a stream.

Parameters:

stream (<Any>) – INI content stream.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

None..

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

Converts INI configuration to dictionary.

Returns:

Dictionary with ATS information.

Return type:

<dict[str, str]>

Exceptions:

None..

to_stream(stream: Any) → bool[source]

Converts INI configuration to a stream.

Parameters:

stream (<Any>) – INI content stream.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

None..