Mipac

[compare changes](https://github.com/yupix/MiPAC/compare/0.6.2...v0.6.3)

🚀 Enhancements

- PartialUserに_get_mentionプロパティを追加 ([0e8f8b4](https://github.com/yupix/MiPAC/commit/0e8f8b4))
- ClientAdminUserManagerにaccountを追加 ([3ff41ca](https://github.com/yupix/MiPAC/commit/3ff41ca))

🩹 Fixes

- インスタンス変数にアクセスできない ([1056071](https://github.com/yupix/MiPAC/commit/1056071))

📖 Documentation

- Update rst & po ([b8f6937](https://github.com/yupix/MiPAC/commit/b8f6937))

🏡 Chore

- UserActions.get_mention メソッドを非推奨に ([26d0f4e](https://github.com/yupix/MiPAC/commit/26d0f4e))

❤️ Contributors

- Yupix ([yupix](http://github.com/yupix))

py
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](https://github.com/yupix/MiPAC/commit/9d07afb))
- AdminAccountActionsを追加 ([60eaad7](https://github.com/yupix/MiPAC/commit/60eaad7))
- Userに対する管理アクションを容易に行えるように ([9785774](https://github.com/yupix/MiPAC/commit/9785774))

💅 Refactors

- AdminUserActionsをClientと分けた ([5297559](https://github.com/yupix/MiPAC/commit/5297559))
- AdminActionsがSharedAdminUserActions を継承するように ([d37c7ae](https://github.com/yupix/MiPAC/commit/d37c7ae))

🏡 Chore

- 使用されていない例外を削除 ([80980cf](https://github.com/yupix/MiPAC/commit/80980cf))
- サポート状況を更新 ([82cca9c](https://github.com/yupix/MiPAC/commit/82cca9c))

❤️ Contributors

- Yupix ([yupix](http://github.com/yupix))

[compare changes](https://github.com/yupix/MiPAC/compare/0.6.0...v0.6.1)

🚀 Enhancements

- FollowActionsをClientと分けた ([dc00a0e](https://github.com/yupix/MiPAC/commit/dc00a0e))
- Notes/search をサポート ([f3d04fb](https://github.com/yupix/MiPAC/commit/f3d04fb))

🏡 Chore

- FollowManagerでActionを再生成しないように ([bb93d03](https://github.com/yupix/MiPAC/commit/bb93d03))
- FollowActions.add メソッドを非推奨に、代わりにcreateメソッドを追加 ([69c89a7](https://github.com/yupix/MiPAC/commit/69c89a7))
- FollowActions.remove メソッドを非推奨に、代わりにdeleteメソッドを追加 ([df2ba4f](https://github.com/yupix/MiPAC/commit/df2ba4f))
- サポート状況を更新 ([be5e608](https://github.com/yupix/MiPAC/commit/be5e608))

❤️ Contributors

- Yupix ([yupix](http://github.com/yupix))

[Unreleased]

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_*` というメソッドが新しく増えているためそちらをご利用ください。

このリリースは最新の Misskey 向けに最適化された `develop` ブランチの物となります。インスタンスで `v11` や `v12` を利用している場合は更新しないことをおすすめします。

Breaking changes 💔

v13 に合わせてメソッドやモデルを整理しました

主に削除されたモデルはチャットです。その他にも `admin` 向けのエンドポイントで既に削除されている物を削除しました。
v13 でのリクエストボディーに合わせて引数の追加なども行っています。

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

詳しくは[こちらの Issue](https://github.com/yupix/MiPAC/issues/94)を御覧ください。
今まで通りの全てのバージョンをサポートした MiPAC を利用したい場合は以下のコマンドで `shared` ブランチの物をご利用いただけます。

今後 `v11` や `v12` のブランチを作成しそれぞれの最新のバージョンをサポートする予定です。そのため、`shared` ブランチは保守モードに入り、基本的にはバグの修正のみを提供します。機能追加も行う可能性はありますが、v11 や v12、最新の Misskey のサポートが終わってからになります。

bash
pip install git+https://github.com/yupix/Mi.py.gitshared


`Lite*` から始まるモデルの名前が `Partial*` に変更されます。

今まで Lite と Partial が混在していましたが、今回のアップデートを期に `Partial` に統一されます

メソッドの変更

New Features ✨

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

今後は API を使用した際に自動でユーザーが自分自身かを判断し、自身であった場合は `UserDetailed` ではなく、 `MeDetailed` を返すようになります。
`MeDetailed` と `UserDetailed` の共有体型の場合は `isinstance` を用いて判断が行えます。
また、`RoleUser` 等のように専用のユーザーモデルがある場合は `MeRole` のようなモデルを作成し、どちらかを返すようになります。

※まだ全てのメソッドに適応されたわけではなく、ごく一部のみの適応となっています。

py
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 以外のクラスを受け取らないよう識別するのに使用します。