Marc Di Luzio
3a0bf82ecb
See the README for usages and details. A breaking changes here too: * run.py is gone, we now handle that kind of thing with docker * The token is out of the config and is now an ENVAR (ideally using a .env) * `.json` files are now in a .matchy/ subdirectory, as this makes it a lot easier for the container to safely read Bonus: * fix a score_factors.setdefault call causing issues * Reformat some of the readme
152 lines
3.6 KiB
Python
152 lines
3.6 KiB
Python
"""Very simple config loading library"""
|
|
from schema import Schema, Use, Optional
|
|
import files
|
|
import os
|
|
import logging
|
|
import json
|
|
|
|
logger = logging.getLogger("config")
|
|
logger.setLevel(logging.INFO)
|
|
|
|
# Envar takes precedent
|
|
_ENVAR = "MATCHY_CONFIG"
|
|
_FILE = ".matchy/config.json"
|
|
|
|
# Warning: Changing any of the below needs proper thought to ensure backwards compatibility
|
|
_VERSION = 2
|
|
|
|
|
|
class _Key():
|
|
VERSION = "version"
|
|
|
|
MATCH = "match"
|
|
|
|
SCORE_FACTORS = "score_factors"
|
|
REPEAT_ROLE = "repeat_role"
|
|
REPEAT_MATCH = "repeat_match"
|
|
EXTRA_MEMBER = "extra_member"
|
|
UPPER_THRESHOLD = "upper_threshold"
|
|
|
|
# Removed
|
|
_OWNERS = "owners"
|
|
_TOKEN = "token"
|
|
|
|
|
|
_SCHEMA = Schema(
|
|
{
|
|
# The current version
|
|
_Key.VERSION: Use(int),
|
|
|
|
# Settings for the match algorithmn, see matching.py for explanations on usage
|
|
Optional(_Key.MATCH): {
|
|
Optional(_Key.SCORE_FACTORS): {
|
|
|
|
Optional(_Key.REPEAT_ROLE): Use(int),
|
|
Optional(_Key.REPEAT_MATCH): Use(int),
|
|
Optional(_Key.EXTRA_MEMBER): Use(int),
|
|
Optional(_Key.UPPER_THRESHOLD): Use(int),
|
|
}
|
|
}
|
|
}
|
|
)
|
|
|
|
_EMPTY_DICT = {
|
|
_Key.VERSION: _VERSION
|
|
}
|
|
|
|
|
|
def _migrate_to_v1(d: dict):
|
|
# Owners moved to History in v1
|
|
# Note: owners will be required to be re-added to the state.json
|
|
if _Key._OWNERS in d:
|
|
owners = d.pop(_Key._OWNERS)
|
|
logger.warning(
|
|
"Migration removed owners from config, these must be re-added to the state.json")
|
|
logger.warning("Owners: %s", owners)
|
|
|
|
|
|
def _migrate_to_v2(d: dict):
|
|
# Token moved to the environment
|
|
if _Key._TOKEN in d:
|
|
del d[_Key._TOKEN]
|
|
|
|
|
|
# Set of migration functions to apply
|
|
_MIGRATIONS = [
|
|
_migrate_to_v1,
|
|
_migrate_to_v2
|
|
]
|
|
|
|
|
|
class _ScoreFactors():
|
|
def __init__(self, data: dict):
|
|
"""Initialise and validate the config"""
|
|
self._dict = data
|
|
|
|
@property
|
|
def repeat_role(self) -> int:
|
|
return self._dict.get(_Key.REPEAT_ROLE, None)
|
|
|
|
@property
|
|
def repeat_match(self) -> int:
|
|
return self._dict.get(_Key.REPEAT_MATCH, None)
|
|
|
|
@property
|
|
def extra_member(self) -> int:
|
|
return self._dict.get(_Key.EXTRA_MEMBER, None)
|
|
|
|
@property
|
|
def upper_threshold(self) -> int:
|
|
return self._dict.get(_Key.UPPER_THRESHOLD, None)
|
|
|
|
|
|
class _Config():
|
|
def __init__(self, data: dict):
|
|
"""Initialise and validate the config"""
|
|
_SCHEMA.validate(data)
|
|
self._dict = data
|
|
|
|
@property
|
|
def token(self) -> str:
|
|
return self._dict["token"]
|
|
|
|
@property
|
|
def score_factors(self) -> _ScoreFactors:
|
|
return _ScoreFactors(self._dict.get(_Key.SCORE_FACTORS, {}))
|
|
|
|
|
|
def _migrate(dict: dict):
|
|
"""Migrate a dict through versions"""
|
|
version = dict.get("version", 0)
|
|
for i in range(version, _VERSION):
|
|
_MIGRATIONS[i](dict)
|
|
dict["version"] = _VERSION
|
|
|
|
|
|
def _load() -> _Config:
|
|
"""
|
|
Load the state from an envar or file
|
|
Apply any required migrations
|
|
"""
|
|
|
|
# Try the envar first
|
|
envar = os.environ.get(_ENVAR)
|
|
if envar:
|
|
loaded = json.loads(envar)
|
|
logger.info("Config loaded from $%s", _ENVAR)
|
|
else:
|
|
# Otherwise try the file
|
|
if os.path.isfile(_FILE):
|
|
loaded = files.load(_FILE)
|
|
logger.info("Config loaded from %s", _FILE)
|
|
else:
|
|
loaded = _EMPTY_DICT
|
|
logger.warning("No %s file found, using defaults", _FILE)
|
|
|
|
_migrate(loaded)
|
|
return _Config(loaded)
|
|
|
|
|
|
# Core config for users to use
|
|
# Singleton as there should only be one, it's static, and global
|
|
Config = _load()
|