Major revamp of configuration handling

nigel.stanger / Handbook

Browse code Major revamp of configuration handling • Moved configuration file loading into Configuration class. • Added config getter methods to Configuration. • Updated and extended custom exception types. • Restructured error handling. • Factored out app name. master
1 parent 04cd35c commit 5b675672cd48adb87c02767523f78e3cfd52b0b9 Nigel Stanger authored on 28 Nov 2019

Browse code

• Moved configuration file loading into Configuration class.
• Added config getter methods to Configuration.
• Updated and extended custom exception types.
• Restructured error handling.
• Factored out app name.

master

1 parent 04cd35c commit 5b675672cd48adb87c02767523f78e3cfd52b0b9

Nigel Stanger authored on 28 Nov 2019

Patch

Showing 5 changed files

Ignore Space Show notes View calendar/teachingdates/app.py
import argparse import copy import pathlib import sys import teachingdates.calendars as calendars import teachingdates.config as configuration from teachingdates import PROG def run(): args = configuration.parse_command_line() if args.debug: print("{prog}: debug: args: {a}".format(prog=PROG, a=args)) try: dates_config = configuration.Configuration(args) if args.debug: print("{prog}: debug: period config: {c}".format( prog=PROG, c=dates_config.get_period_config())) print("{prog}: debug: paper config: {c}".format( prog=PROG, c=dates_config.get_paper_config())) cal = calendars.TeachingCalendar(dates_config.year, dates_config.period, dates_config.paper, dates_config.get_period_config(), dates_config.get_paper_config()) print("Period = {p}".format(p=args.period)) print(cal.calendar()) print(cal.lecture_dates()) except configuration.ConfigurationError as e: print("{prog}: error: failed to load configuration from " "'{file}'.".format(prog=PROG, file=e)) except configuration.PaperKeyError as e: print("{prog}: error: paper '{paper}' in '{file}' is missing " "required key '{key}'.".format(prog=PROG, paper=e.parent, file=e.file, key=e.key)) except configuration.PeriodKeyError as e: print("{prog}: error: teaching period '{period}' in '{file}' is " "missing required key '{key}'.".format(prog=PROG, period=e.parent, file=e.file, key=e.key)) except configuration.PaperError as e: print("{prog}: error: no entry for paper '{paper}' ({period}) in " "'{file}.'".format(prog=PROG, file=e, paper=args.paper, period=args.period)) except configuration.PeriodError as e: print("{prog}: error: no entry for teaching period '{period}' in " "'{file}'.".format(prog=PROG, file=e, period=args.period)) import argparse import copy import pathlib import sys from teachingdates import PROG import teachingdates.calendars as calendars import teachingdates.config as configuration def run(): args = configuration.parse_command_line() if args.debug: print("{prog}: debug: args: {a}".format(prog=PROG, a=args)) try: config = configuration.Configuration(args) if args.debug: print("{prog}: debug: period config: {c}".format( prog=PROG, c=config.get_period_config())) print("{prog}: debug: paper config: {c}".format( prog=PROG, c=config.get_paper_config())) cal = calendars.TeachingCalendar( config.year, config.period, config.paper, config.get_period_config(), config.get_paper_config()) print("Period = {p}".format(p=args.period)) print(cal.calendar()) print(cal.lecture_dates()) except configuration.LectureStyleError as e: print("{prog}: error: 'lecture' style was requested but " "{c} contains no papers for {t}.".format( prog=PROG, c=args.config, t=args.period)) except configuration.PaperError as e: print("{prog}: error: no entry in {c} for paper {p} ({t}).".format( prog=PROG, c=args.config, p=args.paper, t=args.period)) except configuration.PeriodError as e: print("{prog}: error: no entry in {c} for teaching " "period {p}.".format( prog=PROG, c=args.config_file, p=args.period)) except KeyError as e: print("{prog}: error: teaching period {p} in {c} is missing " "required key {k}.".format( prog=PROG, p=args.period, c=args.config, k=e))

Ignore Space Show notes View

calendar/teachingdates/app.py

import argparse
import copy
import pathlib
import sys

import teachingdates.calendars as calendars
import teachingdates.config as configuration
from teachingdates import PROG

