Merge branch 'release/v3.3.0'

Author: yupix

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v3.3.0] 2022-01-25
+
+### Added
+
+- `get_files` メソッドを追加しました。
+  - **It will be changed to a generator in the next update.**
+
 ## [v3.2.1] 2022-01-24
 
 ### Fixed
@@ -21,18 +28,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- 以下のNoteクラスのメソッドでnote_idが必須になっていたのを修正
-    - `add_clips`
-    - `create_renote`
-    - `create_quote`
-    - `get_note`
-    - `get_replies`
-    - `get_reaction`
-    - `delete`
+- 以下の Note クラスのメソッドで note_id が必須になっていたのを修正
+  - `add_clips`
+  - `create_renote`
+  - `create_quote`
+  - `get_note`
+  - `get_replies`
+  - `get_reaction`
+  - `delete`
 - 以下の引数が正常な動作になりました
-    - `noExtractMentions`
-    - `noExtractHashtags`
-    - `noExtractEmojis`
+  - `noExtractMentions`
+  - `noExtractHashtags`
+  - `noExtractEmojis`
 
 ## [v3.1.0] 2022-01-23
 
@@ -42,13 +49,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- propertiesが存在しない場合にエラーが出る
+- properties が存在しない場合にエラーが出る
 
 ## [v3.0.1] 2022-01-23
 
 ### Fixed
 
-- user.pyでInstanceクラスが読み込めてない
+- user.py で Instance クラスが読み込めてない
 
 ## [v3.0.0] 2022-01-23
 
@@ -83,28 +90,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - 内部変更: `UserActions` や `ClientActions` のメソッドを別クラスに分割
 - Allow only property-based access to most data classes.
 - **BREAKING CHANGE**: `User` クラスのプロパティーを以下のように変更
-    - `name` -> `nickname`
-    - `username` -> `name`
+  - `name` -> `nickname`
+  - `username` -> `name`
 - **BREAKING CHANGE**: `User` クラスの `follow` `unfollow` メソッドを削除
-    - 今後は `User` クラスの `action` メソッドから `add` `remove` メソッドを使用できます
+  - 今後は `User` クラスの `action` メソッドから `add` `remove` メソッドを使用できます
 - **BREAKING CHANGE**: モデル名の変更 `Following` -> `Follower`
 - **BREAKING CHANGE**: モデル名の変更 `Follower` -> `Followee`
 - **BREAKING CHANGE**: モデルの\_state 属性を\_\_state に変更
 - **BREAKING CHANGE**: `Following` クラスのメソッドを以下のとおりに変更
-    - `accept_request` -> `accept`
-    - `reject_request` -> `reject`
-    - `follow` -> `add`
-    - `remove_follow` -> `remove`
+  - `accept_request` -> `accept`
+  - `reject_request` -> `reject`
+  - `follow` -> `add`
+  - `remove_follow` -> `remove`
 
 ## Removed
 
 - Unused class UserDetails
-    - from now on use `RawUserDetails`
+  - from now on use `RawUserDetails`
 - Unused file view.py
 - **BREAKING CHANGE**: removed `post_note` method
-    - from now on use `self.client.note.send`
+  - from now on use `self.client.note.send`
 - **BREAKING CHANGE**: removed `note_delete` method
-    - from now on use `self.client.note.delete`
+  - from now on use `self.client.note.delete`
 
 ## [v2.1.0-alpha] 2021-12-30
 
@@ -158,13 +165,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - The following classes no longer inherit from `BaseModel`
-    - Properties
-    - Folder
-    - File
-    - Channel
-    - PinnedNote
-    - PinnedPage
-    - FieldContent
+  - Properties
+  - Folder
+  - File
+  - Channel
+  - PinnedNote
+  - PinnedPage
+  - FieldContent
 - internal change: optimizing import
 - internal change: Renamed `PinnedPage` to `PinnedNote`
 - **BREAKING CHANGE**: Moved the post_note method of ConnectionState to NoteActions
@@ -202,8 +209,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - add `favorite`, `add_to_clips`, `add_reaction` and `remove_favorite` method to `Note` class
 - add `favorite`, `add_note_to_clips`, `add_reaction_to_note` and `remove_favorite` method to `NoteAction` class
 - add class
-    - NoteActions
-    - ClientActions
+  - NoteActions
+  - ClientActions
 
 ### Fixed
 
@@ -215,21 +222,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - `Note` クラスに `reply` メソッドを追加しました
 - 以下のクラスを追加
-    - MisskeyWebSocket
-    - MisskeyClientWebSocketResponse
-    - Route
-    - HTTPClient
+  - MisskeyWebSocket
+  - MisskeyClientWebSocketResponse
+  - Route
+  - HTTPClient
 - Client に以下のメソッドを追加
