Added basic plain text output

nigel.stanger / Handbook

Browse code Added basic plain text output master
1 parent 0d96b96 commit 8356d93db17e75996adf3eefc35c05be99f82649 Nigel Stanger authored on 28 Nov 2019

Patch

Showing 2 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.from_configuration(dates_config) if args.debug: print("Calendar: {cal}".format(cal=cal.calendar())) print("Lectures: {lec}".format(lec=cal.lecture_dates())) for c in cal.render(args.style, args.format): print(c) 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 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.from_configuration(dates_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))

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.from_configuration(dates_config)
        if args.debug:
            print("Calendar: {cal}".format(cal=cal.calendar()))
            print("Lectures: {lec}".format(lec=cal.lecture_dates()))
        for c in cal.render(args.style, args.format):
            print(c)

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

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.from_configuration(dates_config)
        print("Period = {p}".format(p=args.period))
        print(cal.calendar())
        print(cal.lecture_dates())

Ignore Space Show notes View calendar/teachingdates/calendars/basecalendar.py
import calendar import datetime from teachingdates import PROG from .weeks import BreakWeek, IsoWeek, TeachingWeek class TeachingCalendar(): """This class generates teaching-related dates for a specific paper offered in a specific teaching period of a specific year. If you don't provide teaching period details, it generates dates for the current ISO-8601 year. """ weeks = [] lecture_offsets = [] skipped_lectures = [] mondays = [] period = "iso" year = datetime.date.today().year def __init__(self, year, period, paper, period_config=None, paper_config=None): self.year = year self.period = period self.paper = paper # This is likely to end up with one week too many at the end, # but that doesn't matter as there will never be any teaching # during the last week of December! cal = calendar.Calendar().yeardatescalendar(self.year, width=12) self.mondays = [week[0] for month in cal[0] for week in month] self.mondays = list(dict.fromkeys(self.mondays)) if period_config: self.update_weeks(period_config["weeks"]) else: last_week = datetime.date(self.year, 12, 28).isocalendar()[1] self.update_weeks([{"iso": [1, last_week]}]) if paper_config: self.update_lectures(paper_config["lectures"]) @classmethod def from_configuration(cls, config): if config: return cls(config.year, config.period, config.paper, config.get_period_config(), config.get_paper_config()) else: return None def make_week(self, week_type, start, end=None): end = start if end is None else end return [ week_type(self.mondays[w].year, self.mondays[w].month, self.mondays[w].day) for w in range(start - 1, end) ] def teaching_date(self, period, week, offset=0): pass def update_weeks(self, week_list): for w in week_list: for t, r in w.items(): if t == "teach": self.weeks += self.make_week(TeachingWeek, r[0], r[1]) elif t == "break": self.weeks += self.make_week(BreakWeek, r[0], r[1]) elif t == "iso": self.weeks += self.make_week(IsoWeek, r[0], r[1]) else: print("{prog}: warning: ignored unknown week type " "'{type}'.".format(prog=PROG, type=t)) def update_lectures(self, lecture_list): for l in lecture_list: for t, v in l.items(): if t == "offsets": self.lecture_offsets = v elif t == "skip": self.skipped_lectures = v else: print("{prog}: warning: ignored unknown lecture key " "'{key}'.".format(prog=PROG, key=t)) # turn this into a generator? def calendar(self): period = {} week_num = break_num = 0 for w in self.weeks: if isinstance(w, (TeachingWeek, IsoWeek)): # Increment first so that break weeks have the # same week number as the preceding teaching week. # This ensures the keys are always chronologically # sorted. Reset the break number for each new # teaching week. week_num += 1 break_num = 0 period[week_num] = w elif isinstance(w, BreakWeek): # Allow for up to 99 consecutive break weeks, # which should be sufficient :). Should probably # throw an exception if we exceed that. break_num += 0.01 period[week_num + break_num] = w return period # turn this into a generator? def lecture_dates(self): dates = {} lecture_num = 1 teaching_weeks = [t for t in self.weeks if isinstance(t, TeachingWeek)] for week_index, monday in enumerate(teaching_weeks): for offset_index, offset in enumerate(self.lecture_offsets): lec = week_index * 2 + offset_index + 1 if lec in self.skipped_lectures: continue dates[lecture_num] = monday + datetime.timedelta(offset) lecture_num += 1 return dates def render(self, style, fmt): if fmt == "text": return(self.render_text(style)) elif fmt == "latex": return(self.render_latex(style)) elif fmt == "xml": return(self.render_xml(style)) else: return("") def render_text(self, style): # probably cleaner to create Jinja templates? if style == "calendar": yield "# Teaching calendar for {period} {year}".format( period=self.period, year=self.year) for weeknum, monday in self.calendar().items(): if isinstance(monday, TeachingWeek): yield "Week {week}: {mon} — {fri}".format( week=str(weeknum).rjust(2), mon=monday.isoformat(), fri=monday + datetime.timedelta(days=4)) elif isinstance(monday, BreakWeek): yield "Break : {mon} — {fri}".format( mon=monday.isoformat(), fri=monday + datetime.timedelta(days=4)) else: yield ("") elif style == "lecture": yield "# Lecture dates for {paper} {period} {year}".format( paper=self.paper, period=self.period, year=self.year) for lecnum, day in self.lecture_dates().items(): yield "Lecture {lecture}: {day}".format( lecture=str(lecnum).rjust(2), day=day.isoformat()) else: yield("") def render_latex(self, style): if style == "calendar": pass elif style == "lecture": pass else: return("") def render_xml(self, style): if style == "calendar": pass elif style == "lecture": pass else: return("") import calendar import datetime from teachingdates import PROG from .weeks import BreakWeek, IsoWeek, TeachingWeek class TeachingCalendar(): """This class generates teaching-related dates for a specific paper offered in a specific teaching period of a specific year. If you don't provide teaching period details, it generates dates for the current ISO-8601 year. """ weeks = [] lecture_offsets = [] skipped_lectures = [] mondays = [] period = "iso" year = datetime.date.today().year def __init__(self, year, period, paper, period_config=None, paper_config=None): self.year = year self.period = period self.paper = paper # This is likely to end up with one week too many at the end, # but that doesn't matter as there will never be any teaching # during the last week of December! cal = calendar.Calendar().yeardatescalendar(self.year, width=12) self.mondays = [week[0] for month in cal[0] for week in month] self.mondays = list(dict.fromkeys(self.mondays)) if period_config: self.update_weeks(period_config["weeks"]) else: last_week = datetime.date(self.year, 12, 28).isocalendar()[1] self.update_weeks([{"iso": [1, last_week]}]) if paper_config: self.update_lectures(paper_config["lectures"]) @classmethod def from_configuration(cls, config): if config: return cls(config.year, config.period, config.paper, config.get_period_config(), config.get_paper_config()) else: return None def make_week(self, week_type, start, end=None): end = start if end is None else end return [ week_type(self.mondays[w].year, self.mondays[w].month, self.mondays[w].day) for w in range(start - 1, end) ] def teaching_date(self, period, week, offset=0): pass def update_weeks(self, week_list): for w in week_list: for t, r in w.items(): if t == "teach": self.weeks += self.make_week(TeachingWeek, r[0], r[1]) elif t == "break": self.weeks += self.make_week(BreakWeek, r[0], r[1]) elif t == "iso": self.weeks += self.make_week(IsoWeek, r[0], r[1]) else: print("{prog}: warning: ignored unknown week type " "'{type}'.".format(prog=PROG, type=t)) def update_lectures(self, lecture_list): for l in lecture_list: for t, v in l.items(): if t == "offsets": self.lecture_offsets = v elif t == "skip": self.skipped_lectures = v else: print("{prog}: warning: ignored unknown lecture key " "'{key}'.".format(prog=PROG, key=t)) def calendar(self): period = {} week_num = break_num = 0 for w in self.weeks: if isinstance(w, (TeachingWeek, IsoWeek)): # Increment first so that break weeks have the # same week number as the preceding teaching week. # This ensures the keys are always chronologically # sorted. Reset the break number for each new # teaching week. week_num += 1 break_num = 0 period[week_num] = w elif isinstance(w, BreakWeek): # Allow for up to 99 consecutive break weeks, # which should be sufficient :). Should probably # throw an exception if we exceed that. break_num += 0.01 period[week_num + break_num] = w return period def lecture_dates(self): dates = {} lecture_num = 1 teaching_weeks = [t for t in self.weeks if isinstance(t, TeachingWeek)] for week_index, monday in enumerate(teaching_weeks): for offset_index, offset in enumerate(self.lecture_offsets): lec = week_index * 2 + offset_index + 1 if lec in self.skipped_lectures: continue dates[lecture_num] = monday + datetime.timedelta(offset) lecture_num += 1 return dates

