Set up the bones of a Flask app with configuration
This commit is contained in:
parent
0909fd7e99
commit
a7fdd6cbd0
7 changed files with 131 additions and 1 deletions
38
src/config/__init__.py
Normal file
38
src/config/__init__.py
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
import json
|
||||
from logging import INFO
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
from .logging import Logging
|
||||
from .parse import ConfigParseError, assert_key_of_type
|
||||
|
||||
|
||||
@dataclass
|
||||
class Config:
|
||||
host: str | None
|
||||
port: int | None
|
||||
logging: Logging
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, config: dict[str, Any]) -> 'Config':
|
||||
assert_key_of_type(config, 'logging', dict)
|
||||
assert_key_of_type(config, 'host', str)
|
||||
assert_key_of_type(config, 'port', int)
|
||||
try:
|
||||
log_config = Logging.from_dict(config['logging'])
|
||||
return Config(host=config['host'], port=config['port'], logging=log_config)
|
||||
|
||||
except ConfigParseError as e:
|
||||
raise ConfigParseError(['logging', *e.keypath], e.issue) from e
|
||||
|
||||
|
||||
DEFAULT_CONFIG = Config(logging=Logging(level=INFO), port=None, host=None)
|
||||
|
||||
|
||||
def parse_config(filename: str) -> Config:
|
||||
with open(filename, 'r') as infile:
|
||||
config = json.loads(infile.read())
|
||||
return Config.from_dict(config)
|
||||
|
||||
|
||||
__all__ = ['Config', 'parse_config', 'DEFAULT_CONFIG']
|
||||
32
src/config/logging.py
Normal file
32
src/config/logging.py
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
from typing import Any
|
||||
from dataclasses import dataclass
|
||||
import logging
|
||||
|
||||
from .parse import assert_key_of_type, ConfigParseError
|
||||
|
||||
LOG_LEVELS = {
|
||||
'critical': logging.CRITICAL,
|
||||
'fatal': logging.FATAL,
|
||||
'error': logging.ERROR,
|
||||
'warning': logging.WARNING,
|
||||
'warn': logging.WARN,
|
||||
'info': logging.INFO,
|
||||
'debug': logging.DEBUG,
|
||||
'notset': logging.NOTSET,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class Logging:
|
||||
level: int
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, config: dict[str, Any]) -> 'Logging':
|
||||
assert_key_of_type(config, 'level', str)
|
||||
log_level_setting = config['level']
|
||||
if log_level_setting not in LOG_LEVELS:
|
||||
raise ConfigParseError(
|
||||
['level'], f'unknown log level "{log_level_setting}". Expected one of: {", ".join(LOG_LEVELS.keys())}'
|
||||
)
|
||||
|
||||
return Logging(level=LOG_LEVELS[config['level']])
|
||||
20
src/config/parse.py
Normal file
20
src/config/parse.py
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
from typing import Any
|
||||
|
||||
|
||||
class ConfigParseError(Exception):
|
||||
"""An error for when parsing a config fails"""
|
||||
|
||||
def __init__(self, keypath: list[str], issue: str):
|
||||
path = '.'.join(keypath)
|
||||
message = f'{path}: {issue}'
|
||||
super().__init__(message)
|
||||
self.keypath = keypath
|
||||
self.issue = issue
|
||||
|
||||
|
||||
def assert_key_of_type(config: dict[str, Any], key: str, kind: Any):
|
||||
if key not in config:
|
||||
raise ConfigParseError([key], 'missing')
|
||||
|
||||
if not isinstance(config[key], kind):
|
||||
raise ConfigParseError([key], f'type of "{key}" was {type(config[key])}, expected {kind}')
|
||||
Loading…
Add table
Add a link
Reference in a new issue