EJIO.utils.serialization.implementations package

Inheritance diagram of EJIO.utils.serialization.implementations.json_serializer.JSONSerializer, EJIO.utils.serialization.implementations.toml_serializer.TOMLSerializer, EJIO.utils.serialization.implementations.yaml_serializer.YAMLSerializer, EJIO.utils.serialization.implementations.msgpack_serializer.MessagePackSerializer, EJIO.utils.serialization.implementations.ini_serializer.INISerializer, EJIO.utils.serialization.implementations.xml_serializer.XMLSerializer

Submodules

EJIO.utils.serialization.implementations.ini_serializer module

class EJIO.utils.serialization.implementations.ini_serializer.INISerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для конфигурационного формата INI. Канонично использует статические методы и современный синтаксис дженериков Python 3.12+.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать INI-строку обратно в словарь. Если задействована только дефолтная секция, возвращает её в плоском виде.

Параметры:

  • data – INI-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Десериализованный словарь.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из INI-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в INI-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в INI-строку. Если передан плоский словарь, данные автоматически упаковываются в секцию DEFAULT.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

INI-строка.

Исключение:

SerializationError – При ошибках сериализации.

EJIO.utils.serialization.implementations.json_serializer module

class EJIO.utils.serialization.implementations.json_serializer.JSONSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата JSON.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать JSON-строку обратно в словарь.

Параметры:

  • data – JSON-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из JSON-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в JSON-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в JSON-строку.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

JSON-строка.

Исключение:

SerializationError – При ошибках сериализации.

EJIO.utils.serialization.implementations.msgpack_serializer module

class EJIO.utils.serialization.implementations.msgpack_serializer.MessagePackSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для бинарного формата MessagePack.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать закодированную строку обратно в словарь.

Параметры:

  • data – Строковое представление байтового потока.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Десериализованный словарь.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из бинарного файла MessagePack.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в бинарный файл MessagePack.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в строку, закодированную через MessagePack.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Текстовое представление байтового потока.

Исключение:

SerializationError – При ошибках сериализации.

EJIO.utils.serialization.implementations.toml_serializer module

class EJIO.utils.serialization.implementations.toml_serializer.TOMLSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата TOML.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать TOML-строку обратно в словарь.

Параметры:

  • data – TOML-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из TOML-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в TOML-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в TOML-строку.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

TOML-строка.

Исключение:

SerializationError – При ошибках сериализации.

EJIO.utils.serialization.implementations.xml_serializer module

class EJIO.utils.serialization.implementations.xml_serializer.XMLSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата XML на базе библиотеки xmltodict.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Парсит XML строку обратно в словарь, очищая корневой тег root.

Параметры:

  • data – XML-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Десериализованный словарь.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из XML-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в XML-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Превращает словарь в XML строку, оборачивая её в корневой тег root.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

XML-строка.

Исключение:

SerializationError – При ошибках сериализации.

EJIO.utils.serialization.implementations.yaml_serializer module

class EJIO.utils.serialization.implementations.yaml_serializer.YAMLSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата YAML.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать YAML-строку обратно в словарь.

Параметры:

  • data – YAML-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из YAML-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в YAML-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в YAML-строку.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

YAML-строка.

Исключение:

SerializationError – При ошибках сериализации.

Module contents

class EJIO.utils.serialization.implementations.INISerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для конфигурационного формата INI. Канонично использует статические методы и современный синтаксис дженериков Python 3.12+.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать INI-строку обратно в словарь. Если задействована только дефолтная секция, возвращает её в плоском виде.

Параметры:

  • data – INI-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Десериализованный словарь.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из INI-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в INI-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в INI-строку. Если передан плоский словарь, данные автоматически упаковываются в секцию DEFAULT.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

INI-строка.

Исключение:

SerializationError – При ошибках сериализации.

class EJIO.utils.serialization.implementations.JSONSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата JSON.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать JSON-строку обратно в словарь.

Параметры:

  • data – JSON-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из JSON-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в JSON-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в JSON-строку.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

JSON-строка.

Исключение:

SerializationError – При ошибках сериализации.

class EJIO.utils.serialization.implementations.MessagePackSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для бинарного формата MessagePack.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать закодированную строку обратно в словарь.

Параметры:

  • data – Строковое представление байтового потока.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Десериализованный словарь.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из бинарного файла MessagePack.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в бинарный файл MessagePack.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в строку, закодированную через MessagePack.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Текстовое представление байтового потока.

Исключение:

SerializationError – При ошибках сериализации.

class EJIO.utils.serialization.implementations.TOMLSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата TOML.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать TOML-строку обратно в словарь.

Параметры:

  • data – TOML-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из TOML-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в TOML-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в TOML-строку.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

TOML-строка.

Исключение:

SerializationError – При ошибках сериализации.

class EJIO.utils.serialization.implementations.XMLSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата XML на базе библиотеки xmltodict.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Парсит XML строку обратно в словарь, очищая корневой тег root.

Параметры:

  • data – XML-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Десериализованный словарь.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из XML-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в XML-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Превращает словарь в XML строку, оборачивая её в корневой тег root.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

XML-строка.

Исключение:

SerializationError – При ошибках сериализации.

class EJIO.utils.serialization.implementations.YAMLSerializer(*args, **kwargs)[исходный код]

Базовые классы: Serializer

Реализация интерфейса Serializer для формата YAML.

static deserialize(data: str, /, **kwargs: Any) → dict[str, T][исходный код]

Преобразовать YAML-строку обратно в словарь.

Параметры:

  • data – YAML-строка.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из строки.

Исключение:

SerializationError – При ошибках десериализации.

static load(filename: str, /, **kwargs: Any) → dict[str, T][исходный код]

Загрузить словарь из YAML-файла.

Параметры:

  • filename – Путь к файлу для загрузки.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

Словарь, полученный из файла.

Исключение:

SerializationError – При ошибках десериализации.

static save(data: dict[str, T], filename: str, /, **kwargs: Any) → None[исходный код]

Сохранить словарь в YAML-файл.

Параметры:

  • data – Сериализуемый словарь.

  • filename – Путь к файлу для сохранения.

  • kwargs – Ключевые параметры для сереализатора.

Исключение:

SerializationError – При ошибках сериализации.

static serialize(data: dict[str, T], /, **kwargs: Any) → str[исходный код]

Преобразовать словарь в YAML-строку.

Параметры:

  • data – Сериализуемый словарь.

  • kwargs – Ключевые параметры для сереализатора.

Результат:

YAML-строка.

Исключение:

SerializationError – При ошибках сериализации.