changelog.rst 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916
  1. =========
  2. Changelog
  3. =========
  4. Данный файл содержит историю всех внесённых изменений в проекте.
  5. v5.8 (20.02.2024)
  6. =================
  7. У проекта появилась документация.
  8. Потому были переписаны все докстроки ядра проекта.
  9. Обновление по большей части касается внутренней части кода.
  10. - Общие улучшения качества кода (по линтеру).
  11. - Сортировка импортов.
  12. - Изменены некоторые названия переменных для большей наглядности.
  13. Utils
  14. -----
  15. - Обновлена типизация функций.
  16. - Добавлены подробные комментарии к коду.
  17. - `check_keys()` помечана как устаревшая и будет вскоре удалена.
  18. - Используется типизация до python 3.10.
  19. - `get_str_timedelta()` Принимает только целые чилса.
  20. - Функция `ensure_list` перемещена в `sp.utils`.
  21. Messages
  22. --------
  23. - Испрпвлена типизация функций.
  24. - Не отображает увдеомления пользователей в статусе, если они они не включены.
  25. - Некоторая правка расписания звонков.
  26. - Пустые уроки не будут отображаться в расписании.
  27. Parser
  28. ------
  29. - Переменные для хранения путей к файлам используют Path.
  30. - `_get_day_hash()` стала приватной функцией.
  31. - `_clear_day_lessons()` улучшена производительность.
  32. - Даны более понятные имена некоторые переменным.
  33. - Использование `DefaultDict` для упрощения кода.
  34. - `parse_lessons()` Использование генераторов для оптимизации.
  35. - Возможность передать свои пути к файлам в классе `Schedule`.
  36. - Улучшена типизиация функций. Принимаемые и возвращаемые типы
  37. стали более подробными.
  38. - Добавлены методы для сборки намерений для текущего расписания.
  39. vk v1.2 (16.01.2023)
  40. ====================
  41. Обновление и синхронизация функций из Telegram бота в Вк версию.
  42. - Использование намерений из `sp v5.5`.
  43. - Поправлен текст некоторых кнопок.
  44. - Некоторым кнопка присвоены emoji.
  45. - Немного поправлены комментарии функций.
  46. - Совмещены обработчики просмотра списка изменений в расписании.
  47. - Доабвлена подсказка с доступными классами при выборе класса.
  48. - Подготовка к удалению сторого главного сообещния.
  49. - перенесены тексты сообщений из Telegram бота.
  50. - Список преиммуществ указанного класса.
  51. - Функция сборки сообщения списка изменений.
  52. - Добавлен режим просмотра *Ничего* в клавиатуре счётчиках.
  53. - Портирована многостраничная справка по написанию запросов к боту.
  54. - Клавиатура была упрощена, чтобы показывать только содержание.
  55. - Текст справки адаптирован под вк бота.
  56. - Удалены разделы про групповые чаты и поздравление с прохождением.
  57. - Клавиатура счётчиков использует цвета, для большей наглядности.
  58. tg v2.2 (10.01.2024)
  59. ====================
  60. Это масштабное обновление Telegram версии бота.
  61. Посвящено оно частичному реешнию проблемы передачи намерений в боте.
  62. Реализация намерений в боте не завершена и будет обновляться.
  63. .. note:: Система намерений
  64. Полноценная передача и использование намерений в чат-ботах является
  65. одном из главных ограничений, в отличие от консольной обёртки.
  66. Система намерений позволяет более точно получать результаты для счётчиков
  67. и списка изменений.
  68. Реализации системы намерений в Telegram хоть и не обязательна
  69. для большинства пользователей, однако она открывает новые возможности
  70. при получении более точных статистических данных.
  71. TL;DR
  72. -----
  73. - Множество исправлений.
  74. - Добавлен редактор намерений.
  75. - Добавление/изменение/удаление намерений.
  76. - Использование клавиатуры выбора намерений в счётчиках и списке изменений.
  77. Features
  78. --------
  79. - Начат постепенный переход на использование баз данных как хранилище.
  80. - Использование базы данных sqlite3 в `sp_data/tg.db`.
  81. - Удалены `_HOME_BUTTON` и `_TO_HOME_MARKUP`, не используются.
  82. - Добавлены некоторые новые комментарии к коду.
  83. - В `user_middleware` теперь также передаётся экземпляр `UserIntents`.
  84. - Немного изменён стиль логгера (`log_middleware`).
  85. - Немного поправлено главное сообщение бота.
  86. - Исправлена типизация некоторых функций.
  87. - Обновлены тексты коментариев.
  88. - Добавлен раздел **намерения** в дополнительную клавиатуру.
  89. - `get_notify_keyboard()`: Больше не требует экземпляр `SPMessages`.
  90. - `get_updates_keyboard()`: Собирает дополнительную клавиатуру выбора намерений.
  91. - `get_counter_keyboard()`: Собирает дополнительную клавиатуру выбора намерений.
  92. - Вспомогательная функиця `get_intent_status()`.
  93. - Упрощена функция `get_update_timetag()`.
  94. - Немного упрощён текст сообщения статуса.
  95. - `get_notify_message()`: Принимает теперь `enabled` и `hours` вместо экзмпляра `SPMessages`.
  96. - Исправлна таблица в динамическом сообщении счётчиков.
  97. - Использование динамического сообщения списка изменений в обработчике `/updates`.
  98. UserIntents
  99. -----------
  100. Это новый вспомогательный класс, являющийся обёртной над базой данных
  101. для предоставления хранилища пользовательским намерениям.
  102. Класс предосталвяет методы для сохранения, получения, изменения намерений
  103. для конкретного пользователя расписания.
  104. Методы класса:
  105. - `get()`: Получить список намерений пользователя.
  106. - `get_intent(name)`: Получить намерение пользователя по имени.
  107. - `remove_all()`: Удалить все намерения.
  108. - `add(name, i)`: Добавить/обновить намерение.
  109. - `rename(old_name, new_namw)`: Переименовать намерение.
  110. - `remove(name)`: Удалить намерение.
  111. Messages
  112. --------
  113. Новые статические и динамические сообщения в боте.
  114. Статические:
  115. - Информация о намерениях.
  116. - Установка имени намерения.
  117. - Указание параметров намерения.
  118. - Режим удаления намерений.
  119. - Достижение предела количества намерений.
  120. Динамические:
  121. - Сообщение списка изменений.
  122. - Информация о намерении.
  123. - Списка намерений.
  124. Keyboards
  125. ---------
  126. Новые функции для динамической сборки клавиатур бота.
  127. - Редактор списка намерений.
  128. - Редактор намерения.
  129. - Клавиатура удаления намерений.
  130. Handlers
  131. --------
  132. - Команды `/cancel` => Сброс машины состояний.
  133. - Команда `/intents`, кнопка `intents` => раздел редактора намерений.
  134. - Команда `/add_intent`, кнопка `intent:add` => Добавить новое намерение.
  135. - Состояние `EditIntentStates.name` => Выбор имени намерения.
  136. - Состояние `EditIntentStates.parse` => Выбор параметров намерения.
  137. - Кнопка `intent:show:{name}` => Режим редактирования намерения.
  138. - Кнопка `intent:remove:{name}` => Удалить намерение пользователя.
  139. - Кнопка `intent:reparse:{name}` => Изменение параметров нвмерения.
  140. - Команда `/remove_intents`, кнопка `intents:remove_mode` => Удаления намерений.
  141. - Кнопка `intent:remove_many:{name}` => Удалить множественно намерение.
  142. - Кнопка `intents:remove_all` => Удалить все намерения.
  143. v5.3.8 -> v5.7 (27.12.2023)
  144. ===========================
  145. Как вы возможно уже знаете, в проекет до сих пор как путаница версий
  146. так и не совсем ясный список изменений, который плохо отображает
  147. какие изменений к какой версии компонента относятся.
  148. чтобы решеть эту проблему, тут будет описаны все изменения в парсере,
  149. начиная с версии `5.3.8` и заканчивая последней версией `5.7`.
  150. v5.3.8
  151. ------
  152. Улучшено сообщение статуса.
  153. - Изменён стиль сообщения.
  154. - Улучшено отображение времени последнего обновления и проверки.
  155. - Добавлен таймер до следующей проверки расписания.
  156. - Добавлен счётчик количества пользователей по классам.
  157. v5.4
  158. ----
  159. - Удалены устаревшие `search_lesson`, `search_cabinet`.
  160. - Сам файл `spm` переименован в `messages`.`
  161. - Использоваие `DefaultDict` для функций счётчиков.
  162. v5.5
  163. ----
  164. На замену класса фильтров добавлен новый класс намерений (intents).
  165. В своей основе он использует именованный кортеж, вместе датакласса.
  166. Вме методы для сборки и пересборки намерения находятся в этом же классе.
  167. - Предоставляет методы для сборки: `construct()`, `parse()`.
  168. - Предоставляет методы дополнения: `reconstruct()`, `reparse()`.
  169. - Поддерживает все старые фкнкции фильтров.
  170. - Добавлён счётчик активных пользователей в сообщение статуса.
  171. v5.7
  172. ----
  173. Изменён формат хранения списка изменений.
  174. теперь в нем сохраняются время начала и конца временного промежутка,
  175. в котором были зафиксированы изменения в расписании.
  176. Это позволило создать функцию для совмещения нескольких записей об
  177. изменении в одну.
  178. - `SpMessages`: Возможность передать данные пользователя напрямую.
  179. - Попытка исправить получение "пустых" уроков.
  180. - Обновлён формат списка изменений.
  181. - Новый заголовок списка изменений.
  182. Вместо примерного времени изменения теперь показывает
  183. временной промежует, внутри которого были зафиксированы изменения.
  184. Начало временного промежутка обновления.
  185. Конец временного промежутка обновления.
  186. Сколько продлился временной промежуток.
  187. Как давно были зафиксированы прошлые изменений.
  188. - `Intents`: Исправлено получения расписания вне недели.
  189. - Добавлена функция упаковки списка изменений в расписании.
  190. - Пользователю отправляются упакованные изменения в расписании.
  191. tg v2.1 (24.12.2023)
  192. ====================
  193. Это дебют локального многостраничего обучения по написанию запросов.
  194. Она поясняет основные концепции написания запросов.
  195. Что такое классы, уроки, кабинеты, как искать что-то в расписании.
  196. - `/typehint` -> `/tutorial` Новоя команда.
  197. - `restrictions` -> `cl_features`.
  198. - Вместо списка ограничений отсутствия класса теперь список преимуществ.
  199. - Объединение главного сообщения и отсутствия класса.
  200. - Новое сообщение при смене класса.
  201. - Новое сообщение с преимуществами указания класса.
  202. - Новое многостраничное обучение запросам.
  203. - Клавиатура для постраничного просмотра обучения.
  204. - `get_home_message()` принимает класс вместо экземпляра.
  205. - Бот удаляет некоторые команды пользователя для чистки чата.
  206. tg v2.0 (13.12.2023)
  207. ====================
  208. Смена мажорной версии обусловлена полным изменением кода бота.
  209. Бот был полностью переписан с использованием `aiogram v3.2`,
  210. с учётом всех новых особенностей.
  211. Новый код бота стал более понятным и читаемым.
  212. Общая чистка кода, а также подготовка к разделению бота на несколько файлов.
  213. Telegram v1.14
  214. --------------
  215. Обновления, до того как код был переписан на `aiogram v3.2`.
  216. - Замена фильтров на намерения (Intents).
  217. - Использование переменных окружения вместо JSON файла `telegram.json`.
  218. - Обновлены тексты сообщений.
  219. - Добавлены вспомогательные кнопки при смене класса. (отвязать, ограничения)
  220. - При выборе класса отправляется список доступных классов.
  221. - Добавлено сообщения с подсказками как писать запросы к расписанию.
  222. - Исправлены текстовые ошибки.
  223. Telegram v2.0
  224. -------------
  225. - Обновлено до `sp v5.7`.
  226. - Полностью переписанный и оптимизированный код бота.
  227. - Обновлённые функции получения клавиатур бота.
  228. - Новая дполнительная клавиатура.
  229. - Возможнгсть отключать расслыку в указанынй час.
  230. - Повышено качество кода.
  231. - Переписана обработка `callback_querry`.
  232. - Использование CallbackData factory для обработки кнопок.
  233. - В статусном сообщении указывается время автоматической проверки.
  234. - Добавлена `LogMiddleware` для отладки запросов к боту.
  235. - Больше нет возможности передавать аргументы в команду (будет решено).
  236. - Больше нет возможности использовать бота в групповых чатах (будет решено).
  237. vk v1.1 (10.7.2023, sp v5.3.8)
  238. ==============================
  239. Внутренние улучшенияе бота.
  240. Schedule
  241. --------
  242. - Попытка исправить двойное отправление списка изменений при обновлении бота.
  243. Messages
  244. --------
  245. - Поправка в типизации функции `send_search_res()`.
  246. - Возможность отвязать пользователя от класса в методе `set_class()`.
  247. Vk
  248. --
  249. - `process_request`: Всегда возращает строковый результат запроса.
  250. - `process_request`: Напрямую использует метод поиска `Schedule.search()`.
  251. - Исправлены тексты комментариев.
  252. - Используется метод `set_class()` для отвязки класса.
  253. - Объединены оброаботчики для включения и отключения оповещений в указаный час.
  254. - Запросы к расписанию обрабатываются только в личных сообщениях.
  255. - Исправлены тексты сообщений.
  256. - Дополнительный вариант справки при отвязанном классе.
  257. - В справке больше не отображается выбранный пользователм класс.
  258. vk v1.0 (03.7.2023, sp v5.3.6)
  259. ==============================
  260. .. note:: Нормализация версий.
  261. Начиная с этого обновления, версионирование проекта приходит в норму.
  262. Это первая сборка ВК версии бота на основе последней версии `SPMessage`.
  263. Кодовая база портирована с последней сборки `Telegram v1.13.4`.
  264. Для ВК бота используется фреймворк `vkbottle`.
  265. v5.3 (05.4.2023, tg v1.12)
  266. ==========================
  267. Первое появление автоматического скрипта для проверки изменений в рпсписании
  268. и автоматической рассылке расписания пользователям.
  269. Schedule
  270. --------
  271. - Период обновлений сокращён на пол часа.
  272. - Исправлена отправка одинакового списка измений дважды.
  273. Messages
  274. --------
  275. - В параметры пользоватля добалвены настройки уведомлений.
  276. - Новый стиль статуса проекта.
  277. Telegram
  278. --------
  279. Обновление бота `v1.12` до `sp v5.3`.
  280. - Подготовка бота для работы в груповых чатах.
  281. - Добавлена клавиатура для настройки уведмлений.
  282. - `callback_handler()`: Исправлено получени расписания на неделю.
  283. - `callback_handler()`: Обработка исключения `MessageNotModified`.
  284. - `start_command()`: Обработка исключения `MessageCantBeDeleted`.
  285. - Возможность прямо сменить класс в команде `/set_class [класс]`.
  286. - Обновлены описания аргументов в справке для большей ясности.
  287. - Обновлено сообщение со способами смены класса.
  288. - Возможность обрабатывать текстовые команды командой `/sc`.
  289. v5.2 (05.04.2023)
  290. =================
  291. Counters
  292. --------
  293. Полностью новые функии для подсчёта элементов в расписании.
  294. Все функции используют класс фильтров для уточнения результатов подсчётов.
  295. Filters
  296. -------
  297. - Символ "?" используется для автоподстановки вашего класса по умолчанию.
  298. Utils
  299. -----
  300. - Функцуия автоматического дополнения ключей словаря пользователя.
  301. - Используется модуль `ujson` вместо стандартного `josn`.
  302. Telegram
  303. --------
  304. - Обновлен до `sp v5.2`.
  305. - Новая клавиатура для счётчиков.
  306. - `callback_handler()`: Предупреждение в логгировании о неизвестных данных.
  307. - Обновлён текст главноего сообщения.
  308. - Обновлён текст при смене класс, как в дальнейшем можно сменить класс.
  309. - "Инструменты" переименованы в "ещё".
  310. - Добавлено пасхальное сообщение если некорректоно выбран класс.
  311. - Команда `/restrictions` со списком ограничений при отвязанном классе.
  312. - inline кнопка для смены класса теперь использует `SPMessages.reset_user()`.
  313. v5.1 (31.3.2023)
  314. ================
  315. Filters
  316. -------
  317. - Используются датаклассы для хранения фильтров.
  318. Messages
  319. --------
  320. - Исправлено отображение номеров уроков в списке изменений.
  321. - Исправлено отображение пустых результатов поиска.
  322. - Исправлено отображения расписания для внеурочного времени.
  323. - Исправлена отправка результатов поиска.
  324. - Исправлено получение расписания на воскресение.
  325. Telegram
  326. --------
  327. - Отправка пушей об исключениях через `gotify`.
  328. v5.0 (27.3.2023, tg v1.8)
  329. =========================
  330. Общее улучшение качества кода.
  331. Смена мажорной версии обусловлена разделением огромного файла `sp.py`
  332. на множество маленьких файлов с классами.
  333. Таких как `parser.py`, `messages.py` и прочее.
  334. Цикл обновлений с целью полной переработкой проекта завершён.
  335. Schedule
  336. --------
  337. - `_uppdate_diff_file()`: теперь использует `collections.deque`.
  338. - Вернулся метод `search()`: для общего поиска данных в расписании.
  339. - Улучшено обращение с пользователями, не указавшими класс.
  340. - Метод `get_updates()` для более гибкого получения списка обновлений
  341. с использованием фильтров для уточнения результатов.
  342. Messages
  343. --------
  344. - `set_class()` больше не возвращает результат работы.
  345. - Метод `reset_user()` сбрасывает данных пользователя.
  346. - Изменён стиль списка измененений в расписании.
  347. - Совмещены методы `search_lesson()` и `search_cabinet()`.
  348. - `send_day_lessons()`: Сильно изменён формат отображения уроков.
  349. - `send_lessons()`: При изменении расписания отображает сам список изменений.
  350. - Изменён формат отображения уроков.
  351. - Удалён метод `send_users_stats()`.
  352. - `send_today_lessons()`: Снвоа автоматически отправляет расписание на сегодня
  353. или завтра, в зависимости, закончились ли уроки.
  354. Telegram
  355. --------
  356. - Обновления бота до `v1.8`.
  357. - Совмещены команды `/start` и `/help`.
  358. - Вернулись наименовая для кнопок в справке.
  359. - В главном сообщении отмечается выбранный пользователем класс.
  360. - Добалена возможность отвзять пользователя от класса.
  361. - Изменены тексты сообщений для большей их ясности.
  362. - Исправлено получение расписния по команде `/sp`.
  363. - Удалена команда `/users`.
  364. v4.6 (15.3.2023)
  365. ================
  366. Добавлен новый класс `Filter`, который предоставляет набор иснструментов
  367. для более точного получения результатов расписания и будет
  368. использоваться в большинстве функци бота.
  369. - `send_update()`: Вынесена как отдельная функция.
  370. - `send_day_lessons()`: Вынесена как отдельная функция.
  371. Schedule
  372. --------
  373. - Убрана возможность переопределить пути хранения файлов.
  374. - Как обязательный аргумент принимает класс.
  375. - Удалён метод `search()` за ненадобностью.
  376. - Из `SPMeaasges` перенесены `get_class()` и `get_lessons()`.
  377. Messages
  378. --------
  379. - Убрана возможность переопределить пути хранения файлов.
  380. - Больше не требует класс `Schedule` как аргумент.
  381. - `send_users_stats()`: Отправляет статистику о пользователях.
  382. - Малость изменены тексты сообщений.
  383. - `send_lessons()`: Переведён на использлвание `Filters`.
  384. - `send_today_lessons()`: Переведён на использлвание `Filters`.
  385. - `send_today_lessons()`: Переведено на статическое смещение дней.
  386. - `count_lessons()`: Испралвена совместимость со старыми версиями Python.
  387. - Переведено на использование `Filters`.
  388. - Изменение стиля сообщения.
  389. - `search_cabinet()`: Переведено на использование `Filters`.
  390. - Изменение стиля сообщения.
  391. Telegram
  392. --------
  393. - Обновлено до `sp v4.6`.
  394. - Изменены сообщения бота.
  395. - `updates_command()`: Исправлено получение обновлений.
  396. - `users_command()`: Добавлена команда для отправки статистики пользователей.
  397. v4.5 (12.3.2023)
  398. ================
  399. - `get_index()`: Оптимизация функции и формата индексов.
  400. - `_update_index_file()`: Немного изменён формат хранения индексов.
  401. - `count_lessons()`: Использование `collections.Counter()`.
  402. - Незначительные правки в аргументах методов
  403. v4.4 (12.3.2023)
  404. ================
  405. - `clear_day_lessons()`: Маленькая функция для очистки списка уроков.
  406. - `parse_lessons()`: Была вынесена как отдельная функция.
  407. - Немного оптимизирован код.
  408. - Вырезан подсчёт хешей для каждого списка уроков.
  409. - `group_update()`: Была удалена, т.к. не используется.
  410. v4.3 (10.3.2023)
  411. ================
  412. Начало цикла обновлений с целью полной переработки парсера.
  413. Schedule
  414. --------
  415. - Полное изменение формата списка изменений.
  416. - Функция `get_day_hash()` для получения хеша списка уроков на день.
  417. - Функция `send_cl_updates()` для отправвки изменений "для класса".
  418. - Атрибут `updates` для получение полного списка изменений расписания.
  419. Messages
  420. --------
  421. - Вместо `send_update_page() -> send_update()`.
  422. Telegram
  423. --------
  424. - Изменён формат `callback_data` для inline клавиатуры.
  425. - Добавлены описания некоторым функциям.
  426. - Временно убрана возможность получение списка изменений для класса.
  427. - В справке примеры были перемещены в начало сообщения.
  428. v4.2 (5.3.2023)
  429. ===============
  430. Само обновление вышло намного-намного раньше, но попало сюда только сейчас.
  431. Зато, можно считать его обкатанным и готовым к выпуску.
  432. Переписана большая часть кода.
  433. Оптимизация, новые фишечки, упрощение чтения самого кода!
  434. Смена мажорной версии обусловлена значительными несовместимыми изменениями
  435. в проекте.
  436. Schedule
  437. --------
  438. - Класс стал независимым от пользователей и переимеован в `Schedule`.
  439. - Весь код стал наполнился подсказками типов.
  440. - Вместо `os.path.exists` испльзуется `Pathlib`.
  441. - Для ведения логгирования теперль используется модуль `loguru`.
  442. - Данные проекта теперь будут сохранятся в директорию `sp_data` вместо корня.
  443. - `save_file()`: Добавлено автоматическое создание родительских директорий.
  444. - Полностью изменён формат хранения расписания -> лучше читаемость.
  445. - Изменён формат файла списка изменений.
  446. - Единая функция для получения `l_index, c_index` -> `get_index()`.
  447. - Индексы теперь обновляются вместе с расписанием, а не каждый раз.
  448. - Парсер теперь сам определяет начало нового дня и сколько уроков.
  449. - Обновление расписания перенесено из `get_schedule()` в `_process_update()`.
  450. - `_process_update()`: Добавлен обработчик исключений при неудачной загрузке.
  451. - `_process_update()`: Расписание обновляется теперь точно через 3600 секунд.
  452. - Метод `get_schedule() -> get()`.
  453. Messages
  454. --------
  455. - `send_status()`: Новый стиль сообщения статуса.
  456. - `send_status()`: Добавлено перечисление всех доступных классов.
  457. - Для просмотра изменений используется новые методы
  458. `get_updates_pages()` и `send_updates_page()`.
  459. - Вновь изменились стили сообщений: `{урок}:{кабинет}`.
  460. - Единая функция для подсчёта уроков/кабинетов `count_lessons()`.
  461. - `count_lessons()`: Отметка кабиентов/уроков, которые используются единожды.
  462. - `search_cabinet()`: Просмотр расписания от имена кабинета.
  463. v3.2 (21.12.2022)
  464. =================
  465. Поправлен метод подсчёта кабинетов в расписании.
  466. Также обёртки были обновлены до последней версии парсера.
  467. Parser
  468. ------
  469. - Некоторые методы и атрибуты помечены приватными для логичности.
  470. - Индексы уроков и кабинетов теперь используют декоратор `@property`.
  471. Messages
  472. --------
  473. - Исправлен метод подсчёта кабинетов в расписании.
  474. Chio Plugins
  475. ------------
  476. - Добавлена команда для подсчёта кабинетов.
  477. v3.1.1 (12.12.2022)
  478. ===================
  479. В парсере изменены обращение с пустыми значениями.
  480. v3.1 (6.12.2022)
  481. ================
  482. Небольшой общмй рефакторинг проекта.
  483. Смена мажорной версии обусловлена отделением класса генератора сообщений
  484. от класса расписания.
  485. Features
  486. --------
  487. - Просмотр самых частых кабинетов.
  488. - Поиск по урокам/кабинетам.
  489. Parser
  490. ------
  491. - Метод сравнения двух расписаний вынесен в отдельную функцмю.
  492. - Изменены некоторые имена аттрибутов и методов для большей логичности.
  493. - Индекс уроков также стал группироваться по кабинетам.
  494. - Добавлен общий метод для поиска в расписании.
  495. Messages
  496. --------
  497. Методы для сборки сообщений были отделены в сволй класс - `SPMessages`.
  498. Далее этот класс представления может называться как генератор сообщений.
  499. tparser -> sparser (27.11.2022)
  500. ===============================
  501. До этого проект именовался как Timetable Pparser.
  502. Теперь же проект называется Schedule parser.
  503. Также обёртка `Console` была переписана с использование модуля `argparse`.
  504. v2.4.1 (23.11.2022)
  505. ===================
  506. Это обновление меняет систему отслеживания изменений.
  507. Также привносит некоотрых испрвления и улучшения.
  508. Обёртки обновлены до последней версии парсера.
  509. - Обновлённая система поиска изменений в расписании.
  510. Вместо того, чтобы каждый раз производить сравнение, новая система
  511. проводит общее сравнение расписания для всех классаов при загрузке
  512. расписания. Это значительно увеличивает производительно в
  513. промежутках загрузки расписания, хоть и замедляет саму загрузку
  514. и обработку.
  515. - `get_schedule_diff()` - Метод полного сравнения двух расписаний.
  516. - `update_diff_file()` - Запись изменений об обновлениях в файл.
  517. - Изменён способ проверки обновлений расписания пользователя.
  518. - `print_sc_changes()` - Метод отображения изменений в расписании.
  519. - Испрвлено отсутствие оповещний об изменениях в расписании.
  520. - Исправлено получение расписания на сегодня/завтар.
  521. v2.3 (16.11.2022)
  522. =================
  523. .. note:: Путаница в версиях
  524. Как вы могли заметить, версии распределены не совсем правильно.
  525. Некоторые изменения слишком большие, чтобы быть минорными.
  526. Некоторые напротив, слишком маленькие, чтобы быть минорными.
  527. Однако с этим уже ничего не поделать.
  528. Parser
  529. ------
  530. - Изменены имена некоторых атрибутов для большей логичности.
  531. - Имзенения в структуре файла расписания.
  532. - Небольшая оптимизация метода `get_lessons_index()`.
  533. - Упрощён метод подсчёта уроков `count_lessons()`.
  534. - `search_lessons()` Добавлена возможноть сортировки результатов поиска по дням.
  535. - Некоторые изменения в текстах сообщений.
  536. Chio
  537. ----
  538. - Совмещены некоторые команды для простоты использования.
  539. v2.2 (15.11.2022)
  540. =================
  541. индекс
  542. Расписание уроков, где как ключ вместо класса используется название
  543. урока или кабинета. На данный момент только урока.
  544. Parser
  545. ------
  546. - Доабвлено получени **индекса** уроков.
  547. - Новые методы `get_lessons_index()`, `count_lessons()`, `search_lessons()`.
  548. - В сообщение статуса добавлена информация о классах и предметах.
  549. Chio plugin
  550. -----------
  551. - Обновлена до последней версии парсера.
  552. - Исправлено получение расписания *на завтра*.
  553. - Система "пассивных" уведомлений. работающих при обработке событий.
  554. v2.1 (13.11.2022)
  555. =================
  556. Добавлены новые параметры для работы с пользователем.
  557. Первое сообщение со статусом парсера.
  558. Обновление всех обёрток до актуальной версии парсера.
  559. Добавлено предупреждение, если пользователь не указал класс.
  560. - Добавлены новые параметры пользователя.
  561. - `set_class` - Установлен ли класс у пользователя.
  562. - `lset_parser` - Время последней проверки расписания пользователем.
  563. - Обновлён метод сравнения хешей дней для повышения скорости работы.
  564. - Новый метод `print_status()` основной информации о состоянии парсера.
  565. v2.0 (13.11.2022)
  566. =================
  567. Смена мажорной версии обусловлено сменой названий переменных.
  568. А также в связи с многочисленными внутренними изменениями.
  569. Parser
  570. ------
  571. - Переименован атрибут `schedule -> lessons`.
  572. - Для большей логичности некоторые названия переменных переименованы.
  573. - Пустыне уроки очищаются на стадии загрузки расписания одни раз.
  574. - В файл расписания добавлена отметка последней загрузки расписания.
  575. - Некоторые изменения стиля сообщений.
  576. - Упрощение кода проверки диапазона дней в `print_lessons()`.
  577. Console
  578. -------
  579. - Обновлены описания команд.
  580. v1.6 (7.11.2022)
  581. ================
  582. Улучшения работы с расписанием.
  583. Доабвение расписания звонков.
  584. Обновление обёрток до последней версии.
  585. Parser
  586. ------
  587. - Добавлена поддержка расписания звонков.
  588. - Переработка методов получение и парсинга расписания.
  589. - Новые методы `get_class()`, `get_lessons()`, `get_schedule_changes()`.
  590. - Некоторые изменения в текстах сообщений методов парсера.
  591. - Исправления в методе пропуска пустых уроков расписания.
  592. - В расписание уроков также добавлено время начала и конца урока.
  593. - Метод `print_today_lessons()` для умного получения уроков на сегодня/завтра.
  594. Chio plugin
  595. -----------
  596. - Исправлено получение расписания для других дней.
  597. v1.4.2 (23.10.2022)
  598. ===================
  599. Обновления коснулись метода парсера `print_lessons()`
  600. - Добавлено двухстороннее ограничение диапазона дней (0-6).
  601. - Удалени повторяющихся дней (0, 4, 4, 2 -> 0, 4, 2).
  602. - Сортировка дней по возврастанию.
  603. Chio plugin (21.10.2022)
  604. ========================
  605. - Обновлен до `sp v1.4`.
  606. v1.4 (18.10.2022)
  607. =================
  608. Общая чистка кода проекта.
  609. Продолжаем улучшать проект и добавлять в него полезный функционал.
  610. Parser
  611. ------
  612. - Изменено поведение увдеомлений об изменениях.
  613. Теперь они отправляют расписание для дней, где оно изменилось.
  614. - Возможность "отсекать" пустые уроки с конца расписания.
  615. Console
  616. -------
  617. - Возможность получить расписание на всю неделю.
  618. v1.3 (17.10.2022)
  619. =================
  620. - `Parser`: Возможность получения расписания сразу на несколько дней.
  621. v1.2 (16.10.2022)
  622. =================
  623. - Исправлено получение расписания для других классов.
  624. v1.1 (14.10.2022)
  625. =================
  626. Parser
  627. ------
  628. - попытка исправить получение расписания на субботу.
  629. - Доабвлен аргумент `update: Optional[bool]=Fasle`, для принудительного
  630. обновления расписания уроков.
  631. Console
  632. -------
  633. - Доабвен ключ `--parse` для принудительного обновления расписания.
  634. v1.0 (12.10.2022)
  635. =================
  636. Начало развития собственной ветки проекта.
  637. Parser
  638. ------
  639. - Отделён код парсера в отдельный файл `sparser.py`.
  640. - Добавлена простая система отслеживания изменений в расписании.
  641. - Добавлены уведомления пользователям об изменениях в расписании.
  642. - Удалён парсер расписания звонков.
  643. Telegram
  644. --------
  645. - Некоторые обновления и исправления кода бота.
  646. Console
  647. -------
  648. - Написана простая обёртка для отладки работы проекта.
  649. v1.0b (10.10.2022)
  650. ==================
  651. Начало разработки проекта.
  652. За основу взят исходный код бота Артёма Березина.
  653. Внесены некоторые общие улучшения и исправления.
  654. - Исправлен список зависимостей в коде.
  655. - Чистка и стилизация кода.
  656. - Полностью переписан парсер расписания уроков.
  657. - Испрвлены некоторые ошибки в коде.
  658. - Некоторая правка текстов сообщений.
  659. - Полностью убран так называемый раздел **ВПР**.
  660. - Добавлена возможность кэширования данных в json файл.