Ignore Space Show notes View

calendar/teachingdates/calendars/basecalendar.py

import calendar
import datetime

from teachingdates import PROG

from .weeks import BreakWeek, IsoWeek, TeachingWeek

class TeachingCalendar():
    """This class generates teaching-related dates for a specific paper
    offered in a specific teaching period of a specific year. If you
    don't provide teaching period details, it generates dates for the
    current ISO-8601 year.
    """
    weeks = []
    lecture_offsets = []
    skipped_lectures = []
    mondays = []
    period = "iso"
    year = datetime.date.today().year

def __init__(self,
                 year,
                 period,
                 paper,
                 period_config=None,
                 paper_config=None):
        self.year = year
        self.period = period
        self.paper = paper

# This is likely to end up with one week too many at the end,
        # but that doesn't matter as there will never be any teaching
        # during the last week of December!
        cal = calendar.Calendar().yeardatescalendar(self.year, width=12)

self.mondays = [week[0] for month in cal[0] for week in month]
        self.mondays = list(dict.fromkeys(self.mondays))
        if period_config:
            self.update_weeks(period_config["weeks"])
        else:
            last_week = datetime.date(self.year, 12, 28).isocalendar()[1]
            self.update_weeks([{"iso": [1, last_week]}])
        if paper_config:
            self.update_lectures(paper_config["lectures"])

