satori-python-client 0.18.1__tar.gz → 1.3.0__tar.gz

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/.mina/client.toml

@@ -1,6 +1,6 @@
 includes = ["src/satori/client"]
 raw-dependencies = [
-    "satori-python-core >= 0.18.0",
+    "satori-python-core<1.4.0,>= 1.3.0",
     "graia-amnesia >= 0.11.0",
 ]
 

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satori-python-client
-Version: 0.18.1
+Version: 1.3.0
 Summary: Satori Protocol SDK for python, specify client part
 Home-page: https://github.com/RF-Tar-Railt/satori-python
 Author-Email: RF-Tar-Railt <rf_tar_railt@qq.com>
@@ -19,7 +19,7 @@ Project-URL: Repository, https://github.com/RF-Tar-Railt/satori-python
 Requires-Python: <4.0,>=3.10
 Requires-Dist: aiohttp>=3.9.3
 Requires-Dist: launart>=0.8.2
-Requires-Dist: satori-python-core>=0.18.0
+Requires-Dist: satori-python-core<1.4.0,>=1.3.0
 Requires-Dist: graia-amnesia>=0.11.0
 Description-Content-Type: text/markdown
 
@@ -73,13 +73,13 @@ pip install satori-python-server
 
 ### 官方适配器
 
-| 适配器        | 安装                                           | 路径                                                                 |
-|------------|----------------------------------------------|--------------------------------------------------------------------|
-| Satori     | `pip install satori-python-adapter-satori`   | satori.adapters.satori                                             |
-| OneBot V11 | `pip install satori-python-adapter-onebot11` | satori.adapters.onebot11.forward, satori.adapters.onebot11.reverse |
-| Console    | `pip install satori-python-adapter-console`  | satori.adapters.console                                            |
-| Milky      | `pip install satori-python-adapter-milky`    | satori.adapters.milky.main, satori.adapters.milky.webhook          |
-| QQ         | `pip install satori-python-adapter-qq`       | satori.adapters.qq.main, satori.adapters.qq.websocket              |
+| 适配器        | 安装                                           | 路径                                                                                   |
+|------------|----------------------------------------------|--------------------------------------------------------------------------------------|
+| Satori     | `pip install satori-python-adapter-satori`   | satori.adapters.satori                                                               |
+| OneBot V11 | `pip install satori-python-adapter-onebot11` | satori.adapters.onebot11.forward, satori.adapters.onebot11.reverse                   |
+| Console    | `pip install satori-python-adapter-console`  | satori.adapters.console                                                              |
+| Milky      | `pip install satori-python-adapter-milky`    | satori.adapters.milky.main, satori.adapters.milky.webhook, satori.adapters.milky.sse |
+| QQ         | `pip install satori-python-adapter-qq`       | satori.adapters.qq.main, satori.adapters.qq.websocket                                |
 
 ### 社区适配器
 

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/README.md

@@ -48,13 +48,13 @@ pip install satori-python-server
 
 ### 官方适配器
 
-| 适配器        | 安装                                           | 路径                                                                 |
-|------------|----------------------------------------------|--------------------------------------------------------------------|
-| Satori     | `pip install satori-python-adapter-satori`   | satori.adapters.satori                                             |
-| OneBot V11 | `pip install satori-python-adapter-onebot11` | satori.adapters.onebot11.forward, satori.adapters.onebot11.reverse |
-| Console    | `pip install satori-python-adapter-console`  | satori.adapters.console                                            |
-| Milky      | `pip install satori-python-adapter-milky`    | satori.adapters.milky.main, satori.adapters.milky.webhook          |
-| QQ         | `pip install satori-python-adapter-qq`       | satori.adapters.qq.main, satori.adapters.qq.websocket              |
+| 适配器        | 安装                                           | 路径                                                                                   |
+|------------|----------------------------------------------|--------------------------------------------------------------------------------------|
+| Satori     | `pip install satori-python-adapter-satori`   | satori.adapters.satori                                                               |
+| OneBot V11 | `pip install satori-python-adapter-onebot11` | satori.adapters.onebot11.forward, satori.adapters.onebot11.reverse                   |
+| Console    | `pip install satori-python-adapter-console`  | satori.adapters.console                                                              |
+| Milky      | `pip install satori-python-adapter-milky`    | satori.adapters.milky.main, satori.adapters.milky.webhook, satori.adapters.milky.sse |
+| QQ         | `pip install satori-python-adapter-qq`       | satori.adapters.qq.main, satori.adapters.qq.websocket                                |
 
 ### 社区适配器
 

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 dependencies = [
     "aiohttp>=3.9.3",
     "launart>=0.8.2",
-    "satori-python-core >= 0.18.0",
+    "satori-python-core<1.4.0,>= 1.3.0",
     "graia-amnesia >= 0.11.0",
 ]
 description = "Satori Protocol SDK for python, specify client part"