def run():
    args = configuration.parse_command_line()
    if args.debug:
        print("{prog}: debug: args: {a}".format(prog=PROG, a=args))

try:
        dates_config = configuration.Configuration(args)
        if args.debug:
            print("{prog}: debug: period config: {c}".format(
                prog=PROG, c=dates_config.get_period_config()))
            print("{prog}: debug: paper config: {c}".format(
                prog=PROG, c=dates_config.get_paper_config()))
        cal = calendars.TeachingCalendar(dates_config.year,
                                         dates_config.period,
                                         dates_config.paper,
                                         dates_config.get_period_config(),
                                         dates_config.get_paper_config())
        print("Period = {p}".format(p=args.period))
        print(cal.calendar())
        print(cal.lecture_dates())

except configuration.ConfigurationError as e:
        print("{prog}: error: failed to load configuration from "
              "'{file}'.".format(prog=PROG, file=e))
    except configuration.PaperKeyError as e:
        print("{prog}: error: paper '{paper}' in '{file}' is missing "
              "required key '{key}'.".format(prog=PROG,
                                             paper=e.parent,
                                             file=e.file,
                                             key=e.key))
    except configuration.PeriodKeyError as e:
        print("{prog}: error: teaching period '{period}' in '{file}' is "
              "missing required key '{key}'.".format(prog=PROG,
                                                     period=e.parent,
                                                     file=e.file,
                                                     key=e.key))
    except configuration.PaperError as e:
        print("{prog}: error: no entry for paper '{paper}' ({period}) in "
              "'{file}.'".format(prog=PROG,
                                 file=e,
                                 paper=args.paper,
                                 period=args.period))
    except configuration.PeriodError as e:
        print("{prog}: error: no entry for teaching period '{period}' in "
              "'{file}'.".format(prog=PROG, file=e, period=args.period))

import argparse
import copy
import pathlib
import sys

from teachingdates import PROG
import teachingdates.calendars as calendars
import teachingdates.config as configuration

def run():
    args = configuration.parse_command_line()
    if args.debug:
        print("{prog}: debug: args: {a}".format(prog=PROG, a=args))

try:
        config = configuration.Configuration(args)
        if args.debug:
            print("{prog}: debug: period config: {c}".format(
                prog=PROG, c=config.get_period_config()))
            print("{prog}: debug: paper config: {c}".format(
                prog=PROG, c=config.get_paper_config()))
        cal = calendars.TeachingCalendar(
            config.year, config.period, config.paper,
            config.get_period_config(), config.get_paper_config())
        print("Period = {p}".format(p=args.period))
        print(cal.calendar())
        print(cal.lecture_dates())
    except configuration.LectureStyleError as e:
        print("{prog}: error: 'lecture' style was requested but "
            "{c} contains no papers for {t}.".format(
                prog=PROG, c=args.config, t=args.period))
    except configuration.PaperError as e:
        print("{prog}: error: no entry in {c} for paper {p} ({t}).".format(
            prog=PROG, c=args.config, p=args.paper, t=args.period))
    except configuration.PeriodError as e:
        print("{prog}: error: no entry in {c} for teaching "
            "period {p}.".format(
                prog=PROG, c=args.config_file, p=args.period))
    except KeyError as e:
        print("{prog}: error: teaching period {p} in {c} is missing "
            "required key {k}.".format(
                prog=PROG, p=args.period, c=args.config, k=e))

Ignore Space Show notes View calendar/teachingdates/config/__init__.py
from .cli import parse_command_line from .config import Configuration from .errors import (ConfigurationError, PaperError, PaperKeyError, PeriodError, PeriodKeyError) from .cli import parse_command_line from .config import Configuration, load_config from .errors import LectureStyleError, PaperError, PeriodError