@classmethod
    def from_configuration(cls, config):
        if config:
            return cls(config.year, config.period, config.paper,
                       config.get_period_config(), config.get_paper_config())
        else:
            return None

def make_week(self, week_type, start, end=None):
        end = start if end is None else end
        return [
            week_type(self.mondays[w].year, self.mondays[w].month,
                      self.mondays[w].day) for w in range(start - 1, end)
        ]

def teaching_date(self, period, week, offset=0):
        pass

def update_weeks(self, week_list):
        for w in week_list:
            for t, r in w.items():
                if t == "teach":
                    self.weeks += self.make_week(TeachingWeek, r[0], r[1])
                elif t == "break":
                    self.weeks += self.make_week(BreakWeek, r[0], r[1])
                elif t == "iso":
                    self.weeks += self.make_week(IsoWeek, r[0], r[1])
                else:
                    print("{prog}: warning: ignored unknown week type "
                          "'{type}'.".format(prog=PROG, type=t))

def update_lectures(self, lecture_list):
        for l in lecture_list:
            for t, v in l.items():
                if t == "offsets":
                    self.lecture_offsets = v
                elif t == "skip":
                    self.skipped_lectures = v
                else:
                    print("{prog}: warning: ignored unknown lecture key "
                          "'{key}'.".format(prog=PROG, key=t))