@@ -24,7 +24,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Operating System :: OS Independent",
 ]
-version = "0.18.1"
+version = "1.3.0"
 
 [project.license]
 text = "MIT"

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/src/satori/client/__init__.py

@@ -152,6 +152,15 @@ class App(Service):
         Callable[[Account, events.GuildRoleEvent], Awaitable[Any]],
     ]: ...
 
+    @overload
+    def register_on(
+        self,
+        event_type: Literal[EventType.GUILD_EMOJI_ADDED, EventType.GUILD_EMOJI_REMOVED, EventType.GUILD_EMOJI_UPDATED],
+    ) -> Callable[
+        [Callable[[Account, events.GuildEmojiEvent], Awaitable[Any]]],
+        Callable[[Account, events.GuildEmojiEvent], Awaitable[Any]],
+    ]: ...
+
     @overload
     def register_on(
         self, event_type: Literal[EventType.LOGIN_ADDED, EventType.LOGIN_REMOVED, EventType.LOGIN_UPDATED]

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/src/satori/client/account.py

@@ -20,13 +20,14 @@ class ApiInfo:
     port: int = 5140
     path: str = ""
     token: str | None = None
+    secure: bool = False
     timeout: float | None = None
     api_base: URL = field(init=False)
 
     def __post_init__(self):
         if self.path and not self.path.startswith("/"):
             self.path = f"/{self.path}"
-        self.api_base = URL(f"http://{self.host}:{self.port}{self.path}") / "v1"
+        self.api_base = URL(f"http{'s' if self.secure else ''}://{self.host}:{self.port}{self.path}") / "v1"
 
 
 class Account(Generic[TP]):

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/src/satori/client/account.pyi

@@ -10,6 +10,7 @@ from satori.model import (
     Channel,
     Direction,
     Event,
+    Friend,
     Guild,
     IterablePageResult,
     Login,
@@ -40,6 +41,7 @@ class ApiInfo(Api):
         port: int = 5140,
         path: str = "",
         token: str | None = None,
+        secure: bool = False,
         timeout: float | None = None,
     ):
         self.api_base: URL = ...
@@ -450,19 +452,21 @@ class Account(Generic[TP]):
             None: 该方法无返回值
         """
 
-    async def reaction_create(self, channel_id: str, message_id: str, emoji: str) -> None:
+    async def reaction_create(self, channel_id: str, message_id: str, emoji_id: str) -> None:
         """向特定消息添加表态。
 
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str): 表态名称
+            emoji_id (str): 表情 ID
 
         Returns:
             None: 该方法无返回值
         """
 
-    async def reaction_delete(self, channel_id: str, message_id: str, emoji: str, user_id: str | None = None) -> None:
+    async def reaction_delete(
+        self, channel_id: str, message_id: str, emoji_id: str, user_id: str | None = None
+    ) -> None:
         """从特定消息删除某个用户添加的特定表态。
 
         如果没有传入用户 ID 则表示删除自己的表态。
@@ -470,14 +474,14 @@ class Account(Generic[TP]):
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str): 表态名称
+            emoji_id (str): 表情 ID
             user_id (str | None, optional): 用户 ID，默认为 None
 
         Returns:
             None: 该方法无返回值
         """
 
-    async def reaction_clear(self, channel_id: str, message_id: str, emoji: str | None = None) -> None:
+    async def reaction_clear(self, channel_id: str, message_id: str, emoji_id: str | None = None) -> None:
         """从特定消息清除某个特定表态。
 
         如果没有传入表态名称则表示清除所有表态。
@@ -485,21 +489,21 @@ class Account(Generic[TP]):
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str | None, optional): 表态名称，默认为 None
+            emoji_id (str | None, optional): 表情 ID，默认为 None
 
         Returns:
             None: 该方法无返回值
         """
 
     def reaction_list(
-        self, channel_id: str, message_id: str, emoji: str, next_token: str | None = None
+        self, channel_id: str, message_id: str, emoji_id: str, next_token: str | None = None
     ) -> IterablePageResult[User]:
         """获取添加特定消息的特定表态的用户列表。返回一个 User 的分页列表。
 
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str): 表态名称
+            emoji_id (str): 表情 ID
             next_token (str | None, optional): 分页令牌，默认为空
 
         Returns:
@@ -513,24 +517,24 @@ class Account(Generic[TP]):
             Login: `Login` 对象
         """
 
-    async def user_get(self, user_id: str) -> User:
-        """获取用户信息。返回一个 `User` 对象。
+    def friend_list(self, next_token: str | None = None) -> IterablePageResult[Friend]:
+        """获取好友列表。返回一个 Friend 的分页列表。
 
         Args:
-            user_id (str): 用户 ID
+            next_token (str | None, optional): 分页令牌，默认为空
 
         Returns:
-            User: `User` 对象
+            IterablePageResult[Friend]: `Friend` 的分页列表
         """
 
-    def friend_list(self, next_token: str | None = None) -> IterablePageResult[User]:
-        """获取好友列表。返回一个 User 的分页列表。
+    async def friend_delete(self, user_id: str) -> None:
+        """删除好友。
 
         Args:
-            next_token (str | None, optional): 分页令牌，默认为空
+            user_id (str): 用户 ID
 
         Returns:
-            IterablePageResult[User]: `User` 的分页列表
+            None: 该方法无返回值
         """
 
     async def friend_approve(self, request_id: str, approve: bool, comment: str) -> None:
@@ -545,6 +549,16 @@ class Account(Generic[TP]):
             None: 该方法无返回值
         """
 
+    async def user_get(self, user_id: str) -> User:
+        """获取用户信息。返回一个 `User` 对象。
+
+        Args:
+            user_id (str): 用户 ID
+
+        Returns:
+            User: `User` 对象
+        """
+
     async def internal(self, action: str, method: str = "POST", **kwargs) -> Any:
         """内部接口调用。
 

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/src/satori/client/config.py

@@ -23,6 +23,7 @@ class WebsocketsInfo(Config):
     port: int = 5140
     path: str = ""
     token: str | None = None
+    secure: bool = False
     timeout: float | None = None
     identity: str = None  # type: ignore
     api_base: URL = None  # type: ignore
@@ -31,11 +32,11 @@ class WebsocketsInfo(Config):
         if self.path and not self.path.startswith("/"):
             self.path = f"/{self.path}"
         self.identity = f"{self.host}:{self.port}"
-        self.api_base = URL(f"http://{self.host}:{self.port}{self.path}") / "v1"
+        self.api_base = URL(f"http{'s' if self.secure else ''}://{self.host}:{self.port}{self.path}") / "v1"
 
     @property
     def ws_base(self):
-        return URL(f"ws://{self.host}:{self.port}{self.path}") / "v1"
+        return URL(f"ws{'s' if self.secure else ''}://{self.host}:{self.port}{self.path}") / "v1"
 
 
 @dataclass
@@ -44,6 +45,7 @@ class WebhookInfo(Config):
     port: int = 8080
     path: str = "v1/events"
     token: str | None = None
+    secure: bool = False
     server_host: str = "localhost"
     server_port: int = 5140
     server_path: str = ""
@@ -57,4 +59,6 @@ class WebhookInfo(Config):
         if self.server_path and not self.server_path.startswith("/"):
             self.server_path = f"/{self.server_path}"
         self.identity = f"{self.host}:{self.port}{self.path}"
-        self.api_base = URL(f"http://{self.server_host}:{self.server_port}{self.server_path}") / "v1"
+        self.api_base = (
+            URL(f"http{'s' if self.secure else ''}://{self.server_host}:{self.server_port}{self.server_path}") / "v1"
+        )

{satori_python_client-0.18.1 → satori_python_client-1.3.0}/src/satori/client/protocol.py

@@ -29,6 +29,7 @@ from satori.model import (
     User,
 )
 
+from .. import Friend
 from .network.util import validate_response
 
 if TYPE_CHECKING:
@@ -632,23 +633,25 @@ class ApiProtocol:
             {"guild_id": guild_id, "role_id": role_id},
         )
 
-    async def reaction_create(self, channel_id: str, message_id: str, emoji: str) -> None:
+    async def reaction_create(self, channel_id: str, message_id: str, emoji_id: str) -> None:
         """向特定消息添加表态。
 
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str): 表态名称
+            emoji_id (str): 表情 ID
 
         Returns:
             None: 该方法无返回值
         """
         await self.call_api(
             Api.REACTION_CREATE,
-            {"channel_id": channel_id, "message_id": message_id, "emoji": emoji},
+            {"channel_id": channel_id, "message_id": message_id, "emoji_id": emoji_id},
         )
 
-    async def reaction_delete(self, channel_id: str, message_id: str, emoji: str, user_id: str | None = None) -> None:
+    async def reaction_delete(
+        self, channel_id: str, message_id: str, emoji_id: str, user_id: str | None = None
+    ) -> None:
         """从特定消息删除某个用户添加的特定表态。
 
         如果没有传入用户 ID 则表示删除自己的表态。
