You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mipac/CHANGELOG.md

16 KiB

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • Added remove_none argument to request method.
  • Added method toClientActions class the given below.
    • get_announcements
  • Added class the given below.
    • AdminUserActions
    • AnnouncementCommon
    • Announcement
    • AnnouncementSystem
    • IMetaAnnouncement
    • IAnnouncementSystem
    • AdminAnnouncementClientActions
    • AdminAnnouncementActions
    • AdminAnnouncementManager
    • IModerationLog
    • ModerationLog
    • ServerInfoCpu
    • ServerInfoMem
    • ServerInfoFs
    • ServerInfoNet
    • ServerInfo
    • IServerInfoCpu
    • IServerInfoMem
    • IServerInfoFs
    • IServerInfoNet
    • IServerInfo
    • ITableStats
    • IIndexStat
    • IndexStat
    • IUserIP
    • UserIP
    • FederationActions
    • FederationManager
    • IFederationInstanceStat
    • IFederationFollowCommon
    • IFederationFollower
    • IFederationFollowing
  • Achievements
    • added IAchievementNf class.
    • added NotificationAchievement class.
    • added Achievement class.
    • added get_achievements method at UserActions class.
    • added achievements property at UserDetailed class.

Changed

  • Maximum number of characters has been changed from 79 to 99
    • The main reason for this change is to solve the problem that the MiPAC code is inevitably longer because of the method chain. We have kept it to the maximum of pep8.
  • Changed a method that was returning an AsyncIterator to return an AsyncGenerator.
    • Generator is more correct than Iterator because it is the correct usage.
  • Changed class name the given below.
    • IAnnouncement -> IMetaAnnouncement
  • cache decorator no longer uses dynamic_args decorator

Removed

  • Delete dynamic_args decorator.
  • Delete debug log.

[0.4.0] 2023-01-18

