ats_utilities.config_io.json.ijson_processor module

Module

ijson_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 IJSONProcessor with method(s). Creates an interface for processing JSON content.

class ats_utilities.config_io.json.ijson_processor.IJSONProcessor

Bases: ABC

Defines abstract class IJSONProcessor with method(s). Interface for processing JSON content.

It defines:

attributes:

None

methods:

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

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

to_dict - Converts data as a flat dictionary.

__str__ - Returns the JSON processor as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod decode(json_string: str) → bool

Converts raw JSON text to an internal object/structure.

Parameters:

json_string (<str>) – Raw JSON text in string format

Returns:

True (success) | False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.

abstractmethod encode() → str

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

Returns:

JSON content in string format

Return type:

<str>

Exceptions:

NotImplementedError.

abstractmethod to_dict() → dict[str, str]

Converts data as a flat dictionary.

Returns:

Dictionary with JSON configuration

Return type:

<dict[str, str]>

Exceptions:

NotImplementedError.