-    - post_chat
-    - delete_chat
-    - post_note
-        - 今後のノート投稿はこちらを使用してください
-    - delete_note
-    - get_instance
-    - fetch_instance
-    - get_user
-    - fetch_user
-    - upload_file
+  - post_chat
+  - delete_chat
+  - post_note
+    - 今後のノート投稿はこちらを使用してください
+  - delete_note
+  - get_instance
+  - fetch_instance
+  - get_user
+  - fetch_user
+  - upload_file
 - `rich` を使ったデバッグ機能を追加しました
 - `file_upload` 関数を追加しました
 - `run` メソッドに `debug` 引数を追加しました
@@ -246,11 +253,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - api 周りでのエラー出力が分かりやすくなりました
 - ~~今までの `Note` クラスに当たるものを `NoteContent` に変更し別途 `Note` クラスを作成させるようにしました~~
-    - ~~これは不要なデータなどを生成しないようにすることが目的です。~~
+  - ~~これは不要なデータなどを生成しないようにすることが目的です。~~
 - 部分的に Pydantic を廃止
-    - 素直に使わないほうが部分的に楽だから
+  - 素直に使わないほうが部分的に楽だから
 - `Drive` クラスの `upload` メソッドで例外 `InvalidParameters` を発生させるようにしました
-    - これは`to_file`, `to_url` の両方がないと変数が定義されず、`Drive`クラスの生成に失敗する可能性があるからです。
+  - これは`to_file`, `to_url` の両方がないと変数が定義されず、`Drive`クラスの生成に失敗する可能性があるからです。
 - `get_user` メソッドが 非同期になりました。
 - 内部変更: `utils.py` の一部を Cython を用いたものに変更
 - 内部変更: `DriveAction` を廃止し, `file_upload` を使用するように
@@ -268,8 +275,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - **破壊的変更**: `Reaction` クラスと `ReactionContent` を結合させました
 - **破壊的変更**: `Chat` クラスと `ChatContent` を結合させました
 - **破壊的変更**: `Drive` クラスの `upload` メソッドで使用できる引数名を変更、キーワード引数を強制するようにしました。
-    - 引数名の変更は次の通りです `url` => `to_url`, `path` => `to_file`
-    - 強制されるキーワード引数は次の通りです `force`, `is_sensitive`
+  - 引数名の変更は次の通りです `url` => `to_url`, `path` => `to_file`
+  - 強制されるキーワード引数は次の通りです `force`, `is_sensitive`
 
 ### Fixed
 
@@ -280,21 +287,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Removed
 
 - `Router` クラスから以下のメソッドを削除しました
-    - main_channel
-    - home_time_line
-    - local_time_line
-    - global_time_line
+  - main_channel
+  - home_time_line
+  - local_time_line
+  - global_time_line
 - クラスの削除について
-    - `ChatContent`
-    - `ReactionContent`
-    - `NoteContent`
-    - `UserActions`
-    - `UserProfile`
-        - `UserProfile`にあったものは `User` に統合され、詳細な情報は `User` クラスの details オブジェクト(`UserDetails`) から取得可能です
+  - `ChatContent`
+  - `ReactionContent`
+  - `NoteContent`
+  - `UserActions`
+  - `UserProfile`
+    - `UserProfile`にあったものは `User` に統合され、詳細な情報は `User` クラスの details オブジェクト(`UserDetails`) から取得可能です
 - **破壊的変更**: `WebSocket` クラスを削除しました
-    - 今後は aiohttp の `ws_connect` メソッドを使用します
+  - 今後は aiohttp の `ws_connect` メソッドを使用します
 - **破壊的変更**: `requests` ライブラリを削除しました
-    - 今後は aiohttp の `request` メソッドを使用します
+  - 今後は aiohttp の `request` メソッドを使用します
 
 ## [v0.2.5] 2021-10-07
 
@@ -314,7 +321,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - **破壊的変更**: `commandFrameWork` を使用しない場合の bot モジュールの名前を client に変更しました
-    - 主にこれは Discord.py に近づけるためと `commandFrameWork` の bot モジュールとの差別化を目的としています
+  - 主にこれは Discord.py に近づけるためと `commandFrameWork` の bot モジュールとの差別化を目的としています
 - `on_mention` イベントの `.text` に自分自身のメンションを含まないように、必要な場合は `content` をご利用ください
 - デフォルトで接続するチャンネルを `globalTimeline` から `main` に変更しました。グローバルタイムラインを見る場合は `Router` をご利用ください
 - `add_poll` の引数位置が変更されています。ご注意ください
@@ -456,13 +463,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Added Each event method.
 
 [v0.2.5]: https://github.com/yupix/mi.py/compare/v0.1.0-5...v0.2.5
-
 [v0.1.5]: https://github.com/yupix/mi.py/compare/v0.1.0-1a...v0.1.0-5
-
 [v0.1.0-1a]: https://github.com/yupix/mi.py/compare/v0.1.0a...v0.1.0-1a
-
 [v0.1.0a]: https://github.com/yupix/mi.py/compare/v0.0.1a...v0.1.0a
-
 [v0.0.1a]: https://github.com/yupix/Mi.py/releases
-
 [unreleased]: https://github.com/yupix/mi.py/compare/master...HEAD