Ignore Space Show notes View calendar/teachingdates/config/cli.py
import argparse import datetime from teachingdates import PROG def parse_command_line(): """Parse command-line arguments. Example command lines: generate_dates --style calendar --format latex --year 2020 --period S1 --paper INFO201 generate_dates --style lecture --format xml --period S2 --paper INFO202 """ format_map = { "t": "text", "text": "text", "l": "latex", "latex": "latex", "x": "xml", "xml": "xml", } style_map = { "c": "calendar", "calendar": "calendar", "l": "lecture", "lecture": "lecture", "i": "iso", "iso": "iso", } parser = argparse.ArgumentParser(prog=PROG, description="") parser.add_argument( "--config", "-c", default=None, dest="config_file", help="file name of the configuration file " "[default '~/.config/{prog}/config.yml']".format(prog=PROG)) parser.add_argument("--debug", "-d", action='store_true', help="enable debugging output") parser.add_argument("--format", "-f", default="latex", choices=["text", "t", "latex", "l", "xml", "x"], help="output format [default 'latex']") parser.add_argument("--output", "-o", type=argparse.FileType("w", encoding="UTF-8"), help="file name to write the output to; existing " "files of the same name will be overwritten!") parser.add_argument( "--paper", "-p", default=None, help="paper code (e.g., INFO201) [required for 'lecture' style, " "ignored otherwise]") parser.add_argument( "--style", "-s", default="calendar", choices=["calendar", "c", "lecture", "l", "iso", "i"], help="output style: 'calendar' for teaching calendars in course " "outlines, 'lecture' for individual lecture dates, or 'iso'" "for dates across the entire ISO-8601 year [default 'calendar']") parser.add_argument("--teaching-period", "-t", default=None, choices=["SS", "S1", "S2", "FY"], dest="period", help="teaching period [required]") parser.add_argument( "--year", "-y", type=int, default=datetime.date.today().year, help=("the year to generate dates for [default {y}]".format( y=datetime.date.today().year))) args = parser.parse_args() # normalise format and style args.format = format_map[args.format] args.style = style_map[args.style] if args.style == "calendar": # --paper is irrelevant if args.paper: print("{prog}: warning: --paper/-p is ignored for 'calendar' " "style".format(prog=PROG)) # --teaching-period is required if not args.period: parser.exit( 2, "{prog}: error: --teaching-period/-t is required for " "'calendar' style\n".format(prog=PROG)) elif args.style == "iso": # both --paper and --teaching-period are irrelevant if args.paper or args.period: print("{prog}: warning: --paper/-p and --teaching-period/-t are " "ignored for 'iso' style".format(prog=PROG)) elif args.style == "lecture": # both --paper and --teaching-period are required if not args.paper: parser.exit( 2, message="{prog}: error: -paper/-p and --teaching-period/-t " "are required for 'lecture' style\n".format(prog=PROG)) else: pass return args import argparse import datetime from teachingdates import PROG from .config import load_config def parse_command_line(): """Parse command-line arguments. Example command lines: generate_dates --style calendar --format latex --year 2020 --period S1 --paper INFO201 generate_dates --style lecture --format xml --period S2 --paper INFO202 """ format_map = { "t": "text", "text": "text", "l": "latex", "latex": "latex", "x": "xml", "xml": "xml", } style_map = { "c": "calendar", "calendar": "calendar", "l": "lecture", "lecture": "lecture", "i": "iso", "iso": "iso", } parser = argparse.ArgumentParser(prog=PROG, description="") parser.add_argument( "--config", "-c", default=None, dest="config_file", help="file name of the configuration file " "[default '~/.config/{prog}/config.yml']".format(prog=PROG)) parser.add_argument( "--debug", "-d", action='store_true', help="enable debugging output") parser.add_argument( "--format", "-f", default="latex", choices=["text", "t", "latex", "l", "xml", "x"], help="output format [default 'latex']") parser.add_argument( "--output", "-o", type=argparse.FileType("w", encoding="UTF-8"), help="file name to write the output to; existing " "files of the same name will be overwritten!") parser.add_argument( "--paper", "-p", default=None, help="paper code (e.g., INFO201) [required for 'lecture' style, " "ignored otherwise]") parser.add_argument( "--style", "-s", default="calendar", choices=["calendar", "c", "lecture", "l", "iso", "i"], help="output style: 'calendar' for teaching calendars in course " "outlines, 'lecture' for individual lecture dates, or 'iso'" "for dates across the entire ISO-8601 year [default 'calendar']") parser.add_argument( "--teaching-period", "-t", default=None, choices=["SS", "S1", "S2", "FY"], dest="period", help="teaching period [required]") parser.add_argument( "--year", "-y", type=int, default=datetime.date.today().year, help=("the year to generate dates for [default {y}]".format( y=datetime.date.today().year))) args = parser.parse_args() # normalise format and style args.format = format_map[args.format] args.style = style_map[args.style] # Load the default config if none is explicitly specified. args.config_file, args.config = load_config(file=args.config_file) if not args.config: parser.exit(2, "{prog}: error: failed to load configuration " "from '{f}'\n".format(prog=PROG, f=args.config_file)) if args.style == "calendar": # --paper is irrelevant if args.paper: print("{prog}: warning: --paper/-p is ignored for " "'calendar' style".format(prog=PROG)) # --teaching-period is required if not args.period: parser.exit(2, "{prog}: error: --teaching-period/-t " "is required for 'calendar' style\n".format(prog=PROG)) elif args.style == "iso": # both --paper and --teaching-period are irrelevant if args.paper or args.period: print("{prog}: warning: --paper/-p and " "--teaching-period/-t are ignored for 'iso' " "style".format(prog=PROG)) elif args.style == "lecture": # both --paper and --teaching-period are required if not args.paper: parser.exit(2, message="{prog}: error: -paper/-p and " "--teaching-period/-t are required for 'lecture' " "style\n".format(prog=PROG)) else: pass return args

