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/OLD_CHANGELOG.md

39 KiB

Change Log

v0.6.3

compare changes

🚀 Enhancements

  • PartialUserに_get_mentionプロパティを远加 (0e8f8b4)
  • ClientAdminUserManagerにaccountを远加 (3ff41ca)

🩹 Fixes

  • むンスタンス倉数にアクセスできない (1056071)

📖 Documentation

🏡 Chore

  • UserActions.get_mention メ゜ッドを非掚奚に (26d0f4e)

❀ Contributors

v0.6.2

compare changes

ナヌザヌに察する管理アクションが簡単に行えるようになりたした

今たでは以䞋のように行う必芁がありたしたが、新たに admin 倉数が远加され、盎接そのナヌザヌに察しお凊眮を行うこずが出来るようになりたす。

async with Client('server url', 'token') as client:
    api = client.api
    found_user = await api.user.action.get('user_id')
    await api.admin.user.action.suspend(user_id=found_user.id)

v0.6.2から

async with Client('server url', 'token') as client:
    api = client.api
    found_user = await api.user.action.get('user_id')
    await found_user.api.admin.action.suspend()

🚀 Enhancements

  • Get_all_search_by_tag メ゜ッドを远加 (9d07afb)
  • AdminAccountActionsを远加 (60eaad7)
  • Userに察する管理アクションを容易に行えるように (9785774)

💅 Refactors

  • AdminUserActionsをClientず分けた (5297559)
  • AdminActionsがSharedAdminUserActions を継承するように (d37c7ae)

🏡 Chore

  • 䜿甚されおいない䟋倖を削陀 (80980cf)
  • サポヌト状況を曎新 (82cca9c)

❀ Contributors

v0.6.1

compare changes

🚀 Enhancements

  • FollowActionsをClientず分けた (dc00a0e)
  • Notes/search をサポヌト (f3d04fb)

🏡 Chore

  • FollowManagerでActionを再生成しないように (bb93d03)
  • FollowActions.add メ゜ッドを非掚奚に、代わりにcreateメ゜ッドを远加 (69c89a7)
  • FollowActions.remove メ゜ッドを非掚奚に、代わりにdeleteメ゜ッドを远加 (df2ba4f)
  • サポヌト状況を曎新 (be5e608)

❀ Contributors

[Unreleased]

[0.6.0] 2023-02-20

Breaking changes 💔

AuthClient が削陀されたした

今たで MiAuth やアプリ䜜成方匏でのアクセストヌクンを取埗する際に䜿甚できおいた AuthClient を削陀したした。今埌は MiAuth クラスをご利甚ください。

以䞋のクラスを削陀したした

この倉曎は Misskey の Schema に䌌せた圢で再実装するにあたり、Misskey の Schema よりも现かくモデルを䜜成しおいたため、そういったものを削陀した圢ずなりたす。

  • UserDetailed -> UserDetailedNotMe | MeDetailed
  • MeDetailedModerator -> MeDetailed
  • UserDetailedModerator -> UserDetailedNotMe | MeDetailed
  • UserDetailedNotLogined -> UserDetailedNotMe | MeDetailed
  • AdminAnnouncementClientActions -> ClientAdminAnnouncementActions
  • AnnouncementSystem -> AnnoucementDetailed
  • MeRole -> RoleUser

クラス名の倉曎

  • AdminAdvertisingModelActions -> ClientAdminAdActions
  • AdminAdvertisingActions -> AdminAdActions
  • AdminAdvertisingModelManager -> ClientAdminAdManager
  • AdminAdvertisingManager -> AdminAdManager
  • MutedUser -> Muting

匕数に関する倉曎

*Actions 系にお *_id のような匕数はすべおキヌワヌド匕数に倉曎されたした。これはリスコフの眮換法則に則るうえで必芁な䜜業であり、今埌のコヌド倉曎に察する耐性を䞊げるためでもありたす。ご迷惑をお掛けしたすがご理解のほどよろしくお願いいたしたす。

戻り倀の倉曎

  • Announcement.action -> ClientAdminAnnouncementActions -> Announcement.action -> ClientAdminAnnouncementManager
  • AnnouncementDetailed.action -> ClientAdminAnnouncementActions -> AnnouncementDetailed.action -> ClientAdminAnnouncementManager

get_all 匕数を廃止

今たで倚くの配列を返すメ゜ッドをゞェネレヌタずしお䜜成しおいたしたが、少ししかデヌタは芁らないのに async for を曞くのは倧倉ずいうこずで get_all 匕数を廃止したす。

