src/liquidcode/config.py - develop-0.2.0 - liquid-g/liquid-code

src/liquidcode/config.py
100 строк4 KB
User
ci: настроен Black и flake8 для автоматического форматирования кода
04 июл 2026, 08:14
04 июл 2026, 08:144778ed6
"""
Модуль загрузки конфигурации для LiquidCode.

Поддерживает форматы YAML и JSON.
Для YAML требуется установка библиотеки PyYAML.
"""

import json
import os
from typing import Any, Dict

# Пытаемся импортировать PyYAML. Если библиотека не установлена,
# yaml будет равен None, и при попытке загрузить YAML-файл
# будет выброшено понятное исключение с инструкцией по установке.
try:
    import yaml
except ImportError:
    yaml = None


class ConfigError(Exception):
    """
    Исключение, возникающее при ошибках загрузки конфигурации.

    Используется для всех ошибок, связанных с отсутствием файла,
    неподдерживаемым форматом, синтаксическими ошибками и т.д.
    """

    pass


def load_config(file_path: str) -> Dict[str, Any]:
    """
    Загружает конфигурацию из файла YAML или JSON.

    Args:
        file_path: Путь к файлу конфигурации (абсолютный или относительный).

    Returns:
        Словарь с данными конфигурации. Если файл пустой или содержит
        только комментарии, возвращается пустой словарь.

    Raises:
        ConfigError: Если файл не найден, не удалось прочитать,
                     формат не поддерживается или содержимое невалидно.
    """
    # 1. Проверяем, существует ли файл на диске
    if not os.path.exists(file_path):
        raise ConfigError(f"Config file not found: {file_path}")

    # 2. Определяем расширение файла (нижний регистр) для выбора парсера
    ext = os.path.splitext(file_path)[1].lower()

    # 3. Читаем содержимое файла в строку
    try:
        with open(file_path, "r", encoding="utf-8") as f:
            content = f.read()
    except OSError as e:
        # Ошибки доступа, прав, диска и т.п.
        raise ConfigError(f"Failed to read config file {file_path}: {e}") from e

    # 4. Парсим содержимое в зависимости от формата
    if ext in (".yaml", ".yml"):
        # YAML: требуется PyYAML
        if yaml is None:
            raise ConfigError(
                "PyYAML is required to parse YAML configs. "
                "Install with: pip install PyYAML"
            )
        try:
            data = yaml.safe_load(content)
        except yaml.YAMLError as e:
            # Ошибки синтаксиса YAML (неправильные отступы, неизвестные теги и т.п.)
            raise ConfigError(f"Invalid YAML in {file_path}: {e}") from e

    elif ext == ".json":
        # JSON: используем встроенный модуль json
        # Пустой файл возвращает пустой словарь
        if not content.strip():
            data = {}
        else:
            try:
                data = json.loads(content)
            except json.JSONDecodeError as e:
                # Ошибки синтаксиса JSON (неправильные кавычки, запятые и т.п.)
                raise ConfigError(f"Invalid JSON in {file_path}: {e}") from e

    else:
        # Неподдерживаемый формат
        raise ConfigError(
            f"Unsupported config format: {ext}. Use .yaml, .yml, or .json"
        )

    # 5. Если файл пустой или содержит только комментарии,
    #    yaml.safe_load вернёт None. Приводим к пустому словарю,
    #    чтобы вызывающий код не обрабатывал None отдельно.
    if data is None:
        data = {}

    return data