Ignore Space Show notes View

calendar/teachingdates/config/cli.py

import argparse
import datetime

from teachingdates import PROG

def parse_command_line():
    """Parse command-line arguments.

Example command lines:
    generate_dates --style calendar --format latex --year 2020 --period S1 --paper INFO201
    generate_dates --style lecture --format xml --period S2 --paper INFO202
    """
    format_map = {
        "t": "text",
        "text": "text",
        "l": "latex",
        "latex": "latex",
        "x": "xml",
        "xml": "xml",
    }
    style_map = {
        "c": "calendar",
        "calendar": "calendar",
        "l": "lecture",
        "lecture": "lecture",
        "i": "iso",
        "iso": "iso",
    }

parser = argparse.ArgumentParser(prog=PROG, description="")

parser.add_argument(
        "--config",
        "-c",
        default=None,
        dest="config_file",
        help="file name of the configuration file "
        "[default '~/.config/{prog}/config.yml']".format(prog=PROG))

parser.add_argument("--debug",
                        "-d",
                        action='store_true',
                        help="enable debugging output")

parser.add_argument("--format",
                        "-f",
                        default="latex",
                        choices=["text", "t", "latex", "l", "xml", "x"],
                        help="output format [default 'latex']")

parser.add_argument("--output",
                        "-o",
                        type=argparse.FileType("w", encoding="UTF-8"),
                        help="file name to write the output to; existing "
                        "files of the same name will be overwritten!")

parser.add_argument(
        "--paper",
        "-p",
        default=None,
        help="paper code (e.g., INFO201) [required for 'lecture' style, "
        "ignored otherwise]")

parser.add_argument(
        "--style",
        "-s",
        default="calendar",
        choices=["calendar", "c", "lecture", "l", "iso", "i"],
        help="output style: 'calendar' for teaching calendars in course "
        "outlines, 'lecture' for individual lecture dates, or 'iso'"
        "for dates across the entire ISO-8601 year [default 'calendar']")

parser.add_argument("--teaching-period",
                        "-t",
                        default=None,
                        choices=["SS", "S1", "S2", "FY"],
                        dest="period",
                        help="teaching period [required]")

parser.add_argument(
        "--year",
        "-y",
        type=int,
        default=datetime.date.today().year,
        help=("the year to generate dates for [default {y}]".format(
            y=datetime.date.today().year)))

args = parser.parse_args()
    # normalise format and style
    args.format = format_map[args.format]
    args.style = style_map[args.style]

if args.style == "calendar":
        # --paper is irrelevant
        if args.paper:
            print("{prog}: warning: --paper/-p is ignored for 'calendar' "
                  "style".format(prog=PROG))
        # --teaching-period is required
        if not args.period:
            parser.exit(
                2, "{prog}: error: --teaching-period/-t is required for "
                "'calendar' style\n".format(prog=PROG))

elif args.style == "iso":
        # both --paper and --teaching-period are irrelevant
        if args.paper or args.period:
            print("{prog}: warning: --paper/-p and --teaching-period/-t are "
                  "ignored for 'iso' style".format(prog=PROG))