README-ja.md

@@ -23,7 +23,7 @@ Mi.py は[Discord.py](https://github.com/Rapptz/discord.py)
 
 ## 注意点
 
-1. グローバルタイムラインに接続したりする際に使う以下の様なコードがあるとホームタイムラインとグローバルタイムラインの 2 つを受信したことになり on_message が 2 回動作します。 
+1. グローバルタイムラインに接続したりする際に使う以下の様なコードがあるとホームタイムラインとグローバルタイムラインの 2 つを受信したことになり on_message が 2 回動作します。
    これは接続するチャンネルを増やすごとに増えていく形になります
 
 ```python
@@ -72,6 +72,11 @@ await Router(ws).connect_channel(['home', 'global'])
 
 最後にこのプロジェクトを作るきっかけになり、一部のコードを使用させていただいている Discord.py が Archived になりました。 作者である Danny さんや全てのコラボレーターに最大限の感謝申し上げます。
 
+## Mi.pyを使って作成されたプロジェクト
+
+- [Misskey Ebooks Bot](https://github.com/fotoente/MIsskey-ebooks-bot)
+- [Misskey Bot CeilingFox](https://github.com/fotoente/MIsskey-ebooks-bot)
+
 # LICENSE
 
 [Mi.py](https://github.com/yupix/Mi.py/blob/master/LICENSE.md)  

README.md

@@ -26,7 +26,7 @@ see [Documentation](https://yupix.github.io/Mi.py/en/).
 ## warning
 
 1. If you connect to the home timeline while connected to the global timeline, the `on_message` event will work twice for one
-message, because the same message is received on two channels. This is not a bug, but normal behavior.
+   message, because the same message is received on two channels. This is not a bug, but normal behavior.
 
 ```python
 await Router(ws).connect_channel(['home', 'global'])
@@ -76,6 +76,11 @@ These are the people who contributed to the development
 Finally, Discord.py, which inspired me to create this project and for which I use some of the code, is now Archived. Many
 thanks to Danny and all the collaborators.
 
+### Projects that use Mi.py
+
+- [Misskey Ebooks Bot](https://github.com/fotoente/MIsskey-ebooks-bot)
+- [Misskey Bot CeilingFox](https://github.com/fotoente/MIsskey-ebooks-bot)
+
 # LICENSE
 
 [Mi.py](https://github.com/yupix/Mi.py/blob/master/LICENSE.md)  

mi/__init__.py

@@ -4,7 +4,7 @@
 __copyright__ = "Copyright 2021-present yupix"
 __author_email__ = "[email protected]"
 __url__ = "https://github.com/yupix/Mi.py"
-__version__ = "3.2.1"
+__version__ = "3.3.0"
 
 __path__ = __import__("pkgutil").extend_path(__path__, __name__)
 

mi/api/drive.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 import asyncio
-from typing import Optional, TYPE_CHECKING
+from typing import List, Optional, TYPE_CHECKING
 
 from mi.drive import File, Folder
+from mi.exception import InvalidParameters
 from mi.http import HTTPClient, Route
 from mi.models.drive import RawFile, RawFolder
 from mi.utils import remove_dict_empty
@@ -63,6 +64,16 @@ async def delete(self, folder_id: Optional[str] = None) -> bool:
         data = {'folderId': folder_id}
         return bool(await self.__http.request(Route('POST', '/api/drive/folders/delete'), json=data, lower=True, auth=True))
 
+    async def get_files(self, limit: int = 10, since_id: Optional[str] = None, until_id: Optional[str] = None, folder_id: Optional[str] = None, file_type: Optional[str] = None) -> List[File]:
+
+        if limit >= 100:
+            raise InvalidParameters('limit must be less than 100')
+
+        folder_id = folder_id or self.__folder_id
+        data = {'limit': limit, 'sinceId': since_id, 'untilId': until_id, 'folderId': folder_id, 'Type': file_type}
+        res = await self.__http.request(Route('POST', '/api/drive/files'), json=data, auth=True, lower=True)
+        return [File(RawFile(i), state=self.__state) for i in res]
+
 
 class DriveManager:
     def __init__(self, __state: 'ConnectionState', http: HTTPClient, loop: asyncio.AbstractEventLoop):
@@ -71,7 +82,7 @@ def __init__(self, __state: 'ConnectionState', http: HTTPClient, loop: asyncio.A
         self.__loop = loop
 
     async def get_folders(self, limit: int = 100, since_id: Optional[str] = None, until_id: Optional[str] = None,
-                          folder_id: Optional[str] = None):
+                          folder_id: Optional[str] = None) -> List[Folder]:
         data = {
             'limit': limit,
             'sinceId': since_id,

setup.py

@@ -38,7 +38,7 @@
 
 setup(
     name="mi.py",
-    version="3.2.1",
+    version="3.3.0",
     install_requires=["emoji", 'aiocache', 'aiohttp'],
     url="https://github.com/yupix/mi.py",
     author="yupix",