Skip to content
This repository has been archived by the owner on Sep 25, 2024. It is now read-only.

v2.4 (Improvements and more)

Compare
Choose a tag to compare
@SecondThundeR SecondThundeR released this 13 Mar 19:31
· 120 commits to main since this release
ec74c15

Breaking Changes

  • Переименован ресурс Calendar в Calendars

    api.calendar.get_all(...) -> api.calendars.get_all(...)

  • Некоторые методы теперь запрашивают енамы, вместо обычных переменных, которые валидировались перед отправкой запроса

    Пример импортирования: from shikithon.enums import CommentableType, MessageType, ...

  • Параметр is_nickname для некоторых запросов теперь вычисляется динамически и удален из параметров метода
  • Переименованы названия некоторых API методов к названиям из документации
    • api.abuse_requests.comment_offtopic -> api.abuse_requests.offtopic
    • api.abuse_requests.comment_review -> api.abuse_requests.review
    • api.abuse_requests.violation_request -> api.abuse_requests.abuse
    • api.abuse_requests.spoiler_abuse_request -> api.abuse_requests.spoiler
    • api.(achievements|bans|calendars|forums|genres|publishers|studios).get -> api.(achievements|bans|calendars|forums|genres|publishers|studios).get_all
    • api.(animes|mangas|ranobes).creators -> api.(animes|mangas|ranobes).roles
    • api.(animes|mangas|ranobes).related_content -> api.(animes|mangas|ranobes).related
    • api.(animes|mangas|ranobes).franchise_tree -> api.(animes|mangas|ranobes).franchise
  • Обновлены параметры некоторых методов
    • api.appears.mark([..., ..., ...]) -> api.appears.mark(..., ..., ...)

Changelog

  • Добавлена поддержка полей logo и is_private в методе Clubs.update

    Теперь можно изменять картинку клуба напрямую через метод обновления

  • Обновлена и исправлена типизация в проекте

    Теперь методы имеют корректные типы параметров и возвращаемые типы

  • Обновлено логирование
    • Добавлен цветной вывод в консоль
    • Добавлено больше точек логирования
    • Изменен формат времени в консоли
    • Изменен вывод с sys.stderr на sys.stdout
    • Исправлен текст у некоторых точек логирования
  • Обновлены зависимости проекта
  • Обновлены и исправлены модели

    В частности, исправлены некоторые поля, которые могли принимать сразу модели Manga и Ranobe

  • Удалены валидаторы параметров методов API

    При неверных параметрах, теперь выбрасывается ошибка ShikimoriAPIResponseError в которой описана полностью ошибка запроса

  • Различные исправления и улучшения

Подробный ченджлог доступен в #16

Full Changelog: v2.3.1...v2.4