Pull the parts of m.m.reminders.AnnouncementConf shared with m.m.events into a new m.u.eventutil.CalendarConf (replacing m.u.eventutil.get_group_conf).

Author: nmlorg

metabot/modules/events.py

@@ -33,27 +33,27 @@ def moddispatch(ctx, msg, modconf):  # pylint: disable=missing-docstring
 def group(ctx, msg):
     """Handle /events in a group chat."""
 
-    group_id = '%s' % ctx.chat['id']
-    groupconf = ctx.bot.config['issue37']['moderator'][group_id]
-    calcodes, tzinfo, count, days, unused_hour, unused_dow = eventutil.get_group_conf(groupconf)
-    if not calcodes or not tzinfo:
+    group_id = f"{ctx.chat['id']}"
+    calconf = eventutil.CalendarConf(ctx.bot.config['issue37']['moderator'][group_id])
+    if not calconf.calcodes or not calconf.tzinfo:
         missing = []
-        if not calcodes:
+        if not calconf.calcodes:
             missing.append('choose one or more calendars')
-        if not tzinfo:
+        if not calconf.tzinfo:
             missing.append('set the time zone')
         return msg.add(
             "I'm not configured for this group! Ask a bot admin to go into the <b>moderator</b> "
             'module settings, group <b>%s</b>, and %s.', group_id, humanize.list(missing))
 
-    events, unused_alerts = eventutil.get_group_events(ctx.bot, calcodes, tzinfo, count, days)
+    events, unused_alerts = eventutil.get_group_events(ctx.bot, calconf.calcodes, calconf.tzinfo,
+                                                       calconf.count, calconf.days)
     if not events:
-        msg.add('No events in the next %s days!', days)
+        msg.add('No events in the next %s days!', calconf.days)
     else:
         url = eventutil.get_image(events[0], ctx.bot.config)
         if url:
             msg.add('photo:' + url)
-        msg.add(eventutil.format_events(ctx.bot, events, tzinfo))
+        msg.add(eventutil.format_events(ctx.bot, events, calconf.tzinfo))
 
 
 def private(ctx, msg, modconf):  # pylint: disable=too-many-branches,too-many-locals

metabot/modules/reminders.py

@@ -56,23 +56,29 @@ def periodic():
 class AnnouncementConf:  # pylint: disable=too-few-public-methods
     """A group's announcement configuration."""
 
-    def __init__(self, groupconf):
-        (self.calcodes, self.tzinfo, self.count, self.days, self.hour,
-         self.dow) = eventutil.get_group_conf(groupconf)
-        self.preambles = groupconf['daily'].get('text', '').splitlines()
+    def __init__(self, calconf, dailyconf):
+        self.calconf = calconf
+        self.dow = dailyconf.get('dow', 0)
+        self.hour = dailyconf.get('hour')
+        self.preambles = dailyconf.get('text', '').splitlines()
 
     def get_events(self, bot, eventtime, base, *, countdown=True):
         """Get (and format) events for the given time."""
 
-        events, alerts = eventutil.get_group_events(bot, self.calcodes, self.tzinfo, self.count,
-                                                    self.days, eventtime)
+        calconf = self.calconf
+        events, alerts = eventutil.get_group_events(bot, calconf.calcodes, calconf.tzinfo,
+                                                    calconf.count, calconf.days, eventtime)
         if self.preambles:
             preamble = self.preambles[int(eventtime / (60 * 60 * 24)) % len(self.preambles)]
         else:
             preamble = ''
         text = _generate_preamble(preamble, events)
         if events:
-            ev = eventutil.format_events(bot, events, self.tzinfo, base=base, countdown=countdown)
+            ev = eventutil.format_events(bot,
+                                         events,
+                                         calconf.tzinfo,
+                                         base=base,
+                                         countdown=countdown)
             text = f'{text}\n\n{ev}'
         return events, alerts, text
 
@@ -81,20 +87,21 @@ class Announcement(collections.namedtuple('Announcement', 'time events message t
     """The most recent announcement."""
 
 
-def _daily_messages(multibot, records):  # pylint: disable=too-many-branches,too-many-locals
+def _daily_messages(multibot, records):  # pylint: disable=too-many-branches,too-many-locals,too-many-statements
     now = time.time()
     # If running at 11:22:33.444, act as if we're running at exactly 11:20:00.000.
     period = int(now // PERIOD * PERIOD)
     startofhour = now // 3600
 
     for botuser, botconf in multibot.conf['bots'].items():  # pylint: disable=too-many-nested-blocks
         for groupid, groupconf in botconf['issue37']['moderator'].items():
-            annconf = AnnouncementConf(groupconf)
-            if not annconf.tzinfo or not isinstance(annconf.hour, int):
+            calconf = eventutil.CalendarConf(groupconf)
+            annconf = AnnouncementConf(calconf, groupconf['daily'])
+            if not calconf.tzinfo or not isinstance(annconf.hour, int):
                 continue
 
-            nowdt = datetime.datetime.fromtimestamp(now, annconf.tzinfo)
-            perioddt = datetime.datetime.fromtimestamp(period, annconf.tzinfo)
+            nowdt = datetime.datetime.fromtimestamp(now, calconf.tzinfo)
+            perioddt = datetime.datetime.fromtimestamp(period, calconf.tzinfo)
             key = (botuser, groupid)
             if key in records:
                 last = Announcement(*records[key])
@@ -123,7 +130,7 @@ def _daily_messages(multibot, records):  # pylint: disable=too-many-branches,too
             if last:
                 events, alerts, text = annconf.get_events(bot, last.time, perioddt)
                 _handle_alerts(bot, records, groupid, alerts)
-                edits = diff_events(multibot, annconf.tzinfo, perioddt, last.events, events)
+                edits = diff_events(multibot, calconf.tzinfo, perioddt, last.events, events)
 
                 suffix = last.suffix
                 if edits:

metabot/util/eventutil.py

@@ -19,14 +19,15 @@
 }
 
 
-def get_group_conf(groupconf):
-    """Pull calendar configuration from a raw group conf."""
-
-    timezone = groupconf.get('timezone')
-    tzinfo = timezone and pytz.timezone(timezone)
-    return (groupconf.get('calendars', '').split(), tzinfo, groupconf.get('maxeventscount', 10),
-            groupconf.get('maxeventsdays',
-                          6), groupconf['daily'].get('hour'), groupconf['daily'].get('dow', 0))
+class CalendarConf:  # pylint: disable=too-few-public-methods
+    """A group's calendar configuration."""
+
+    def __init__(self, groupconf):
+        self.calcodes = groupconf.get('calendars', '').split()
+        self.count = groupconf.get('maxeventscount', 10)
+        self.days = groupconf.get('maxeventsdays', 6)
+        timezone = groupconf.get('timezone')
+        self.tzinfo = timezone and pytz.timezone(timezone)
 
 
 def get_group_events(bot, calcodes, tzinfo, count, days, now=None):  # pylint: disable=too-many-arguments,too-many-locals