Added

  • added DocString.
  • added get_state method at ClientNoteActions class.
  • added INoteState class.
  • added NoteState class.
  • added IBasePoll class.
  • added ICreatePoll class.
  • added MiPoll class.
  • added PollManager class.
  • added PollActions class.
  • added AdminEmojiActions class.
  • added AdminManager class.
  • added AdminModeratorManager class.
  • added ActiveUsersChart class.
  • added IDriveChart class.
  • added IDriveLocalChart class.
  • added IDriveRemoteChart class.
  • added attribute is_official at Config class.
    • became is_ayuskey attribute is deprecated(I'll remove with v0.4.0)
  • added get_exception_from_id function.
  • Return an exception appropriate for the error encountered.
  • @omg-xtao added users_search_by_username_and_host method at UserActions class #24.
  • @omg-xtao added note_translate method at UserActions class #24.
  • @omg-xtao added users_search method at UserActions class #24.
  • added new ClientActions class.
  • added avatar_color property at LiteUser class.
    • Note: Since avatar_color is deprecated in v13, only None is returned for v13 instances.
  • added un_renote method at ClientNoteActions class.
  • added get_children method at ClientNoteActions class.
  • added invalidate method at FollowActions class.
  • added cancel method at FollowRequestActions class.
  • added mute attribute at UserManager class.
  • added MuteManager class.
  • added MuteActions class.
  • added MuteUser class.
  • added IMuteUser class.
  • added AdminActions class.
  • added ICustomEmojiLiteRequired class.
  • The following methods are added to the AdminEmojiActions class.
    • gets
    • gets_remote
  • added some meta class.
    • ICPU
    • IPolicies
    • IAnnouncement
    • IV12Features
    • IV11Features
    • IFeatures
    • IV12AdminMeta
    • ISharedAdminMeta
    • ILiteV12Meta
    • ILiteV11Meta
    • IMetaCommonV12
    • ICommonV11
    • IMetaCommon
    • ILiteMeta
    • IV12Meta
    • IMeta
    • IAdminMeta
    • Policies
    • Features
    • Meta
    • AdminMeta
    • CPU
    • MetaCommon
    • LiteMeta
  • added some federation class.
    • IFederationInstanceRequired
    • IFederationInstance
    • FederationInstance
  • added some notification classes.
    • Notification
    • NotificationFollow
    • NotificationFollowRequest
    • NotificationNote
    • NotificationPollEnd
    • NotificationReaction
    • IUserNf
    • INoteNf
    • IPollEndNf

Changed

  • rename ActiveUsersChartPayload class to IActiveUsersChart class.
  • rename DriveLocalChartPayload class to IDriveLocalChart class.
  • rename DriveRemoteChartPayload class to IDriveRemoteChart .class.
  • rename DriveChartPayload class to IDriveChart class.
  • The attribute emojis for Note and LiteUser is obsolete in misskey v13, so v13 will return an empty list.
  • config is now a global variable.
    • If you want to change the config, please use Client.config.from_dict.
  • CustomEmoji now inherits PartialCustomEmoji.
  • PartialCustomEmoji url has been changed to return str | None to match v13.
  • AdminManager's get_invite method has been moved to `AdminActions.
  • BREAKING CHANGE ClientActions has been changed to ClientManager
  • BREAKING CHANGE Some paths will be changed as follows
    • manager.admin -> manager.admins
    • manager.admin.manager -> manager.admins.admin
    • actions.admin -> actions.admins
  • BREAKING CHANGE
    • The action property in the model has been changed to api.
      • Change note.action.send to note.api.action.send.
    • Moved the reaction attribute of ClientActions to NoteManager.
      • Change api.reaction to api.note.reaction.
    • Moved methods from AdminEmojiManager to AdminEmojiActions.
      • Change api.admin.emoji.add to api.admin.emoji.action.add.
    • Moved methods from AdminModeratorManager to AdminModeratorActions.
      • Change api.admin.moderator.add to api.admin.moderator.action.add.
    • Moved methods from ChartManager to ChartActions.
      • Change api.chart.get_active_user to api.chat.action.get_active_user.
    • Moved methods from FollowManager to FollowActions.
      • Change api.user.follow.add to api.user.follow.action.add.
    • Moved methods from FollowRequestManager to FollowRequestActions.
      • api.user.follow.action.get_all.
    • Moved some attributes of NoteActions to NoteManager.
      • Change api.note.action.reaction.add to api.note.reaction.action.add.
    • Moved the reaction attribute of NoteActions to ClientNoteManager.
      • Change api.note.action.reaction to api.note.reaction.action.
      • Change api.note.action.favorite to api.note.favorite.action.

Fixed

  • can't delete emoji with v12.
  • fixed ChatMessage model.
    • For v13, the url is automatically generated. (Although it returns None by type, it never actually returns None.
  • fixed Chat action.
  • fixed Chat action.

Removed

  • The following attributes have been removed api.user.action.note
  • Delete RawActiveUsersChart class.
  • Delete RawDriveLocalChart class.
  • Delete RawDriveRemoteChart class.
  • Delete RawDriveChart class.
  • Delete get_user method at FollowRequestActions class.
  • removed some meta classes.
    • LiteInstanceMeta
    • IInstanceMetaLite
    • IInstanceFeatures
    • IInstancePolicies
    • InstanceMeta

[0.3.1] 2022-12-24

Added

  • added NoteDeleted class.
  • added INoteUpdatedDeleteBody class.
  • added INoteUpdatedDelete class.
  • str_to_datetime 関数を追加

Fixed

  • PartialReaction クラスで user_id が取得できない
  • INoteUpdatedReaction の型が間違っている

[0.3.0] 2022-12-24

Fixed

  • fix INoteUpdated type

Changed

  • BREAKING CHANGE Required Python version is 3.11

[0.2.8] 2022-12-23

Added

  • LiteUseraction プロパティを追加しました。
    • これにより UserDetailed の方から actionが削除されていますが、UserDetailedLiteUser を継承しているため今まで通りご利用いただけます
  • UserActions クラスに get_profile_link メソッドを追加しました

[0.2.7] 2022-12-23

Fixed

[0.2.6] - 2022-12-08

Added

  • INoteUpdated クラスを追加しました
  • INoteUpdatedReactionBody クラスを追加しました
  • INoteUpdatedReaction クラスを追加しました
  • PartialCustomEmoji クラスを追加しました
  • PartialReaction クラスを追加しました

[0.2.5] - 2022-12-08

Added

  • ISignin クラスを追加

Fixed

  • Noteモデルの content が無い場合KeyErrorになる
  • Noteモデルの cw が無い場合KeyErrorになる

[0.2.4] - 2022-12-08

Added

  • ClientNoteManager クラスを追加しました
  • ClientNoteActions クラスを追加しました

Changed

  • NoteActions が持っているノートに対する操作を ClientNoteActions に移動しました
    • 継承しているため今まで通り使用できます

Fixed

  • sendメソッドの引数 extract_hashtags が正常に動作しない

[0.2.3] - 2022-11-27

Fixed

  • NoteAction.send メソッドで作成したノートのモデルが生成できない
  • request メソッドで戻り値がlistではなくdistだった場合snake caseに置き換えできない

[0.2.2] - 2022-11-27

Added

  • LiteUser に属性 name を互換性の為に再追加しましたが、非推奨です。v0.4.0で削除する予定です
    • usernamename の違いを区別しにくい可能性がある為、新たに使用する際は nickname を使用することを推奨しています

Changed

  • deprecatedに関する仕組みを変更しました。
    • 該当するコードを表示するようになっています

Fixed

  • 型の間違い等
  • 使用しているインポートがTYPE_CHECKINGの条件式の中に入っていた為使用できない
  • get_mention メソッドでusername ではなくnicknameを使用していた為正しいmentionが作れない
  • LiteUser クラスの属性instance でBotと同じインスタンスのユーザーの場合はNoneを返せずKeyErrorになる可能性があった
  • LiteUser クラスの属性 host を取得すると KeyErrorになる可能性があった

Removed

  • deprecated_property decorator を削除しました
  • deprecated_func decorator を削除しました

[0.2.1] - 2022-11-27

Added

  • NoteActionsgets メソッドが追加されました #MP-20
  • Type Hintの追加

Changed

  • WebSocketを使用した際のレスポンスクラスを MisskeyClientWebSocketResponse クラス に
  • Reaction クラスを NotificationReaction に変更しました
  • IUserLiteILiteUser に変更しました
  • LiteUser の属性 namenickname に変更しました。 LiteUser を継承しているクラスも同様に変更されていますのでご注意ください。

Removed

  • printを使用したデバッグログを削除しました

[0.2.0] - 2022-11-02

Added

  • added Modeler class
  • added IReactionRequired class
  • added IAds class
  • added LiteInstance class
  • added IReactionNf class
  • added INote class
  • added ICustomEmoji class
  • added CustomEmoji class
  • added InstanceMeta class
  • added LiteInstanceMeta
  • added IInstanceMetaLiteRequired class
  • added IInstanceMetaLite class
  • added IInstanceMeta class
  • added IPage class
  • added IPageRequired class
  • added IUserDetailedField class
  • added IUserDetailedRequired class
  • added IUserDetailed class
  • added ChatGroup class
  • added ChatMessage class
  • added IChatGroup class
  • NoteActionsクラスに get fetch メソッドを追加
  • データをキャッシュするためのツールをutils.pyに追加
  • orjsonが使用者の環境にある場合はjsonではなくorjsonを使用するようになりました

Changed

  • Dict[Any, Any] のような構文を typing モジュールを使わない dict[any, any] に変更
  • List[Any, Any] のような構文を typing モジュールを使わない list[any, any] に変更
  • Channel クラスを RawChannel を用いて作るように
  • PinnedNote クラスを RawPinnedNote を用いて作るように
  • change class name PinnedNotePayload -> IPinnedNote
  • change class name ChannelPayload -> IChannel
  • change class name NotePayload -> INote
  • BREAKING CHANGE renamed Client.action to Client.api.

Removed

  • Renote クラスを削除しました。今後は Note クラスをご利用ください
  • IRenote, RenotePayload クラスを削除しました。今後は INote クラスをご利用ください
  • RawEmoji, Emoji クラスを削除しました。 今後は CustomEmoji クラスをご利用ください
  • EmojiPayload クラスを削除しました。今後は ICustomEmoji クラスをご利用ください
  • IReactionRequired, ReactionPayloadを削除しました。 今後は IReactionNf クラスをご利用ください
  • RawUser, User クラスを削除しました。今後は UserDetailed, LiteUser クラスをご利用ください
  • RawInstance クラスを削除しました。今後は LiteInstance クラスをご利用ください
  • RawProperties クラスを削除しました。今後は FileProperties クラスをご利用ください
  • RawFolder クラスを削除しました。今後は Folder クラスをご利用ください
  • RawFile クラスを削除しました。 今後は File クラスをご利用ください
  • RawChat, Chat クラスを削除しました。 今後は ChatMessage クラスをご利用ください
  • ChatPayload クラスを削除しました。 今後は IChatMessage クラスをご利用ください
  • get_note メソッドを削除しました。今後は get もしくは fetch メソッドをご利用ください
  • aiocache を使用しないようになりました

Fixed

  • 一部の型が正しくないのを修正しました

[0.1.0] - 2022-05-28

Added

  • __all__ の定義
  • utils.py に AuthClient クラスを追加しました
  • Config クラスを追加しました
  • Client クラスの引数に config を追加しました
  • FileActions クラスを追加しました
  • FolderActions クラスを追加しました
  • README.md に使い方を追加

Changed

  • Note クラスのcreated_at 属性の type hint を Optional[str] => Optional[datetime] に変更
  • Note クラスの cw 属性の取得方法が get ではなかったので修正
  • BREAKING CHANGE FileManager, FolderManager, DriveManagerの役割が変わりました
    • 例だと FolderManager.get_files() だったコードが FolderManager.action.get_files() と行ったふうに Actions クラスを経由するようになりました
  • 開発者向け情報 Folder クラスの引数に client を追加しました

Fixed

  • config が無く動かなかった場所の修正
  • 誤った型の修正

Removed

  • 重複した属性を削除
  • 不要な import の削除
  • 終わっている TODO を削除しました