Merge branch 'release/v3.2.0'

Author: yupix

CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v3.2.0] 2022-01-24
+
+### Added
+
+- type hint
+
+### Fixed
+
+- 以下のNoteクラスのメソッドでnote_idが必須になっていたのを修正
+    - `add_clips`
+    - `create_renote`
+    - `create_quote`
+    - `get_note`
+    - `get_replies`
+    - `get_reaction`
+    - `delete`
+- 以下の引数が正常な動作になりました
+    - `noExtractMentions`
+    - `noExtractHashtags`
+    - `noExtractEmojis`
+
 ## [v3.1.0] 2022-01-23
 
 ### Added

docs/mi.rst

@@ -72,21 +72,13 @@ User
    :members:
 
 Chat
-~~~~~~~~~~~~
+~~~~
 
 .. attributetable::  Chat
 
 .. autoclass:: Chat()
    :members:
 
-Drive
-~~~~~
-
-.. attributetable:: Drive
-
-.. autoclass:: Drive()
-   :members:
-
 Emoji
 ~~~~~
 
@@ -135,9 +127,9 @@ Properties
 File
 ~~~~
 
-.. attributetable:: Header
+.. attributetable:: File
 
-.. autoclass:: Header()
+.. autoclass:: File()
    :members:
 
 Reaction

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.1.0"
+__version__ = "3.2.0"
 
 __path__ = __import__("pkgutil").extend_path(__path__, __name__)
 

mi/actions/note.py

@@ -6,10 +6,10 @@
 from mi.api.favorite import FavoriteManager
 from mi.api.reaction import ReactionManager
 from mi.exception import ContentRequired
+from mi.http import HTTPClient, Route
 from mi.models.note import RawNote
-from mi.note import Note, Poll
+from mi.note import Note, NoteReaction, Poll
 from mi.utils import check_multi_arg, remove_dict_empty
-from mi.http import HTTPClient, Route
 
 if TYPE_CHECKING:
     from mi.state import ConnectionState