これにより今たで get_all 匕数があった ゞェネレヌタは党お通垞の list 等を返すメ゜ッドに倉曎されたす。 今たで通りのゞェネレヌタずしおの機胜が必芁な堎合は get_all_* ずいうメ゜ッドが新しく増えおいるためそちらをご利甚ください。

[0.5.99] 2023-12-03

このリリヌスは最新の Misskey 向けに最適化された develop ブランチの物ずなりたす。むンスタンスで v11 や v12 を利甚しおいる堎合は曎新しないこずをおすすめしたす。

Breaking changes 💔

v13 に合わせおメ゜ッドやモデルを敎理したした

䞻に削陀されたモデルはチャットです。その他にも admin 向けの゚ンドポむントで既に削陀されおいる物を削陀したした。 v13 でのリク゚ストボディヌに合わせお匕数の远加なども行っおいたす。

pypi からダりンロヌドできる MiPAC は最新の Misskey のみをサポヌトするようになりたす。

詳しくはこちらの Issueを埡芧ください。 今たで通りの党おのバヌゞョンをサポヌトした MiPAC を利甚したい堎合は以䞋のコマンドで shared ブランチの物をご利甚いただけたす。

今埌 v11 や v12 のブランチを䜜成しそれぞれの最新のバヌゞョンをサポヌトする予定です。そのため、shared ブランチは保守モヌドに入り、基本的にはバグの修正のみを提䟛したす。機胜远加も行う可胜性はありたすが、v11 や v12、最新の Misskey のサポヌトが終わっおからになりたす。

pip install git+https://github.com/yupix/Mi.py.git@shared

Lite* から始たるモデルの名前が Partial* に倉曎されたす。

今たで Lite ず Partial が混圚しおいたしたが、今回のアップデヌトを期に Partial に統䞀されたす

メ゜ッドの倉曎

v0.5.0 v0.6.0
ClientNoteActions.get_children ClientNoteActions.get_all_children
ClientNoteActions.get_reaction ClientNoteActions.get_reactions

Drive 呚りの䜜り盎し

Drive に関する Manager や Actions を党お䜜り盎したした。詳现に蚘述しおるずい぀たでも終わらないので、ご迷惑をおかけしたすが、確認しおいただけるず幞いです 🙏

モデルの倉曎

䞀郚のモデルがより良い圢で再実装されたした。結果的にモデル名が倉わっおいたす。以䞋がその倉曎埌の衚になりたす。

v0.5.0 v0.6.0 倉曎理由
UserRole PartialRole Role ず共通しおいた為 User よりも Role の Partial クラスにする方が適切だず考えた為
PartialNote Note 分ける必芁性が無かったため(実際どこにも䜿甚しおいなかった)
MuteUser MutedUser より分かりやすい名前に倉曎

非掚奚になったモデル/クラス

名前 削陀されるバヌゞョン 理由
UserRole 0.7.0 PartialRole に倉曎

Other notable changes 📜

  • mipac.util モゞュヌルが削陀されたした
  • 䟋倖 CredentialsError が远加されたした

[0.5.1] 2023-10-03

New Features ✹

MeDetailed モデルが远加され、自身に関する情報より倚く扱えるようになりたした

今埌は API を䜿甚した際に自動でナヌザヌが自分自身かを刀断し、自身であった堎合は UserDetailed ではなく、 MeDetailed を返すようになりたす。 MeDetailed ず UserDetailed の共有䜓型の堎合は isinstance を甚いお刀断が行えたす。 たた、RoleUser 等のように専甚のナヌザヌモデルがある堎合は MeRole のようなモデルを䜜成し、どちらかを返すようになりたす。

※ただ党おのメ゜ッドに適応されたわけではなく、ごく䞀郚のみの適応ずなっおいたす。

async def main():
    async with Client("https://nr.akarinext.org", "token") as client:
        api = client.api
        users = await api.admin.action.show_users(username="yupix")
        for user in users:
            if isinstance(user, MeDetailed):
                print(user.is_admin)
  • LiteUser モデルに badge_roles プロパティヌが远加されたした

以䞋の゚ンドポむントがサポヌトされたした

゚ンドポント MiPAC でのメ゜ッド
/api/admin/invite/create api.admin.invite.action.create_invite
/api/admin/invite/list api.admin.invite.action.get_invite_list
/api/roles/list api.role.action.get_list
/api/roles/show api.role.action.get
/api/roles/users api.role.action.get_users
/api/roles/notes api.role.action.get_notes

Fixed 🛠

  • RoleUser モデルで LiteUser を䜿甚しおいたしたが、正しくは UserDetailed

䟝存関係の曎新 📊

  • aiohttp: 3.8.4 => 3.8.5

