73 lines
2.3 KiB
Python
73 lines
2.3 KiB
Python
"""TOML file settings source."""
|
|
|
|
from __future__ import annotations as _annotations
|
|
|
|
from pathlib import Path
|
|
from typing import (
|
|
TYPE_CHECKING,
|
|
Any,
|
|
)
|
|
|
|
from ..base import ConfigFileSourceMixin, InitSettingsSource
|
|
from ..types import DEFAULT_PATH, ConfigFileSourceType
|
|
from ..utils import InitState
|
|
|
|
if TYPE_CHECKING:
|
|
import tomllib
|
|
|
|
from pydantic_settings.main import BaseSettings
|
|
|
|
from ..types import Traversable
|
|
else:
|
|
tomllib = None
|
|
|
|
|
|
def import_toml() -> None:
|
|
global tomllib
|
|
if tomllib is not None:
|
|
return
|
|
import tomllib
|
|
|
|
|
|
class TomlConfigSettingsSource(InitSettingsSource, ConfigFileSourceMixin):
|
|
"""
|
|
A source class that loads variables from a TOML file
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
settings_cls: type[BaseSettings],
|
|
toml_file: ConfigFileSourceType | None = DEFAULT_PATH,
|
|
toml_table_header: tuple[str, ...] | None = None,
|
|
deep_merge: bool = False,
|
|
_init_state: InitState | None = None,
|
|
):
|
|
self.toml_file_path = toml_file if toml_file != DEFAULT_PATH else settings_cls.model_config.get('toml_file')
|
|
self.toml_table_header = (
|
|
toml_table_header
|
|
if toml_table_header is not None
|
|
else settings_cls.model_config.get('toml_table_header', ())
|
|
)
|
|
self.toml_data = self._read_files(self.toml_file_path, deep_merge=deep_merge)
|
|
|
|
if self._any_file_exists(self.toml_file_path):
|
|
for key in self.toml_table_header:
|
|
if key not in self.toml_data:
|
|
raise KeyError(f'toml_table_header key "{key}" not found in {self.toml_file_path}')
|
|
self.toml_data = self.toml_data[key]
|
|
|
|
super().__init__(settings_cls, self.toml_data, _init_state=_init_state)
|
|
|
|
def _read_file(self, file_path: Path | Traversable) -> dict[str, Any]:
|
|
import_toml()
|
|
with file_path.open(mode='rb') as toml_file:
|
|
return tomllib.load(toml_file)
|
|
|
|
@classmethod
|
|
def _any_file_exists(cls, paths: ConfigFileSourceType | None) -> bool:
|
|
"""Check if any of the given file paths would be read by `_read_files`."""
|
|
return bool(cls._existing_files(paths))
|
|
|
|
def __repr__(self) -> str:
|
|
return f'{self.__class__.__name__}(toml_file={self.toml_file_path}, toml_table_header={self.toml_table_header})'
|