"""config module.
Contains the code required for pre-configuring user interfaces.
.. module:: config
:synopsis: Configuration functions and constants for pre-configuring CLI
parameters.
.. moduleauthor:: Simon Larsén
"""
import os
import pathlib
import configparser
from typing import Union, Mapping
import repobee_plug as plug
from _repobee import exception
from _repobee import constants
[docs]def check_defaults(
defaults: Mapping[str, str], config_file: Union[str, pathlib.Path]
):
"""Raise an exception if defaults contain keys that are not configurable
arguments.
Args:
defaults: A dictionary of defaults.
config_file: Path to the config file.
"""
configured = defaults.keys()
if (
configured - constants.CONFIGURABLE_ARGS
): # there are surpluss arguments
raise exception.FileError(
"config file at {} contains invalid default keys: {}".format(
config_file,
", ".join(configured - constants.CONFIGURABLE_ARGS),
)
)
[docs]def execute_config_hooks(config_file: Union[str, pathlib.Path]) -> None:
"""Execute all config hooks.
Args:
config_file: path to the config file.
"""
config_file = pathlib.Path(config_file)
if not config_file.is_file():
return
config_parser = _read_config(config_file)
plug.manager.hook.config_hook(config_parser=config_parser)
[docs]def check_config_integrity(config_file: Union[str, pathlib.Path]) -> None:
"""Raise an exception if the configuration file contains syntactical
errors, or if the defaults are misconfigured. Note that plugin options are
not checked.
Args:
config_file: path to the config file.
"""
config_file = pathlib.Path(config_file)
if not config_file.is_file():
raise exception.FileError(
"no config file found, expected location: " + str(config_file)
)
try:
defaults = _read_defaults(config_file)
except configparser.ParsingError as exc:
errors = ", ".join(
"(line {}: {})".format(line_nr, line)
for line_nr, line in exc.errors
)
raise exception.FileError(
msg="config file at {} contains syntax errors: {}".format(
config_file, errors
)
)
check_defaults(defaults, config_file)
def _read_defaults(config_file: pathlib.Path) -> dict:
token = os.getenv(constants.TOKEN_ENV)
if not config_file.is_file():
return {} if not token else dict(token=token)
defaults = dict(_read_config(config_file)[constants.CORE_SECTION_HDR])
if token:
if defaults.get("token"):
plug.log.warning(
"REPOBEE_TOKEN environment variable overrides token in "
"config file"
)
defaults["token"] = token
return defaults
def _read_config(config_file: pathlib.Path) -> configparser.ConfigParser:
config_parser = configparser.ConfigParser()
try:
config_parser.read(str(config_file))
except configparser.MissingSectionHeaderError:
pass # handled by the next check
if constants.CORE_SECTION_HDR not in config_parser:
raise exception.FileError(
"config file at '{!s}' does not contain the required "
"[repobee] header".format(config_file)
)
return config_parser