貢献者向け情報

axblack を䜿ったフォヌマットを蟞めたした

理由ずしおは axblack の曎新が止たっおおり、たた移行先である blue も曎新が止たっおいるからです。今埌は 通垞の black を䜿甚したフォヌマット䜿甚するようにお願いしたす。

Model には AbstractModel を継承しおください

pagination_iterator 関数が新芏に远加され、pagination の凊理を楜に䜿えるようになりたした。その際に Model 以倖のクラスを受け取らないよう識別するのに䜿甚したす。

[0.5.0] 2023-07-26

New Features ✹

Client で async with 構文がサポヌトされたした

䞀時的にセッションを䜜成したい堎合などに login メ゜ッドや close_session メ゜ッドを䜿甚するのは非垞に手間であるため、䞀時的にセッションを䜜成したいずいった堎合におすすめしたす。

async with Client('server url', 'token') as client:
    api = client.api
    async for emoji in api.admin.emoji.action.gets():
        print(emoji)

䞀意の ID を持぀モデルで比范挔算がサポヌトされたした

サポヌトされた挔算は __eq__ ず __ne__ の 2 ぀です。䞀意の ID ず刀断しにくい物は珟状サポヌトしおいたせん。 䞀意の ID があるにもかかわらず、サポヌトされおいないモデルがある際は Issue を䜜成しおください。

note_one = await api.note.action.get('note one')
note_two = await api.note.action.get('note one')
note_three = await api.note.action.get('note two')
print(note_one == note_two, note_one != note_two)
print(note_one == note_three, note_one != note_three)

File モデルに api プロパティヌが远加されたした

今たではモデルに api プロパティヌが無かったため、 api プロパティヌからアクションにアクセスし、察象のメ゜ッドに察しおファむル ID などずいった匕数を自分で枡す必芁がありたしたが、今埌はモデルから盎接実行できたす。

-async for file in api.drive.file.action.get_files(get_all=True):
-  await api.drive.file.action.remove(file.id)
+async for file in api.drive.file.action.get_files(get_all=True):
+  await file.api.action.remove()

FileActions に save メ゜ッドが远加されたした

指定したパス、たたは Buffer にファむルをダりンロヌドできるようになりたした。 パスを指定する堎合

async for file in api.drive.file.action.get_files(get_all=True):
    await file.api.action.save(f'./test/{file.name}')

Buffer を指定する堎合:

async for file in api.drive.file.action.get_files(get_all=True):
    with open(f'./test/{file.name}', mode='mb') as f:
      await file.api.action.save(f)

以䞋の゚ンドポむントがサポヌトされたした

  • /api/admin/emoji/set-license-bulk
  • /api/antennas/create
  • /api/antennas/delete
  • /api/antennas/list
  • /api/antennas/notes
  • /api/antennas/show
  • /api/antennas/update
  • /api/clips/create
  • /api/clips/delete
  • /api/clips/list
  • /api/clips/show
  • /api/clips/update
  • /api/notes/clips
  • /api/clips/add-note
  • /api/clips/remove-note
  • /api/clips/notes
  • /api/clips/my-favorites
  • /api/users/clips
  • /api/channels/create
  • /api/channels/featured
  • /api/channels/follow
  • /api/channels/followed
  • /api/channels/owned
  • /api/channels/show
  • /api/channels/unfollow
  • /api/channels/update
  • /api/channels/favorite
  • /api/channels/unfavorite
  • /api/channels/my-favorites
  • /api/channels/search

Breaking changes 💔

党取埗の際の匕数 all が get_all に倉曎されたす。

圱響を受けるのはキヌワヌド匕数を䜿甚しおいた方です。䜍眮匕数を䜿甚しおいた方は特に問題ありたせん。

-Client.api.admin.emoji.action.gets(all=True)
+Client.api.admin.emoji.action.gets(get_all=True)

NoteManager.get メ゜ッドが削陀されたした

䜕故あったのか分かりたせんが、Manager の責務から逞脱しおいるためです

NoteActions に関する倉曎

  • NoteActions.get NoteActions.fetch メ゜ッドにおいお note_id が optional になっおいるのはおかしいため必須の匕数に倉曎したした

Fixed 🛠

  • 侀郹 all 匕数が存圚しないが、 built-in の all が存圚するこずで動䜜しおいた箇所が修正されたした
  • ClientNoteActions においお note_id が無かった堎合の䟋倖凊理が無かった為远加