@@ -656,13 +659,13 @@ class ApiProtocol:
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str): 表态名称
+            emoji_id (str): 表情 ID
             user_id (str | None, optional): 用户 ID，默认为 None
 
         Returns:
             None: 该方法无返回值
         """
-        data = {"channel_id": channel_id, "message_id": message_id, "emoji": emoji}
+        data = {"channel_id": channel_id, "message_id": message_id, "emoji_id": emoji_id}
         if user_id is not None:
             data["user_id"] = user_id
         await self.call_api(
@@ -670,7 +673,7 @@ class ApiProtocol:
             data,
         )
 
-    async def reaction_clear(self, channel_id: str, message_id: str, emoji: str | None = None) -> None:
+    async def reaction_clear(self, channel_id: str, message_id: str, emoji_id: str | None = None) -> None:
         """从特定消息清除某个特定表态。
 
         如果没有传入表态名称则表示清除所有表态。
@@ -678,28 +681,28 @@ class ApiProtocol:
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str | None, optional): 表态名称，默认为 None
+            emoji_id (str | None, optional): 表情 ID，默认为 None
 
         Returns:
             None: 该方法无返回值
         """
         data = {"channel_id": channel_id, "message_id": message_id}
-        if emoji is not None:
-            data["emoji"] = emoji
+        if emoji_id is not None:
+            data["emoji_id"] = emoji_id
         await self.call_api(
             Api.REACTION_CLEAR,
             data,
         )
 
     def reaction_list(
-        self, channel_id: str, message_id: str, emoji: str, next_token: str | None = None
+        self, channel_id: str, message_id: str, emoji_id: str, next_token: str | None = None
     ) -> IterablePageResult[User]:
         """获取添加特定消息的特定表态的用户列表。返回一个 User 的分页列表。
 
         Args:
             channel_id (str): 频道 ID
             message_id (str): 消息 ID
-            emoji (str): 表态名称
+            emoji_id (str): 表情 ID
             next_token (str | None, optional): 分页令牌，默认为空
 
         Returns:
@@ -712,7 +715,7 @@ class ApiProtocol:
                 {
                     "channel_id": channel_id,
                     "message_id": message_id,
-                    "emoji": emoji,
+                    "emoji_id": emoji_id,
                     "next": token,
                 },
             )
@@ -729,34 +732,33 @@ class ApiProtocol:
         res = await self.call_api(Api.LOGIN_GET, {})
         return Login.parse(res)
 
-    async def user_get(self, user_id: str) -> User:
-        """获取用户信息。返回一个 `User` 对象。
-
-        Args:
-            user_id (str): 用户 ID
-
-        Returns:
-            User: `User` 对象
-        """
-        res = await self.call_api(Api.USER_GET, {"user_id": user_id})
-        return User.parse(res)
-
-    def friend_list(self, next_token: str | None = None) -> IterablePageResult[User]:
+    def friend_list(self, next_token: str | None = None) -> IterablePageResult[Friend]:
         """获取好友列表。返回一个 User 的分页列表。
 
         Args:
             next_token (str | None, optional): 分页令牌，默认为空
 
         Returns:
-            IterablePageResult[User]: `User` 的分页列表
+            IterablePageResult[Friend]: `Friend` 的分页列表
         """
 
         async def _(token: str | None):
             res = await self.call_api(Api.FRIEND_LIST, {"next": token})
-            return PageResult.parse(res, User.parse)
+            return PageResult.parse(res, Friend.parse)
 
         return IterablePageResult(_, next_token)
 
+    async def friend_delete(self, user_id: str) -> None:
+        """删除好友。
+
+        Args:
+            user_id (str): 用户 ID
+
+        Returns:
+            None: 该方法无返回值
+        """
+        await self.call_api(Api.FRIEND_DELETE, {"user_id": user_id})
+
     async def friend_approve(self, request_id: str, approve: bool, comment: str) -> None:
         """处理好友申请。
 
@@ -773,6 +775,18 @@ class ApiProtocol:
             {"message_id": request_id, "approve": approve, "comment": comment},
         )
 
+    async def user_get(self, user_id: str) -> User:
+        """获取用户信息。返回一个 `User` 对象。
+
+        Args:
+            user_id (str): 用户 ID
+
+        Returns:
+            User: `User` 对象
+        """
+        res = await self.call_api(Api.USER_GET, {"user_id": user_id})
+        return User.parse(res)
+
     async def internal(self, action: str, method: str = "POST", **kwargs) -> Any:
         """内部接口调用。