@@ -23,10 +23,13 @@ def __init__(self, state: 'ConnectionState', http: HTTPClient, loop: asyncio.Abs
         self.__state = state
         self.__http = http
         self.__loop = loop
+        self.__note_id: Optional[str] = note_id
         self.favorite = FavoriteManager(state, http, loop, note_id=note_id)
         self.reaction = ReactionManager(state, http, loop, note_id=note_id)
 
-    async def add_clips(self, clip_id: str, note_id: str) -> bool:
+    async def add_clips(self, clip_id: str, note_id: Optional[str] = None) -> bool:
+        note_id = note_id or self.__note_id
+
         data = {'noteId': note_id, 'clipId': clip_id}
         return bool(await self.__http.request(Route('POST', '/api/clips/add-note'), json=data, auth=True))
 
@@ -96,9 +99,9 @@ async def send(self,
             "text": content,
             "cw": cw,
             "localOnly": local_only,
-            "noExtractMentions": extract_mentions,
-            "noExtractHashtags": extract_hashtags,
-            "noExtractEmojis": extract_emojis,
+            "noExtractMentions": not extract_mentions,
+            "noExtractHashtags": not extract_hashtags,
+            "noExtractEmojis": not extract_emojis,
             "replyId": reply_id,
             "renoteId": renote_id,
             "channelId": channel_id
@@ -122,39 +125,84 @@ async def send(self,
         return Note(RawNote(res["created_note"]), state=self.__state)
 
     async def delete(self, note_id: Optional[str] = None):
+        note_id = note_id or self.__note_id
+
         data = {"noteId": note_id}
         res = await self.__http.request(Route('POST', '/api/notes/delete'), json=data, auth=True)
         return bool(res)
 
-    async def create_renote(self, note_id: str) -> Note:
+    async def create_renote(self, note_id: Optional[str] = None) -> Note:
+        note_id = note_id or self.__note_id
         return await self.send(renote_id=note_id)
 
-    async def create_quote(self, note_id: str,
-                           content: Optional[str] = None,
-                           visibility: str = 'public',
-                           visible_user_ids: Optional[List[str]] = None,
-                           cw: Optional[str] = None,
-                           local_only: bool = False,
-                           extract_mentions: bool = True,
-                           extract_hashtags: bool = True,
-                           extract_emojis: bool = True,
-                           file_ids=None,
-                           poll: Optional[Poll] = None) -> Note:
+    async def create_quote(
+            self,
+            content: Optional[str] = None,
+            visibility: str = 'public',
+            visible_user_ids: Optional[List[str]] = None,
+            cw: Optional[str] = None,
+            local_only: bool = False,
+            extract_mentions: bool = True,
+            extract_hashtags: bool = True,
+            extract_emojis: bool = True,
+            file_ids: Optional[List[str]] = None,
+            poll: Optional[Poll] = None,
+            note_id: Optional[str] = None,
+    ) -> Note:
+        """
+        Create a note quote.
+
+        Parameters
+        ----------
+        content: Optional[str], default=None
+            text
+        visibility: str, default='public'
+            Disclosure range
+        visible_user_ids: Optional[List[str]], default=None
+            List of users to be published
+        cw: Optional[str], default=None
+            Text to be displayed when warning is given
+        local_only: bool, default=False
+            Whether to show only locally or not
+        extract_mentions: bool, default=True
+            Whether to expand the mention
+        extract_hashtags: bool, default=True
+            Whether to expand the hashtag
+        extract_emojis: bool, default=True
+            Whether to expand the emojis
+        file_ids: Optional[List[str]], default=None
+            The ID list of files to be attached
+        poll: Optional[Poll], default=None
+            Questionnaire to be created
+        note_id: Optional[str], default=None
+            Note IDs to target for renote and citations
+        """
+
+        note_id = note_id or self.__note_id
+
         return await self.send(content=content, visibility=visibility, visible_user_ids=visible_user_ids, cw=cw,
                                local_only=local_only, extract_mentions=extract_mentions,
                                extract_hashtags=extract_hashtags,
                                extract_emojis=extract_emojis, renote_id=note_id, file_ids=file_ids, poll=poll)
 
-    async def get_note(self, note_id) -> Note:
+    async def get_note(self, note_id: Optional[str] = None) -> Note:
+        note_id = note_id or self.__note_id
         res = await self.__http.request(Route('POST', '/api/notes/show'), json={"noteId": note_id}, auth=True, lower=True)
         return Note(RawNote(res), state=self.__state)
 
-    async def get_replies(self, note_id: str, since_id: Optional[str] = None, until_id: Optional[str] = None,
-                          limit: int = 10, ) -> List[Note]:
+    async def get_replies(
+            self,
+            since_id: Optional[str] = None,
+            until_id: Optional[str] = None,
+            limit: int = 10,
+            note_id: Optional[str] = None
+    ) -> List[Note]:
+        note_id = note_id or self.__note_id
         res = await self.__http.request(Route('POST', '/api/notes/replies'),
                                         json={"noteId": note_id, "sinceId": since_id, "untilId": until_id, "limit": limit},
                                         auth=True, lower=True)
         return [Note(RawNote(i), state=self.__state) for i in res]
 
-    def get_reaction(self, note_id: str, reaction: str):
-        return ReactionManager(self.__state, self.__http, self.__loop, note_id=note_id)
+    async def get_reaction(self, reaction: str, note_id: Optional[str] = None) -> List[NoteReaction]:
+        note_id = note_id or self.__note_id
+        return await ReactionManager(self.__state, self.__http, self.__loop, note_id=note_id).get_reaction(reaction)

mi/api/reaction.py

@@ -49,7 +49,7 @@ async def remove(self, note_id: Optional[str] = None) -> bool:
         data = remove_dict_empty({"noteId": note_id})
         return bool(await self.http.request(Route('POST', '/api/notes/reactions/delete'), json=data, auth=True, lower=True))
 
-    async def get_reaction(self, reaction: str, note_id: Optional[str] = None, *, limit: int = 11):
+    async def get_reaction(self, reaction: str, note_id: Optional[str] = None, *, limit: int = 11) -> List[NoteReaction]:
         note_id = note_id or self.__note_id
         data = remove_dict_empty({"noteId": note_id, 'limit': limit, 'type': reaction})
         res = await self.http.request(Route('POST', '/api/notes/reactions'), json=data, auth=True, lower=True)

mi/models/note.py

@@ -52,22 +52,22 @@ def __init__(self, data: Note):
         self.cw: Optional[str] = data.get("cw")
         self.renote: Optional[RawRenote] = RawRenote(data['renote']) if data.get('renote') else None
         self.visibility: Optional[str] = data.get("visibility")  # This may be an optional
-        self.renote_count: int = data["renote_count"]
-        self.replies_count: int = data["replies_count"]
-        self.reactions: Dict[str, Any] = data["reactions"]
+        self.renote_count: Optional[int] = data.get("renote_count")  # TODO: Optionalかどうか
+        self.replies_count: Optional[int] = data.get("replies_count")  # TODO: Optionalかどうか
+        self.reactions: Optional[Dict[str, Any]] = data["reactions"]  # TODO: Optionalかどうか
         self.emojis: List[RawEmoji] = [RawEmoji(i) for i in data["emojis"]]
         self.file_ids: Optional[List[str]] = data["file_ids"]
         self.files: List[RawFile] = [RawFile(upper_to_lower(i)) for i in data["files"]]
         self.reply_id: Optional[str] = data["reply_id"]
         self.renote_id: Optional[str] = data["renote_id"]
         self.poll: Optional[RawPoll] = RawPoll(data["poll"]) if data.get("poll") else None
         self.visible_user_ids: Optional[List[str]] = data.get("visible_user_ids", [])
-        self.via_mobile: Optional[bool] = data.get("via_mobile", False)
+        self.via_mobile: bool = bool(data.get("via_mobile", False))
         self.local_only: bool = bool(data.get("local_only", False))
         self.extract_mentions: bool = bool(data.get("extract_mentions"))
         self.extract_hashtags: bool = bool(data.get("extract_hashtags"))
         self.extract_emojis: bool = bool(data.get("extract_emojis"))
-        self.preview: Optional[bool] = data.get("preview")
+        self.preview: bool = bool(data.get("preview"))
         self.media_ids: Optional[List[str]] = data.get("media_ids")
         self.field: Optional[dict] = {}
         self.tags: Optional[List[str]] = data.get("tags", [])