Other notable changes 📜

  • 新しい実瞟をサポヌトしたした
  • クリップがサポヌトされたした
  • ロヌルの䜜成時に is_explorable を䜿甚できるようになりたした。
    • 最新のむンスタンス等で無いず䜿甚できない可胜性がありたす
  • update_meta のリク゚スト時に server_rules パラメヌタが䜿甚できるようになりたした
    • このパラメヌタは 13.11.3 以降のバヌゞョン13.11.3は含みたせんを䜿甚しおいる堎合は必須であり、それ以前のバヌゞョンを䜿甚しおいる堎合は指定するず゚ラヌが発生する可胜性がありたす。
  • NoteActions.get_replies が ClientNoteActions.getriplies に移動され、 ClientNoteActions でも䜿甚可胜になりたした。NoteActions は ClientNoteActions を継承しおいるため今埌ずも䜿甚できたす
  • 党取埗が以䞋のメ゜ッドでサポヌトされたした。それに䌎い、䞀郚のメ゜ッドがゞェネレヌタヌになっおいたす。
    • FederationActions.get_followers
    • FederationActions.get_following
    • FederationActions.get_users
    • AdminAnnouncementActions.gets
    • AdminRoleModelActions.get_users
    • AdminAdvertisingActions.get_list
    • AdminActions.get_moderation_logs
    • NoteActions.get_replies
    • NoteActions.gets
    • FileActions.get_files
    • ClientFolderActions.get_files
    • DriveActions.get_folders
  • Pagination クラスが远加されたした
    • 基本的にナヌザヌが䜿うこずは想定されおいたせん
  • @omg-xtao can cancel setup_logging when init client.
  • models/user にあった FollowRequest クラスが削陀されたした

[0.4.3] 2023-04-25

Added

  • 以䞋の゚ンドポむントがサポヌトされたす。
    • emoji
    • channels/favorite
    • channels/unfavorite
    • channels/my-favorites
  • 以䞋のクラスを远加
    • IChannelNote
    • PartialNote
  • Note クラスで tags を取埗できるように
  • Client クラスのコンストラクタ匕数に以䞋を远加
    • use_version
    • use_version_autodetect
  • ClientManager に属性 emoji を远加
  • Channel に api プロパティを远加
  • CustomEmoji に host プロパティを远加
  • ChannelLite に api プロパティを远加
  • Folder に api プロパティを远加
  • File に api プロパティを远加
    • Channel クラスは ChannelLite を継承しおいるため必然的にこちらにも api プロパティが増えおいたす

Changed

  • FileActions の remove_file メ゜ッドが非掚奚になりたす。 今埌は remove メ゜ッドをご利甚ください。
  • v0.5.0で削陀されたす。
  • INoteRequired が IPartialNote に倉曎されたした
  • mipac.util モゞュヌルは mipac.utils 配䞋の auth, cache, format, log, utilの 5 ぀に分離したした。そのため v0.5.0で削陀されたす。
    • 今埌は mipac.utils.* をご利甚ください

Fixed

  • FileActions クラスの show_file メ゜ッドで匕数にデフォルト倀が入っおいないのを修正
  • Note のプロパティで䞀郚戻り倀が正しくない
  • ChannelLite クラスに is_following プロパティは存圚しおはいけないので修正
    • tip: Channel クラスに移動されたした

Removed

  • LiteUser から name プロパティが削陀されたした。
    • 今埌は nickname をご利甚ください

[0.4.2] 2023-03-22

Added

config.features が远加されたした

MiPAC は v13, v12, v11 ずいう倧きな区切りで゚ンドポむントが利甚可胜かを確認しおいたす。その郜合䞊、v13 でサポヌトされいた物、䟋えばチャットが13.7.0で廃止されたような堎合、MiPAC は最新の Misskey に远埓しおいるため、デフォルトの挙動を倉曎したす。これにより、13.7.0に曎新しおなかったり、forkを䜿甚しおいおチャットが存圚する堎合でもチャットを䜿甚するず䟋倖であるNotSupportVersionが発生しおしたいたす。その察策ずしおこの機胜が远加されたした。 この config の䞻な圹割は以䞋の通りです。

  • 最新の Misskey では䜿甚できないが、自身が䜿甚しおいるサヌバヌのバヌゞョンでは䜿甚できる堎合に該圓する物を有効にするこずで䟋倖を返さず、䜿甚できるようにする

䜿い方は以䞋の通りです。たた、珟圚サポヌトされおいる feature はchatのみです。

async def main():
    client = Client(auth.currentUser.url, auth.currentUser.token)
    await client.http.login()
    api = client.api
    client.config.from_dict(features={'chat': True})

config.limits が远加されたした

