/
timetable_parser.py
331 lines (256 loc) · 16.2 KB
/
timetable_parser.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
import re
import traceback
import urllib.request
from datetime import datetime
from typing import Dict, Tuple, List, Optional
import pytz
import yaml
import kss
import log_util
# Таблица номеров дней недели (0..6) к их названию на русском.
from kristybot import Kristy
from kss import KristyScheduleScript
WEEKDAYS_RU = {
0: 'Понедельник',
1: 'Вторник',
2: 'Среда',
3: 'Четверг',
4: 'Пятница',
5: 'Суббота',
6: 'Воскресенье',
}
TIMETABLE_FILE_EXT = '.yml'
GMT_TIMEZONE_REGEX = r'GMT[+-]\d{1,2}'
CLASS_ORDINALS_TIME_REGEX = r'^(\d{2}\.\d{2})-(\d{2}\.\d{2})$' # HH.mm-HH.mm; выделяет время начала и время конца
# Формат времени проведения пар в файлах с расписаниями.
CLASS_TIME_FMT = '%H.%M'
# Максимальный размер файла с расписанием (пытаемся защищаться от дудосов маминых кулхацкеров).
MAX_TIMETABLE_FILE_LEN_BYTES = 32 * 1024 # 32 KiB
class TimetableData:
# TODO: не хранить ВСЕ расписания в памяти (на далёкое будущее)
def __init__(self, kristy: Kristy):
self.logger = log_util.init_logging(__name__)
self.kristy: Kristy = kristy
self.timezones: Dict[int, datetime.tzinfo] = {}
self.class_ordinals: Dict[int, Dict[Tuple[str, str], int]] = {}
self.classes: Dict[int, Dict[str, List[ClassData]]] = {}
self.named_scripts: Dict[int, Dict[str, KristyScheduleScript]] = {}
self.script_globals: Dict[int, Dict[str, object]] = {}
def load_all(self):
"""
Загружает все файлы с расписаниями по ссылкам из БД, парсит их, проверяет на ошибки и затем
извлекает нужные данные обо всех беседах в память. Если данные уже были загружены, все они будут
загружены заново (т.е. функцию можно вызвать повторно для перезагрузки данных с диска). Если данные
какой-либо беседы не удалось загрузить, то весь функционал, связанный с расписанием, для этой беседы
будет недоступен, а в беседу будет отправлена соответствующее сообщение об ошибке.
См. _load_timetable
"""
self.timezones = {}
self.class_ordinals = {}
self.classes = {}
self.named_scripts = {}
self.script_globals = {}
for chat in self.kristy.db.all_chat_ids():
self.load_timetable(chat, hide_errors=True)
def load_timetable(self, chat: int, hide_errors: bool):
"""
(Пере-)загружает файл с расписанием указанной беседы: получает ссылку на нужный файл
из БД, затем, если эта ссылка есть (не null), пытается скачать по ней текстовый файл,
декодировать его, загрузить как YAML и спарсить. В случае какой-либо ошибки, выведет
информацию об этой ошибке в консоль и в беседу.
:param chat: ID беседы, расписание которой необходимо (пере-)загрузить.
:param hide_errors: Если True, то при обнаружении ошибок в файле расписания указанной беседы
они будут выведены только в консоль. Если False, то о них так же будет
отправлено сообщение в ВК (в эту беседу).
"""
timetable_url = self.kristy.db.get_timetable_url(chat)
if timetable_url:
try:
contents_str = urllib.request \
.urlopen(timetable_url) \
.read(MAX_TIMETABLE_FILE_LEN_BYTES) \
.decode('utf-8')
timetable_yml = yaml.safe_load(contents_str)
self._parse_timetable(chat, timetable_yml)
self.logger.info('Загружен файл с расписанием беседы № %i', chat)
except Exception as e:
self.logger.warning('Не удалось обработать файл с расписанием беседы № %i:', chat)
traceback.print_exc()
if isinstance(e, SyntaxError):
self.logger.warning('%s', e)
if not hide_errors:
self.kristy.send(chat + 2E9,
'⚠ Не удалось загрузить файл с расписанием для '
'этой беседы, поскольку он составлен неверно: ' + str(e))
else:
self.logger.error('Не удалось загрузить файл с расписанием беседы № %s', chat)
traceback.print_exc()
if not hide_errors:
self.kristy.send(chat + 2E9,
'⚠ Не удалось загрузить файл с расписанием для этой беседы '
'из-за непредвиденной ошибки: см. консоль')
# Удаляем данные, которые могли загрузиться для этой беседы до появления ошибки,
# чтобы для этой беседы нельзя было использовать связанный с расписанием функционал.
self._clear_all_data(chat)
else:
self.logger.info('У беседы № %i не указана ссылка на файл с расписанием', chat)
if not hide_errors:
self.kristy.send(chat + 2E9,
'⚠ Файл с расписанием для этой беседы не установлен. '
'Используйте "!расписание ССЫЛКА_НА_ФАЙЛ", чтобы исправить это.')
# Удаляем данные, которые могу быть загружены для этой беседы до этого.
# (Расписание для беседы было отключено, например, через "!расписание отключить".)
self._clear_all_data(chat)
def is_kss_debug_enabled(self, chat: int) -> bool:
return self.script_globals.get(chat, {}).get('__режим_отладки__', False)
def _clear_all_data(self, chat: int):
if chat in self.script_globals:
del self.script_globals[chat]
if chat in self.named_scripts:
del self.named_scripts[chat]
if chat in self.timezones:
del self.timezones[chat]
if chat in self.class_ordinals:
del self.class_ordinals[chat]
if chat in self.classes:
del self.classes[chat]
def _parse_timetable(self, chat: int, yml):
self._parse_script_globals(chat, yml)
self._parse_named_scripts(chat, yml)
self._parse_timezone(chat, yml)
self._parse_class_ordinals(chat, yml)
self._parse_timetables(chat, yml)
def _parse_script_globals(self, chat: int, yml):
self.script_globals[chat] = {}
script_globals = yml.get('Глобальные переменные', None)
if script_globals is None:
return
for var_name in script_globals.keys():
self.script_globals[chat][var_name] = script_globals[var_name]
def _parse_named_scripts(self, chat: int, yml):
self.named_scripts[chat] = {}
named_scripts = yml.get('Именованные сценарии', None)
if named_scripts is None:
return
for script_name in named_scripts.keys():
script = kss.parse(named_scripts[script_name], self.script_globals[chat])
self.named_scripts[chat][script_name] = script
def _parse_timezone(self, chat: int, yml):
try:
tz_str = yml['Часовой пояс']
if not re.fullmatch(GMT_TIMEZONE_REGEX, tz_str):
raise SyntaxError('некорректно указан часовой пояс: "%s"; '
'формат: "GMT+H" или "GMT-H" (H ≤ 12) (например, "GMT+3" для Москвы)'
% tz_str)
# Заменяем (например) "GMT+2" на "GMT-2". Это нужно, т.к. в pytz перепутаны коды
# часовых поясов - там, где должен быть "+", в библиотеке стоит "-", и наоборот.
if '+' in tz_str:
tz_str = tz_str.replace('+', '-')
else:
tz_str = tz_str.replace('-', '+')
try:
self.timezones[chat] = pytz.timezone('Etc/' + tz_str)
except pytz.UnknownTimeZoneError:
raise SyntaxError('указан неизвестный часовой пояс (вы точно с этой планеты?); '
'формат: "GMT+H" или "GMT-H" (H ≤ 12) (например, "GMT+3" для Москвы)')
except KeyError:
raise SyntaxError('отсутствует обязательное поле "Часовой пояс"')
def _parse_class_ordinals(self, chat: int, yml):
self.class_ordinals[chat] = {}
try:
ordinals = yml['Нумерация']
except KeyError:
raise SyntaxError('отсутствует обязательный раздел "Нумерация"')
if len(ordinals) == 0:
raise SyntaxError('раздел "Нумерация" не может быть пустым')
ordinal = 0
for time_str in ordinals:
ordinal += 1
time_groups = re.search(CLASS_ORDINALS_TIME_REGEX, time_str)
if time_groups is None:
raise SyntaxError(
'некорректно указано время проведения пары в нумерации: "%s" — формат: "ЧЧ.мм-ЧЧ.мм"; '
'обратите внимание, что задавать время как "8.00" недопустимо — нужно писать "08.00"'
% time_str)
start_tstr = time_groups.group(1)
end_tstr = time_groups.group(2)
tz = self.timezones[chat]
now = datetime.now(tz)
dt = tz.localize(now.combine(now.date(),
datetime.strptime(start_tstr, CLASS_TIME_FMT).time()))
for _start_tstr, _end_tstr in self.class_ordinals[chat].keys():
_ordinal = self.class_ordinals[chat][(_start_tstr, _end_tstr)]
_dt = tz.localize(now.combine(now.date(),
datetime.strptime(_start_tstr, CLASS_TIME_FMT).time()))
if dt < _dt:
raise SyntaxError('пара "%s-%s" начинается раньше, чем "%s-%s", '
'однако её порядковый номер выше (%s против %s)'
% (start_tstr, end_tstr, _start_tstr, _end_tstr, ordinal, _ordinal))
self.class_ordinals[chat][(start_tstr, end_tstr)] = ordinal
def _parse_timetables(self, chat: int, yml):
self.classes[chat] = {}
for weekday in WEEKDAYS_RU.values():
self.classes[chat][weekday] = []
for section in yml.keys():
if section in WEEKDAYS_RU.values():
self._parse_classes(chat, yml, section)
def _parse_classes(self, chat: int, yml, weekday: str):
for time_str in yml[weekday].keys():
time_groups = re.search(CLASS_ORDINALS_TIME_REGEX, time_str)
if time_groups is None:
raise SyntaxError('некорректно указано время проведения пары в день %s: "%s" — формат: "ЧЧ.мм-ЧЧ.мм"; '
'обратите внимание, что задавать время как "8.00" недопустимо — нужно писать "08.00"'
% (weekday, time_str))
start_tstr = time_groups.group(1)
end_tstr = time_groups.group(2)
if (start_tstr, end_tstr) not in self.class_ordinals[chat]:
raise SyntaxError('некорректно указано время проведения пары в день %s: "%s" — '
'такого временного промежутка нет в разделе "Нумерация"'
% (weekday, time_str))
for class_name in yml[weekday][time_str].keys():
class_data = yml[weekday][time_str][class_name]
try:
host = class_data['Преподаватель']
except KeyError:
raise SyntaxError('для пары "%s", проходящей в %s в день %s, '
'отсутствует обязательное поле "Преподаватель"'
% (class_name, time_str, weekday))
try:
aud = class_data['Аудитория']
except KeyError:
raise SyntaxError('для пары "%s", проходящей в %s в день %s, '
'отсутствует обязательное поле "Аудитория"'
% (class_name, time_str, weekday))
scripts_strings = class_data.get('Сценарии', [])
script_globals = self.script_globals[chat]
scripts = [kss.parse(script_string, script_globals) for script_string in scripts_strings]
week = class_data.get('Неделя', None)
if week is not None:
week = week.strip().lower()
target_groups = class_data.get('Группы', None)
if target_groups is not None and type(target_groups) == str:
# Преобразуем поля вида "Группы: единственная_группа" в список
# с единственным элементом (чтобы в дальнейшем было удобнее работать).
target_groups = [target_groups]
self.classes[chat][weekday].append(ClassData(
start_tstr, end_tstr, class_name, host, aud, week, scripts, target_groups))
class ClassData:
def __init__(self,
start_tstr: str,
end_tstr: str,
name: str,
host: str,
aud: str,
week: Optional[str],
scripts: List[KristyScheduleScript],
target_groups: Optional[List[str]]):
self.start_tstr: str = start_tstr
self.end_tstr: str = end_tstr
self.name: str = name
self.host: str = host
self.aud: str = aud
self.week: Optional[str] = week
self.scripts: List[KristyScheduleScript] = scripts
self.target_groups: Optional[List[str]] = target_groups
def __str__(self):
return '%s (%s) в %s в ауд. %s' % (self.name, self.host, self.start_tstr, self.aud)