elif args.style == "lecture":
        # both --paper and --teaching-period are required
        if not args.paper:
            parser.exit(
                2,
                message="{prog}: error: -paper/-p and --teaching-period/-t "
                "are required for 'lecture' style\n".format(prog=PROG))

else:
        pass

return args

import argparse
import datetime

from teachingdates import PROG
from .config import load_config

def parse_command_line():
    """Parse command-line arguments.

parser = argparse.ArgumentParser(prog=PROG, description="")
    
    parser.add_argument(
        "--config", "-c", default=None, dest="config_file",
        help="file name of the configuration file "
            "[default '~/.config/{prog}/config.yml']".format(prog=PROG))
    
    parser.add_argument(
        "--debug", "-d", action='store_true',
        help="enable debugging output")
    
    parser.add_argument(
        "--format", "-f", default="latex",
        choices=["text", "t", "latex", "l", "xml", "x"],
        help="output format [default 'latex']")
    
    parser.add_argument(
        "--output", "-o",
        type=argparse.FileType("w", encoding="UTF-8"),
        help="file name to write the output to; existing "
            "files of the same name will be overwritten!")
    
    parser.add_argument(
        "--paper", "-p", default=None,
        help="paper code (e.g., INFO201) [required for 'lecture' style, "
            "ignored otherwise]")
    
    parser.add_argument(
        "--style", "-s", default="calendar",
        choices=["calendar", "c", "lecture", "l", "iso", "i"],
        help="output style: 'calendar' for teaching calendars in course "
            "outlines, 'lecture' for individual lecture dates, or 'iso'"
            "for dates across the entire ISO-8601 year [default 'calendar']")
    
    parser.add_argument(
        "--teaching-period", "-t", default=None,
        choices=["SS", "S1", "S2", "FY"], dest="period",
        help="teaching period [required]")
    
    parser.add_argument(
        "--year", "-y", type=int, default=datetime.date.today().year,
        help=("the year to generate dates for [default {y}]".format(
            y=datetime.date.today().year)))
    
    args = parser.parse_args()
    # normalise format and style
    args.format = format_map[args.format]
    args.style = style_map[args.style]

# Load the default config if none is explicitly specified.
    args.config_file, args.config = load_config(file=args.config_file)
    if not args.config:
        parser.exit(2, "{prog}: error: failed to load configuration "
            "from '{f}'\n".format(prog=PROG, f=args.config_file))

if args.style == "calendar":
        # --paper is irrelevant
        if args.paper:
            print("{prog}: warning: --paper/-p is ignored for "
                "'calendar' style".format(prog=PROG))
        # --teaching-period is required
        if not args.period:
            parser.exit(2, "{prog}: error: --teaching-period/-t "
                "is required for 'calendar' style\n".format(prog=PROG))

elif args.style == "iso":
        # both --paper and --teaching-period are irrelevant
        if args.paper or args.period:
            print("{prog}: warning: --paper/-p and "
                "--teaching-period/-t are ignored for 'iso' "
                "style".format(prog=PROG))

elif args.style == "lecture":
        # both --paper and --teaching-period are required
        if not args.paper:
            parser.exit(2, message="{prog}: error: -paper/-p and "
                "--teaching-period/-t are required for 'lecture' "
                "style\n".format(prog=PROG))
    
    else:
        pass
    
    return args

Ignore Space Show notes View calendar/teachingdates/config/config.py
import datetime import importlib.resources as pkg_resources from pathlib import Path from shutil import copyfile import yaml from teachingdates import PROG from .errors import (ConfigurationError, PaperError, PaperKeyError, PeriodError, PeriodKeyError) CONFIG_FILENAME = "config.yml" CONFIG_DIR = Path.home().joinpath(".config", PROG) CONFIG_FILE = CONFIG_DIR.joinpath(CONFIG_FILENAME) class Configuration(object): """Validate and structure the configuration for easy access. Includes methods to return the period configuration and the paper configuration, as applicable. (Yes, the period configuration includes the paper configuration, but it may also include other papers, so it's more convenient to return these separately.) The configuration file will normally contain specifications for several teaching periods and papers. We don't need all of this: usually we're only interested in one teaching period and one paper (if relevant). """ style = None period = None paper = None year = None config = None config_file = None def __init__(self, args): self.load_config(file=args.config_file) self.style = args.style self.period = args.period self.paper = args.paper # priority: year on command line (defaults to current year), # year in config self.year = (self.config["year"] if "year" in self.config.keys() else args.year) period_config = paper_config = None if self.style != "iso": if self.period not in self.config.keys(): raise PeriodError(str(self.config_file)) period_config = self.config[self.period] # the "name" and "weeks" keys are required for key in ["name", "weeks"]: if key not in period_config.keys(): raise PeriodKeyError(key, self.period, self.config_file) # Papers are only relevant in "lecture" style, which by definition # must specify a paper. try: if (self.style == "lecture" and "papers" in period_config.keys() and self.paper in period_config["papers"].keys()): paper_config = period_config["papers"][self.paper] # we expect at least a "lectures" entry if (not paper_config or "lectures" not in paper_config.keys()): raise PaperKeyError("lectures", self.paper, self.config_file) else: raise PaperError(str(self.config_file)) except AttributeError as e: raise PaperError(str(self.config_file)) def load_config(self, file=None): """Load a configuration file. If no file is specified, try the default configuration in ~/.config. If that doesn't exist, copy the default configuration from teachingdates.config. """ cfg = None if not file: file = CONFIG_FILE if not CONFIG_FILE.exists(): CONFIG_DIR.mkdir(exist_ok=True) configmgr = pkg_resources.path("teachingdates.config", CONFIG_FILENAME) with configmgr as f: copyfile(f, CONFIG_FILE) print("{prog}: created new configuration file at " "'{f}'".format(prog=PROG, f=str(CONFIG_FILE))) try: with open(file) as f: cfg = yaml.safe_load(f.read()) except FileNotFoundError as e: print("{prog}: error: no such file '{file}'".format(prog=PROG, file=file)) if not cfg: raise ConfigurationError(str(file)) self.config_file = file self.config = cfg def get_period_config(self, period=None): """Get the configuration details for a teaching period. No need to specify the year as all configurations are for a single year anyway. """ period = self.period if period is None else period if period in self.config.keys(): return self.config[period] else: return None def get_paper_config(self, period=None, paper=None): """Get the configuration details for a paper. Can optionally specify the teaching period. No need to specify the year as all configurations are for a single year anyway. """ paper = self.paper if paper is None else paper period_config = self.get_period_config(period=period) if (period_config and "papers" in period_config.keys() and paper in period_config["papers"].keys()): return period_config["papers"][paper] else: return None import datetime import importlib.resources as pkg_resources from pathlib import Path from shutil import copyfile import yaml from teachingdates import PROG from .errors import LectureStyleError, PaperError, PeriodError CONFIG_FILENAME = "config.yml" CONFIG_DIR = Path.home().joinpath(".config", PROG) CONFIG_FILE = CONFIG_DIR.joinpath(CONFIG_FILENAME) class Configuration(object): """Validate and structure the configuration for easy access. Includes methods to return the period configuration and the paper configuration, as applicable. (Yes, the period configuration includes the paper configuration, but it may also include other papers, so it's more convenient to return these separately.) The configuration file will normally contain specifications for several teaching periods and papers. We don't need all of this: usually we're only interested in one teaching period and one paper (if relevant). """ style = None period = None paper = None year = None config = None def __init__(self, args): self.config = args.config self.style = args.style self.period = args.period self.paper = args.paper # priority: year on command line (defaults to current year), # year in config self.year = ( args.config["year"] if "year" in args.config.keys() else args.year) period_config = paper_config = None if self.style != "iso": if self.period not in self.config.keys(): raise PeriodError() period_config = self.config[self.period] # raises KeyError if source key is missing period_config["name"] and period_config["weeks"] # papers are irrelevant in "calendar" style if self.style == "lecture": if "papers" in period_config.keys(): if self.paper in period_config["papers"].keys(): paper_config = period_config["papers"][self.paper] # we expect at least a "lectures" entry paper_config["lectures"] else: raise PaperError() else: raise LectureStyleError() def get_period_config(self, period=None): period = self.period if period is None else period if period in self.config.keys(): return self.config[period] else: return None def get_paper_config(self, period=None, paper=None): paper = self.paper if paper is None else paper period_config = self.get_period_config(period=period) if (period_config and "papers" in period_config.keys() and paper in period_config["papers"].keys()): return period_config["papers"][paper] else: return None def load_config(file=None): """Load a configuration file. If no file is specified, try the default configuration in ~/.config. If that doesn't exist, copy the default configuration from teachingdates.config. """ cfg = None if not file: file = CONFIG_FILE if not CONFIG_FILE.exists(): CONFIG_DIR.mkdir(exist_ok=True) configmgr = pkg_resources.path( "teachingdates.config", CONFIG_FILENAME) with configmgr as f: copyfile(f, CONFIG_FILE) print("{prog}: created new configuration file at " "'{f}'".format(prog=PROG, f=str(CONFIG_FILE))) try: with open(file) as f: cfg = yaml.safe_load(f.read()) except FileNotFoundError as e: print("{prog}: error: no such file '{f}'".format(prog=PROG, f=file)) return file, cfg

Ignore Space Show notes View

calendar/teachingdates/config/config.py

import datetime
import importlib.resources as pkg_resources
from pathlib import Path
from shutil import copyfile

import yaml

from teachingdates import PROG

from .errors import (ConfigurationError, PaperError, PaperKeyError,
                     PeriodError, PeriodKeyError)

CONFIG_FILENAME = "config.yml"
CONFIG_DIR = Path.home().joinpath(".config", PROG)
CONFIG_FILE = CONFIG_DIR.joinpath(CONFIG_FILENAME)

class Configuration(object):
    """Validate and structure the configuration for easy access.

Includes methods to return the period configuration and the paper
    configuration, as applicable. (Yes, the period configuration
    includes the paper configuration, but it may also include other
    papers, so it's more convenient to return these separately.)

The configuration file will normally contain specifications for
    several teaching periods and papers. We don't need all of this:
    usually we're only interested in one teaching period and one
    paper (if relevant).
    """
    style = None
    period = None
    paper = None
    year = None
    config = None
    config_file = None

def __init__(self, args):
        self.load_config(file=args.config_file)
        self.style = args.style
        self.period = args.period
        self.paper = args.paper
        # priority: year on command line (defaults to current year),
        # year in config
        self.year = (self.config["year"]
                     if "year" in self.config.keys() else args.year)

period_config = paper_config = None
        if self.style != "iso":
            if self.period not in self.config.keys():
                raise PeriodError(str(self.config_file))

period_config = self.config[self.period]
            # the "name" and "weeks" keys are required
            for key in ["name", "weeks"]:
                if key not in period_config.keys():
                    raise PeriodKeyError(key, self.period, self.config_file)

# Papers are only relevant in "lecture" style, which by definition
            # must specify a paper.
            try:
                if (self.style == "lecture"
                        and "papers" in period_config.keys()
                        and self.paper in period_config["papers"].keys()):
                    paper_config = period_config["papers"][self.paper]
                    # we expect at least a "lectures" entry
                    if (not paper_config
                            or "lectures" not in paper_config.keys()):
                        raise PaperKeyError("lectures", self.paper,
                                            self.config_file)
                else:
                    raise PaperError(str(self.config_file))
            except AttributeError as e:
                raise PaperError(str(self.config_file))

def load_config(self, file=None):
        """Load a configuration file.

If no file is specified, try the default configuration in
        ~/.config. If that doesn't exist, copy the default configuration
        from teachingdates.config.
        """
        cfg = None
        if not file:
            file = CONFIG_FILE
            if not CONFIG_FILE.exists():
                CONFIG_DIR.mkdir(exist_ok=True)
                configmgr = pkg_resources.path("teachingdates.config",
                                               CONFIG_FILENAME)
                with configmgr as f:
                    copyfile(f, CONFIG_FILE)
                    print("{prog}: created new configuration file at "
                          "'{f}'".format(prog=PROG, f=str(CONFIG_FILE)))
        try:
            with open(file) as f:
                cfg = yaml.safe_load(f.read())
        except FileNotFoundError as e:
            print("{prog}: error: no such file '{file}'".format(prog=PROG,
                                                             file=file))
        if not cfg:
            raise ConfigurationError(str(file))
        self.config_file = file
        self.config = cfg

def get_period_config(self, period=None):
        """Get the configuration details for a teaching period.

No need to specify the year as all configurations are for a
        single year anyway.
        """
        period = self.period if period is None else period
        if period in self.config.keys():
            return self.config[period]
        else:
            return None

def get_paper_config(self, period=None, paper=None):
        """Get the configuration details for a paper.

Can optionally specify the teaching period. No need to specify
        the year as all configurations are for a single year anyway.
        """
        paper = self.paper if paper is None else paper
        period_config = self.get_period_config(period=period)
        if (period_config and "papers" in period_config.keys()
                and paper in period_config["papers"].keys()):
            return period_config["papers"][paper]
        else:
            return None

import datetime
import importlib.resources as pkg_resources
from pathlib import Path
from shutil import copyfile
import yaml

from teachingdates import PROG
from .errors import LectureStyleError, PaperError, PeriodError

CONFIG_FILENAME = "config.yml"
CONFIG_DIR = Path.home().joinpath(".config", PROG)
CONFIG_FILE = CONFIG_DIR.joinpath(CONFIG_FILENAME)

class Configuration(object):
    """Validate and structure the configuration for easy access.

def __init__(self, args):
        self.config = args.config
        self.style = args.style
        self.period = args.period
        self.paper = args.paper
        # priority: year on command line (defaults to current year),
        # year in config
        self.year = (
            args.config["year"] if "year" in args.config.keys()
            else args.year)

period_config = paper_config = None
        if self.style != "iso":
            if self.period not in self.config.keys():
                raise PeriodError()

period_config = self.config[self.period]
            # raises KeyError if source key is missing
            period_config["name"] and period_config["weeks"]

# papers are irrelevant in "calendar" style
            if self.style == "lecture":
                if "papers" in period_config.keys():
                    if self.paper in period_config["papers"].keys():
                        paper_config = period_config["papers"][self.paper]
                        # we expect at least a "lectures" entry
                        paper_config["lectures"]
                    else:
                        raise PaperError()
                else:
                    raise LectureStyleError()

def get_period_config(self, period=None):
        period = self.period if period is None else period
        if period in self.config.keys():
            return self.config[period]
        else:
            return None

def get_paper_config(self, period=None, paper=None):
        paper = self.paper if paper is None else paper
        period_config = self.get_period_config(period=period)
        if (period_config and "papers" in period_config.keys() and
                paper in period_config["papers"].keys()):
            return period_config["papers"][paper]
        else:
            return None

def load_config(file=None):
    """Load a configuration file.

If no file is specified, try the default configuration in
    ~/.config. If that doesn't exist, copy the default configuration
    from teachingdates.config.
    """
    cfg = None
    if not file:
        file = CONFIG_FILE
        if not CONFIG_FILE.exists():
            CONFIG_DIR.mkdir(exist_ok=True)
            configmgr = pkg_resources.path(
                "teachingdates.config", CONFIG_FILENAME)
            with configmgr as f:
                copyfile(f, CONFIG_FILE)
                print("{prog}: created new configuration file at "
                    "'{f}'".format(prog=PROG, f=str(CONFIG_FILE)))
    try:
        with open(file) as f:
            cfg = yaml.safe_load(f.read())
    except FileNotFoundError as e:
        print("{prog}: error: no such file '{f}'".format(prog=PROG, f=file))
    return file, cfg

Ignore Space Show notes View calendar/teachingdates/config/errors.py
class ConfigurationError(Exception): """Exception for general errors while loading a configuration file. """ pass class ConfigurationKeyError(KeyError): """Exception for missing required keys in the configuration file. """ def __init__(self, key, parent, file): self.key = key self.parent = parent self.file = file class PaperKeyError(ConfigurationKeyError): """Exception for missing paper keys in the configuration file. """ pass class PeriodKeyError(ConfigurationKeyError): """Exception for missing teaching period keys in the configuration file. """ pass class PaperError(KeyError): """Exception for missing paper in the configuration. """ pass class PeriodError(KeyError): """Exception for missing teaching period in the configuration. """ pass class PeriodError(KeyError): pass class PaperError(KeyError): pass class LectureStyleError(KeyError): pass

Ignore Space Show notes View

calendar/teachingdates/config/errors.py

Show line notes below