simplest-conf-manager 0.1.2.1

No project description provided

ConfManager

Описание

Данная библиотека служит для удобного и гибкого управления конфигурациями приложения.

Примеры

Создание конфигурации

from simplest_conf_manager.base_config import BaseConfig
from *.brokers.broker_config
import BrokerConfig
from *.databases
import Databases


class Config(BaseConfig):
    databases: Databases
    broker: BrokerConfig

В примере выше в качестве * используйте свои собственные валидаторы, унаследованные от BaseModel из Pydantic. Описание в файле конфигурации может выглядеть примерно так:

[databases]
[databases.main]
host="localhost"
port=1234
username="username"
password="secret"
name="db_name"

[broker]
host="localhost"
port=1234
username="guest"
password="guest"
driver="driver_name"

Можно создавать сразу несколько конфигурационных файлов различных форматов (вплоть до отдельных конфигурационных серверов). Объединяются они следующим образом:

conf.toml

[connection]
host="localhost"
port=1234
username="from secrets"
password="from secrets"  # тут может быть любой текст или это может отсутствовать вовсе

secrets.toml

[connection]
username="username"
password="pwd"

config.py

from simplest_conf_manager.utils.data_providers.file_data_provider import FileDataProvider
from simplest_conf_manager.utils.parsers.toml_parser import TomlParser
from simplest_conf_manager.utils.dictionaries.deep_merge import deep_merge
from simplest_conf_manager import BaseConfig
from pydantic import BaseModel


class Connection(BaseModel):
    host: str
    port: int
    username: str
    password: str


class Config(BaseConfig):
    connection: Connection


config_path = 'config/conf.toml'
secret_path = 'config/secrets.toml'

conf_provider = FileDataProvider(path=config_path)
secret_provider = FileDataProvider(path=secret_path)

conf_parser = TomlParser(conf_provider)
secret_parser = TomlParser(secret_provider)

config = Config(**deep_merge(conf_parser.parse(), secret_parser.parse()))

Здесь следует обратить внимание на то, что при наличии одинаковых ключей в нескольких словарях (при использовании функции deep_merge) значение будет взято из последнего.

Данную библиотеку можно использовать для перевода на разные языки небольших приложений:

from pydantic import BaseModel

from simplest_conf_manager import BaseStrings, Translator
from simplest_conf_manager.utils.data_providers import FolderDataProvider
from simplest_conf_manager.utils.parsers import TomlParser


class Phrases(BaseModel):
    hi: str
    how_are_you: str


class Strings(BaseStrings):
    langs: dict[str, Phrases]


strings_path = 'tests/test_proj/config/strings'

strings_provider = FolderDataProvider(path=strings_path)

strings_parser = TomlParser(strings_provider)

strings = Strings(**{'langs': strings_parser.parse()})

translator = Translator(strings=strings, lang='ru')

print(translator.hi)

<style> p { font-size: 14pt; } </style>