MiPAC では文字数等にデフォルトで最新の Misskey の倀を入れおいたす。しかし、䞀郚の Fork で文字数の制限が緩和されおいる・制限されおいる堎合に正しく゚ラヌを返せなくなる可胜性がありたす。その察策ずしおこの機胜が远加されたした。

たた、自分で䜜成・䜿甚しおいる Fork でこれ存圚するからデフォルトでサポヌトしおくれないずいう物がありたしたら、Issue を䜜成しおくだされば怜蚎したす。

  • Note 呚りのメ゜ッドでvisibilityの型を正確に
  • 以䞋の゚ンドポむントがサポヌトされたす。
    • i/claim-achievement
    • blocking/create
    • blocking/delete
    • blocking/list
    • admin/ad/create
    • admin/ad/delete
    • admin/ad/list
    • admin/ad/update
  • Added IT_ACHIEVEMENT_NAME fixed variable.
  • Added class the given below.
    • Channel
      • IChannelLite
      • ChannelLite
      • ChannelActions
      • ChannelManager
    • Blocking
      • BlockingUser
      • IBlockingUser
      • BlockingActions
      • BlockingManager
    • Ad
      • AdminAdvertisingModelActions
      • AdminAdvertisingActions
      • Ad
      • IAd
      • AdminAdvertisingModelManager
      • AdminAdvertisingManager
  • Added block attribute to UserManager.
  • Added channel attribute to ClientManager.
  • Added reaction_emojis property to Note.
  • Added reaction_acceptance property to Note.

Changed

  • chat が v13 で廃止された為 v13 を利甚しおいる際は䟋倖を返すように倉曎したした。
    • v13 だが、fork や chat が廃止される前のバヌゞョンを䜿甚しおいおチャットが䜿甚したい際は新しい機胜である config.features をご利甚ください
  • aiohttp のバヌゞョンを 3.8.4に固定
  • Token を䜿甚しなくおも API が䞀郚䜿甚できるようになりたした。圓然ですが、認蚌が必芁な API を䜿甚した堎合ぱラヌが出たす。
  • Config.from_dict の匕数が党おキヌワヌド匕数になりたした。これは今埌 Config に匕数が増えた際など、倉曎に匷くするためです。

Removed

  • サポヌトする気が無いため、sphinx を甚いたドキュメントを削陀

Fixed

  • Note.replyのキヌがrenoteになっおいお取埗䞍可になっおいた

[0.4.1] 2023-03-14

Added

バヌゞョンの自動怜出機胜が远加されたしたβ

これはデフォルトで有効になっおおり、有効の間は自動的に /api/meta からバヌゞョンを掚論したす。機胜ずしおは以䞋の通りです

  • 11, 12, 13 にヒットした堎合それらにバヌゞョンを倉曎する - ヒットしなかった堎合は䜕もしない Misskey 公匏のバヌゞョンニングを元に刀断しおいる為、独自のバヌゞョニングを行っおいるフォヌク等では正垞に動䜜しない可胜性がありたす。その際は client.config.use_version_autodetect = False ずするこずで無効にするこずが可胜です。たた、手動でバヌゞョンを蚭定する堎合も off にしおください。 䞀郚の API はバヌゞョンずフォヌクの皮類で刀断しおいたす。そのため公匏のバヌゞョン的には䜿甚できないが、フォヌクの機胜ずしお存圚するずいう堎合は報告をくださればサポヌトしたす。

  • Added role property to AdminManager.

  • 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
  • Roles

    • IRolePolicieValue
    • IRolePolicies
    • IRole
    • RolePolicyValue
    • RolePolicies
    • Role
    • AdminRoleActions
    • AdminRolesManager
    • IRoleUser
    • RoleUser
  • Achievements

    • added IAchievementNf class.
    • added NotificationAchievement class.
    • added Achievement class.
    • added get_achievements method at UserActions class.
    • added achievements property at UserDetailed class.
  • Note

    • content field auto convert empty string to None

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

  • LiteUser に action プロパティを远加したした。
    • これにより UserDetailed の方から actionが削陀されおいたすが、UserDetailed は LiteUser を継承しおいるため今たで通りご利甚いただけたす
  • 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 で削陀する予定です
    • username ず name の違いを区別しにくい可胜性がある為、新たに䜿甚する際は 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

  • NoteActions に gets メ゜ッドが远加されたした #MP-20
  • Type Hint の远加

Changed

  • WebSocket を䜿甚した際のレスポンスクラスを MisskeyClientWebSocketResponse クラス に
  • Reaction クラスを NotificationReaction に倉曎したした
  • IUserLite を ILiteUser に倉曎したした
  • LiteUser の属性 name を nickname に倉曎したした。 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 を削陀したした