4 Reminders for upcoming important dates.
12 from collections import defaultdict
13 from typing import Dict, List, Optional
15 from pyutils import argparse_utils, bootstrap, config, persistent, string_utils
16 from pyutils.ansi import fg, reset
17 from pyutils.datetimez import dateparse_utils as dateparse
18 from pyutils.files import file_utils
20 logger = logging.getLogger(__name__)
21 cfg = config.add_commandline_args(
22 f"Main ({__file__})", "Reminder of events, birthdays and anniversaries."
25 "--reminder_filename",
26 type=argparse_utils.valid_filename,
29 help="Override the .reminder filepath",
32 '--reminder_cache_file',
34 default=f'{os.environ["HOME"]}/.reminder_cache',
36 help='Override the .reminder cache location',
39 "-n", "--count", type=int, metavar='COUNT', help="How many events to remind about"
45 help="How many days ahead to remind about",
52 help="Also include the date along with the n day countdown",
55 "--override_timestamp",
57 type=argparse_utils.valid_datetime,
58 help="Don't use the current datetime, use this one instead.",
59 metavar="DATE/TIME STRING",
64 # This decorator handles caching this object's state on disk and feeding the
65 # state back to new instances of this object at initialization time. It also
66 # makes sure that this object is a global singleton in the program.
67 @persistent.persistent_autoloaded_singleton()
68 class Reminder(object):
74 self, cached_state: Optional[Dict[datetime.date, List[str]]] = None
76 if not config.config['override_timestamp']:
77 self.today = datetime.date.today()
79 self.today = config.config['override_timestamp'][0].date()
81 'Overriding "now" with %s because of commandline argument.',
84 if cached_state is not None:
85 self.label_by_date = cached_state
87 self.label_by_date: Dict[datetime.date, List[str]] = defaultdict(list)
88 self.read_file(config.config['reminder_filename'])
90 def handle_event_by_adjusting_year_to_now(
93 orig_date: datetime.date,
97 for year in (self.today.year, self.today.year + 1):
100 delta = year - orig_date.year
101 if parsing_mode == Reminder.MODE_BIRTHDAY:
103 label += f" ({delta} year{string_utils.pluralize(delta)} old)"
104 elif parsing_mode == Reminder.MODE_ANNIVERSARY:
106 label += f" ({delta}{string_utils.thify(delta)} anniversary)"
109 month=orig_date.month,
112 logger.debug('Date in %d: %s', year, dt)
113 self.label_by_date[dt].append(label)
114 logger.debug('%s => %s', dt, label)
116 def handle_event_with_fixed_year(
118 orig_date: datetime.date,
121 logger.debug('Fixed date event...')
122 self.label_by_date[orig_date].append(orig_label)
123 logger.debug('%s => %s', orig_date, orig_label)
125 def read_file(self, filename: str) -> None:
126 logger.debug('Reading %s:', filename)
127 date_parser = dateparse.DateParser()
128 parsing_mode = Reminder.MODE_EVENT
129 with open(filename) as f:
130 lines = f.readlines()
133 line = re.sub(r"#.*$", "", line)
134 if re.match(r"^ *$", line) is not None:
136 logger.debug('> %s', line)
139 label, date = line.split("=")
141 print(f"Skipping unparsable line: {line}", file=sys.stderr)
142 logger.error('Skipping malformed line: %s', line)
147 parsing_mode = Reminder.MODE_EVENT
148 logger.debug('--- EVENT MODE ---')
149 elif "birthday" in date:
150 parsing_mode = Reminder.MODE_BIRTHDAY
151 logger.debug('--- BIRTHDAY MODE ---')
152 elif "anniversary" in date:
153 parsing_mode = Reminder.MODE_ANNIVERSARY
154 logger.debug('--- ANNIVERSARY MODE ---')
156 date_parser.parse(date)
157 orig_date = date_parser.get_date()
158 if orig_date is None:
159 print(f"Skipping unparsable date: {line}", file=sys.stderr)
160 logger.error('Skipping line with unparsable date')
162 logger.debug('Original date: %s', orig_date)
164 overt_year = date_parser.saw_overt_year
166 Reminder.MODE_BIRTHDAY,
167 Reminder.MODE_ANNIVERSARY,
168 ) or (parsing_mode == Reminder.MODE_EVENT and not overt_year):
169 self.handle_event_by_adjusting_year_to_now(
170 parsing_mode, orig_date, label, overt_year
173 self.handle_event_with_fixed_year(orig_date, label)
175 except Exception as e:
176 print(f"Skipping unparsable line: {line}", file=sys.stderr)
177 logger.error('Skipping malformed line: %s', line)
181 self, count: Optional[int], days_ahead: Optional[int], say_date: bool
184 if count is not None and days_ahead is not None:
188 for date in sorted(self.label_by_date.keys()):
189 delta = date - self.today
192 if days_ahead is not None:
199 labels = self.label_by_date[date]
203 msg = f"{fg('blaze orange')}{d} days{reset()} until {label}"
205 msg = f"{fg('peach orange')}{d} days{reset()} until {label}"
207 msg = f"{d} days until {label}"
209 msg = f"{fg('outrageous orange')}Tomorrow{reset()} is {label}"
212 msg = f"{fg('red')}Today{reset()} is {label}"
214 msg += f" {fg('battleship gray')}on {date.strftime('%A, %B %-d')}{reset()}"
216 if count is not None:
227 if not config.config['override_timestamp']:
228 now = datetime.datetime.now()
230 now = config.config['override_timestamp'][0]
232 'Overriding "now" with %s because of commandline argument.', now
235 cache_ts = file_utils.get_file_mtime_as_datetime(
236 config.config['reminder_cache_file']
241 # If the cache was already written today...
243 now.day == cache_ts.day
244 and now.month == cache_ts.month
245 and now.year == cache_ts.year
247 reminder_ts = file_utils.get_file_mtime_as_datetime(
248 config.config['reminder_filename']
251 # ...and the .reminder file wasn't updated since the cache write...
252 if reminder_ts <= cache_ts:
255 with open(config.config['reminder_cache_file'], 'rb') as rf:
256 reminder_data = pickle.load(rf)
257 return cls(reminder_data)
263 with open(config.config['reminder_cache_file'], 'wb') as wf:
267 pickle.HIGHEST_PROTOCOL,
271 @bootstrap.initialize
273 reminder = Reminder()
274 count = config.config['count']
275 days_ahead = config.config['days_ahead']
276 reminder.remind(count, days_ahead, config.config['date'])
280 if __name__ == "__main__":