# turn this into a generator?
    def calendar(self):
        period = {}
        week_num = break_num = 0
        for w in self.weeks:
            if isinstance(w, (TeachingWeek, IsoWeek)):
                # Increment first so that break weeks have the
                # same week number as the preceding teaching week.
                # This ensures the keys are always chronologically
                # sorted. Reset the break number for each new
                # teaching week.
                week_num += 1
                break_num = 0
                period[week_num] = w
            elif isinstance(w, BreakWeek):
                # Allow for up to 99 consecutive break weeks,
                # which should be sufficient :). Should probably
                # throw an exception if we exceed that.
                break_num += 0.01
                period[week_num + break_num] = w
        return period

# turn this into a generator?
    def lecture_dates(self):
        dates = {}
        lecture_num = 1
        teaching_weeks = [t for t in self.weeks if isinstance(t, TeachingWeek)]
        for week_index, monday in enumerate(teaching_weeks):
            for offset_index, offset in enumerate(self.lecture_offsets):
                lec = week_index * 2 + offset_index + 1
                if lec in self.skipped_lectures:
                    continue
                dates[lecture_num] = monday + datetime.timedelta(offset)
                lecture_num += 1
        return dates

def render(self, style, fmt):
        if fmt == "text":
            return(self.render_text(style))
        elif fmt == "latex":
            return(self.render_latex(style))
        elif fmt == "xml":
            return(self.render_xml(style))
        else:
            return("")

def render_text(self, style):
        # probably cleaner to create Jinja templates?
        if style == "calendar":
            yield "# Teaching calendar for {period} {year}".format(
                period=self.period, year=self.year)
            for weeknum, monday in self.calendar().items():
                if isinstance(monday, TeachingWeek):
                    yield "Week {week}: {mon} — {fri}".format(
                        week=str(weeknum).rjust(2),
                        mon=monday.isoformat(),
                        fri=monday + datetime.timedelta(days=4))
                elif isinstance(monday, BreakWeek):
                    yield "Break  : {mon} — {fri}".format(
                        mon=monday.isoformat(),
                        fri=monday + datetime.timedelta(days=4))
                else:
                    yield ("")
        elif style == "lecture":
            yield "# Lecture dates for {paper} {period} {year}".format(
                paper=self.paper, period=self.period, year=self.year)
            for lecnum, day in self.lecture_dates().items():
                yield "Lecture {lecture}: {day}".format(
                    lecture=str(lecnum).rjust(2),
                    day=day.isoformat())
        else:
            yield("")

def render_latex(self, style):
        if style == "calendar":
            pass
        elif style == "lecture":
            pass
        else:
            return("")

def render_xml(self, style):
        if style == "calendar":
            pass
        elif style == "lecture":
            pass
        else:
            return("")

import calendar
import datetime

from teachingdates import PROG

from .weeks import BreakWeek, IsoWeek, TeachingWeek

def teaching_date(self, period, week, offset=0):
        pass

def calendar(self):
        period = {}
        week_num = break_num = 0
        for w in self.weeks:
            if isinstance(w, (TeachingWeek, IsoWeek)):
                # Increment first so that break weeks have the
                # same week number as the preceding teaching week.
                # This ensures the keys are always chronologically
                # sorted. Reset the break number for each new
                # teaching week.
                week_num += 1
                break_num = 0
                period[week_num] = w
            elif isinstance(w, BreakWeek):
                # Allow for up to 99 consecutive break weeks,
                # which should be sufficient :). Should probably
                # throw an exception if we exceed that.
                break_num += 0.01
                period[week_num + break_num] = w
        return period

def lecture_dates(self):
        dates = {}
        lecture_num = 1
        teaching_weeks = [t for t in self.weeks if isinstance(t, TeachingWeek)]
        for week_index, monday in enumerate(teaching_weeks):
            for offset_index, offset in enumerate(self.lecture_offsets):
                lec = week_index * 2 + offset_index + 1
                if lec in self.skipped_lectures:
                    continue
                dates[lecture_num] = monday + datetime.timedelta(offset)
                lecture_num += 1
        return dates

Show line notes below