satori-python 0.16.7__tar.gz → 0.17.0__tar.gz

{satori_python-0.16.7 → satori_python-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satori-python
-Version: 0.16.7
+Version: 0.17.0
 Summary: Satori Protocol SDK for python
 Home-page: https://github.com/RF-Tar-Railt/satori-python
 Author-Email: RF-Tar-Railt <rf_tar_railt@qq.com>
@@ -16,16 +16,18 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Operating System :: OS Independent
 Project-URL: Homepage, https://github.com/RF-Tar-Railt/satori-python
 Project-URL: Repository, https://github.com/RF-Tar-Railt/satori-python
-Requires-Python: >=3.9
+Requires-Python: <4.0,>=3.10
 Requires-Dist: aiohttp>=3.9.3
 Requires-Dist: loguru>=0.7.2
 Requires-Dist: launart>=0.8.2
 Requires-Dist: typing-extensions>=4.7.0
-Requires-Dist: graia-amnesia>=0.9.0
+Requires-Dist: graia-amnesia[uvicorn]<0.12.0,>=0.11.0
 Requires-Dist: starlette[python-multipart]>=0.37.2
-Requires-Dist: uvicorn[standard]>=0.28.0
 Requires-Dist: yarl>=1.9.4
 Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: websockets>=15.0.1
+Requires-Dist: msgspec>=0.19.0; extra == "msgspec"
+Provides-Extra: msgspec
 Description-Content-Type: text/markdown
 
 # satori-python

{satori_python-0.16.7 → satori_python-0.17.0}/pyproject.toml

@@ -10,13 +10,13 @@ dependencies = [
     "loguru>=0.7.2",
     "launart>=0.8.2",
     "typing-extensions>=4.7.0",
-    "graia-amnesia>=0.9.0",
+    "graia-amnesia[uvicorn]<0.12.0,>=0.11.0",
     "starlette[python-multipart]>=0.37.2",
-    "uvicorn[standard]>=0.28.0",
     "yarl>=1.9.4",
     "python-multipart>=0.0.9",
+    "websockets>=15.0.1",
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10,<4.0"
 readme = "README.md"
 classifiers = [
     "Typing :: Typed",
@@ -29,7 +29,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Operating System :: OS Independent",
 ]
-version = "0.16.7"
+version = "0.17.0"
 
 [project.license]
 text = "MIT"
@@ -38,6 +38,11 @@ text = "MIT"
 homepage = "https://github.com/RF-Tar-Railt/satori-python"
 repository = "https://github.com/RF-Tar-Railt/satori-python"
 
+[project.optional-dependencies]
+msgspec = [
+    "msgspec>=0.19.0",
+]
+
 [build-system]
 requires = [
     "mina-build<0.6,>=0.5.1",
@@ -45,7 +50,7 @@ requires = [
 ]
 build-backend = "mina.backend"
 
-[tool.pdm.dev-dependencies]
+[dependency-groups]
 dev = [
     "isort>=5.13.2",
     "black>=24.4.0",
@@ -55,6 +60,7 @@ dev = [
     "mina-build<0.6,>=0.5.1",
     "pdm-mina>=0.3.2",
     "nonechat<0.7.0,>=0.6.0",
+    "uvicorn[standard]>=0.35.0",
 ]
 
 [tool.pdm.build]
@@ -77,21 +83,21 @@ source = "file"
 path = "src/satori/__init__.py"
 
 [tool.black]
-line-length = 110
+line-length = 120
 include = "\\.pyi?$"
 extend-exclude = ""
 
 [tool.isort]
 profile = "black"
-line_length = 110
+line_length = 120
 skip_gitignore = true
 extra_standard_library = [
     "typing_extensions",
 ]
 
 [tool.ruff]
-line-length = 110
-target-version = "py39"
+line-length = 120
+target-version = "py310"
 exclude = [
     "exam.py",
 ]
@@ -111,12 +117,12 @@ ignore = [
     "F403",
     "F405",
     "C901",
-    "UP037",
+    "UP038",
 ]
 
 [tool.pyright]
 pythonPlatform = "All"
-pythonVersion = "3.9"
+pythonVersion = "3.10"
 typeCheckingMode = "basic"
 reportShadowedImports = false
 disableBytesTypePromotions = true

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/__init__.py

@@ -23,6 +23,7 @@ from .element import Superscript as Superscript
 from .element import Text as Text
 from .element import Underline as Underline
 from .element import Video as Video
+from .element import register_element as register_element
 from .element import select as select
 from .element import transform as transform
 from .model import ArgvInteraction as ArgvInteraction
@@ -41,4 +42,4 @@ from .model import Role as Role
 from .model import Upload as Upload
 from .model import User as User
 
-__version__ = "0.16.7"
+__version__ = "0.17.0"

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/__init__.py

@@ -4,9 +4,9 @@ import asyncio
 import functools
 import signal
 import threading
-from collections.abc import Awaitable, Iterable
+from collections.abc import Awaitable, Callable, Iterable
 from functools import wraps
-from typing import TYPE_CHECKING, Any, Callable, Literal, TypeVar, overload
+from typing import TYPE_CHECKING, Any, Literal, TypeVar, overload
 
 from creart import it
 from graia.amnesia.builtins.aiohttp import AiohttpClientService
@@ -75,9 +75,7 @@ class App(Service):
     def register_config(cls, tc: type[TConfig], tn: type[BaseNetwork[TConfig]]):
         MAPPING[tc] = tn
 
-    def __init__(
-        self, *configs: Config, default_api_cls: type[ApiProtocol] = ApiProtocol, main_app: bool = True
-    ):
+    def __init__(self, *configs: Config, default_api_cls: type[ApiProtocol] = ApiProtocol, main_app: bool = True):
         global _app
 
         if _app is not None and main_app:
@@ -136,9 +134,7 @@ class App(Service):
     @overload
     def register_on(
         self,
-        event_type: Literal[
-            EventType.GUILD_ROLE_CREATED, EventType.GUILD_ROLE_DELETED, EventType.GUILD_ROLE_UPDATED
-        ],
+        event_type: Literal[EventType.GUILD_ROLE_CREATED, EventType.GUILD_ROLE_DELETED, EventType.GUILD_ROLE_UPDATED],
     ) -> Callable[
         [Callable[[Account, events.GuildRoleEvent], Awaitable[Any]]],
         Callable[[Account, events.GuildRoleEvent], Awaitable[Any]],
@@ -162,9 +158,7 @@ class App(Service):
     ]: ...
 
     @overload
-    def register_on(
-        self, event_type: Literal[EventType.REACTION_ADDED, EventType.REACTION_REMOVED]
-    ) -> Callable[
+    def register_on(self, event_type: Literal[EventType.REACTION_ADDED, EventType.REACTION_REMOVED]) -> Callable[
         [Callable[[Account, events.ReactionEvent], Awaitable[Any]]],
         Callable[[Account, events.ReactionEvent], Awaitable[Any]],
     ]: ...
@@ -190,14 +184,10 @@ class App(Service):
     @overload
     def register_on(
         self, event_type: str
-    ) -> Callable[
-        [Callable[[Account, Event], Awaitable[Any]]], Callable[[Account, Event], Awaitable[Any]]
-    ]: ...
+    ) -> Callable[[Callable[[Account, Event], Awaitable[Any]]], Callable[[Account, Event], Awaitable[Any]]]: ...
 
     def register_on(self, event_type: str | EventType):
-        def decorator(
-            func: Callable[[Account, Any], Awaitable[Any]], /
-        ) -> Callable[[Account, Any], Awaitable[Any]]:
+        def decorator(func: Callable[[Account, Any], Awaitable[Any]], /) -> Callable[[Account, Any], Awaitable[Any]]:
             @wraps(func)
             async def wrapper(account: Account, event: Event) -> Any:
                 if event.type == event_type:
@@ -216,8 +206,6 @@ class App(Service):
             await asyncio.gather(*(callback(account, state) for callback in self.lifecycle_callbacks))
 
     async def post(self, event: Event, conn: BaseNetwork):
-        if not self.event_callbacks:
-            return
         if event.type == EventType.LOGIN_ADDED:
             if TYPE_CHECKING:
                 assert isinstance(event, events.LoginEvent)
@@ -290,7 +278,8 @@ class App(Service):
                 return
             account = self.accounts[login_sn]
 
-        await asyncio.gather(*(callback(account, event) for callback in self.event_callbacks))
+        if self.event_callbacks:
+            await asyncio.gather(*(callback(account, event) for callback in self.event_callbacks))
 
         if event.type == EventType.LOGIN_REMOVED:
             logger.info(f"account removed: {account}")

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/account.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import asyncio
 from dataclasses import dataclass
-from typing import Generic, TypeVar
+from typing_extensions import Generic, TypeVar  # noqa: UP035
 
 from yarl import URL
 
@@ -10,8 +10,8 @@ from satori.model import Login
 
 from .protocol import ApiProtocol
 
-TP = TypeVar("TP", bound="ApiProtocol")
-TP1 = TypeVar("TP1", bound="ApiProtocol")
+TP = TypeVar("TP", bound="ApiProtocol", default=ApiProtocol)
+TP1 = TypeVar("TP1", bound="ApiProtocol", default=ApiProtocol)
 
 
 @dataclass
@@ -20,14 +20,12 @@ class ApiInfo:
     port: int = 5140
     path: str = ""
     token: str | None = None
+    timeout: float | None = None
 
     def __post_init__(self):
         if self.path and not self.path.startswith("/"):
             self.path = f"/{self.path}"
-
-    @property
-    def api_base(self):
-        return URL(f"http://{self.host}:{self.port}{self.path}") / "v1"
+        self.api_base = URL(f"http://{self.host}:{self.port}{self.path}") / "v1"
 
 
 class Account(Generic[TP]):
@@ -53,14 +51,12 @@ class Account(Generic[TP]):
     def self_id(self):
         return self.self_info.user.id
 
-    def custom(
-        self, config: ApiInfo | None = None, protocol_cls: type[TP1] = ApiProtocol, **kwargs
-    ) -> "Account[TP1]":
+    def custom(self, config: ApiInfo | None = None, protocol_cls: type[TP1] = ApiProtocol, **kwargs) -> Account[TP1]:
         return Account(
             self.self_info,
             config or (ApiInfo(**kwargs) if kwargs else self.config),
             self.proxy_urls,
-            protocol_cls,  # type: ignore
+            protocol_cls,
         )
 
     def ensure_url(self, url: str) -> URL:

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/account.pyi

@@ -1,7 +1,7 @@
 import asyncio
 from collections.abc import Iterable
-from typing import Any, Generic, Protocol, TypeVar, overload
-from typing_extensions import deprecated
+from typing import Any, Protocol, overload
+from typing_extensions import Generic, TypeVar, deprecated  # noqa: UP035
 
 from yarl import URL
 
@@ -26,18 +26,22 @@ from satori.model import (
 
 from .protocol import ApiProtocol
 
-TP = TypeVar("TP", bound="ApiProtocol")
-TP1 = TypeVar("TP1", bound="ApiProtocol")
+TP = TypeVar("TP", bound="ApiProtocol", default=ApiProtocol)
+TP1 = TypeVar("TP1", bound="ApiProtocol", default=ApiProtocol)
 
 class Api(Protocol):
     token: str | None = None
-
-    @property
-    def api_base(self) -> URL: ...
+    timeout: float | None = None
+    api_base: URL
 
 class ApiInfo(Api):
     def __init__(
-        self, host: str = "localhost", port: int = 5140, path: str = "", token: str | None = None
+        self,
+        host: str = "localhost",
+        port: int = 5140,
+        path: str = "",
+        token: str | None = None,
+        timeout: float | None = None,
     ): ...
 
 class Account(Generic[TP]):
@@ -453,9 +457,7 @@ class Account(Generic[TP]):
             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: str, user_id: str | None = None) -> None:
         """从特定消息删除某个用户添加的特定表态。
 
         如果没有传入用户 ID 则表示删除自己的表态。

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/config.py

@@ -1,5 +1,4 @@
 from dataclasses import dataclass
-from typing import Optional
 
 from yarl import URL
 
@@ -10,7 +9,7 @@ class Config:
         raise NotImplementedError
 
     @property
-    def token(self) -> Optional[str]:
+    def token(self) -> str | None:
         raise NotImplementedError
 
     @property
@@ -23,19 +22,16 @@ class WebsocketsInfo(Config):
     host: str = "localhost"
     port: int = 5140
     path: str = ""
-    token: Optional[str] = None
+    token: str | None = None
+    timeout: float | None = None
+    identity: str = None  # type: ignore
+    api_base: URL = None  # type: ignore
 
     def __post_init__(self):
         if self.path and not self.path.startswith("/"):
             self.path = f"/{self.path}"
-
-    @property
-    def identity(self):
-        return f"{self.host}:{self.port}"
-
-    @property
-    def api_base(self):
-        return URL(f"http://{self.host}:{self.port}{self.path}") / "v1"
+        self.identity = f"{self.host}:{self.port}"
+        self.api_base = URL(f"http://{self.host}:{self.port}{self.path}") / "v1"
 
     @property
     def ws_base(self):
@@ -47,21 +43,18 @@ class WebhookInfo(Config):
     host: str = "127.0.0.1"
     port: int = 8080
     path: str = "v1/events"
-    token: Optional[str] = None
+    token: str | None = None
     server_host: str = "localhost"
     server_port: int = 5140
     server_path: str = ""
+    timeout: float | None = None
+    identity: str = None  # type: ignore
+    api_base: URL = None  # type: ignore
 
     def __post_init__(self):
         if self.path and not self.path.startswith("/"):
             self.path = f"/{self.path}"
         if self.server_path and not self.server_path.startswith("/"):
             self.server_path = f"/{self.server_path}"
-
-    @property
-    def identity(self):
-        return f"{self.host}:{self.port}{self.path}"
-
-    @property
-    def api_base(self):
-        return URL(f"http://{self.server_host}:{self.server_port}{self.server_path}") / "v1"
+        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"

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/network/util.py

@@ -1,4 +1,3 @@
-import json
 from typing import Literal, overload
 
 from aiohttp import ClientResponse
@@ -11,6 +10,7 @@ from satori.exception import (
     ServerException,
     UnauthorizedException,
 )
+from satori.utils import decode
 
 
 @overload
@@ -25,7 +25,7 @@ async def validate_response(resp: ClientResponse, noreturn=False):
     if 200 <= resp.status < 300:
         if noreturn:
             return
-        return json.loads(content) if (content := await resp.text()) else {}
+        return decode(content) if (content := await resp.text()) else {}
     elif resp.status == 400:
         raise BadRequestException(await resp.text())
     elif resp.status == 401:

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/network/webhook.py

@@ -2,12 +2,13 @@ from __future__ import annotations
 
 import asyncio
 
-from aiohttp import web
+from aiohttp import ClientTimeout, web
 from graia.amnesia.builtins.aiohttp import AiohttpClientService
 from launart.manager import Launart
 from loguru import logger
 
 from satori.model import Event, LoginStatus, Meta, MetaPayload, Opcode
+from satori.utils import decode
 
 from ..account import Account
 from ..config import WebhookInfo as WebhookInfo
@@ -33,7 +34,7 @@ class WebhookNetwork(BaseNetwork[WebhookInfo]):
         if self.config.token and self.config.token != token:
             return web.Response(status=401)
         op_code = int(header.get("Satori-OpCode", "0"))
-        body = await req.json()
+        body = decode(await req.text())
         if op_code == Opcode.META:
             payload = MetaPayload.parse(body)
             self.proxy_urls = payload.proxy_urls
@@ -63,7 +64,6 @@ class WebhookNetwork(BaseNetwork[WebhookInfo]):
                 logger.trace(f"Failed to parse event: {body}\nCaused by {e!r}")
             return web.Response(status=500, reason=f"Failed to parse event caused by {e!r}")
         else:
-            logger.trace(f"Received event: {event}")
             self.sequence = event.sn
         asyncio.create_task(self.app.post(event, self))
         return web.Response()
@@ -97,6 +97,7 @@ class WebhookNetwork(BaseNetwork[WebhookInfo]):
                 endpoint,
                 json={},
                 headers=headers,
+                timeout=ClientTimeout(total=self.config.timeout or 300),
             ) as resp:
                 data = await validate_response(resp)
                 meta = Meta.parse(data)

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/network/websocket.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import asyncio
-import json
 from contextlib import suppress
 from typing import cast
 
@@ -11,6 +10,7 @@ from launart.utilles import any_completed
 from loguru import logger
 
 from satori.model import Event, Identify, LoginStatus, MetaPayload, Opcode, Ready
+from satori.utils import decode, encode
 
 from ..account import Account
 from ..config import WebsocketsInfo as WebsocketsInfo
@@ -27,25 +27,21 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
 
     connection: aiohttp.ClientWebSocketResponse | None = None
 
-    def post_event(self, body: dict):
-        async def event_parse_task(raw: dict):
-            try:
-                event = Event.parse(raw)
-            except Exception as e:
-                if (
-                    "self_id" in raw
-                    or ("login" in raw and "self_id" in raw["login"])
-                    or ("login" in raw and "user" in raw["login"] and "self_id" in raw["login"]["user"])
-                ):
-                    logger.warning(f"Failed to parse event: {raw}\nCaused by {e!r}")
-                else:
-                    logger.trace(f"Failed to parse event: {raw}\nCaused by {e!r}")
+    async def event_parse_task(self, raw: dict):
+        try:
+            event = Event.parse(raw)
+        except Exception as e:
+            if (
+                "self_id" in raw
+                or ("login" in raw and "self_id" in raw["login"])
+                or ("login" in raw and "user" in raw["login"] and "self_id" in raw["login"]["user"])
+            ):
+                logger.warning(f"Failed to parse event: {raw}\nCaused by {e!r}")
             else:
-                logger.trace(f"Received event: {event}")
-                self.sequence = event.sn
-                await self.app.post(event, self)
-
-        return asyncio.create_task(event_parse_task(body))
+                logger.trace(f"Failed to parse event: {raw}\nCaused by {e!r}")
+        else:
+            self.sequence = event.sn
+            await self.app.post(event, self)
 
     async def message_receive(self):
         if self.connection is None:
@@ -56,10 +52,9 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
                 self.close_signal.set()
                 return
             elif msg.type == aiohttp.WSMsgType.TEXT:
-                data: dict = json.loads(cast(str, msg.data))
-                logger.trace(f"Received payload: {data}")
+                data: dict = decode(cast(str, msg.data))
                 if data["op"] == Opcode.EVENT:
-                    self.post_event(data["body"])
+                    asyncio.create_task(self.event_parse_task(data["body"]))
                 elif data["op"] == Opcode.META:
                     payload = MetaPayload.parse(data["body"])
                     self.proxy_urls = payload.proxy_urls
@@ -67,6 +62,8 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
                         account.proxy_urls = payload.proxy_urls.copy()
                 elif data["op"] > 5:
                     logger.warning(f"Received unknown event: {data}")
+                else:
+                    logger.trace(f"Received payload: {data}")
                 continue
         else:
             await self.connection_closed()
@@ -75,7 +72,7 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
         if self.connection is None:
             raise RuntimeError("connection is not established")
 
-        await self.connection.send_json(payload)
+        await self.connection.send_str(encode(payload))
 
     @property
     def alive(self):
@@ -88,7 +85,7 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
         """鉴权连接"""
         if not self.connection:
             raise RuntimeError("connection is not established")
-        payload = Identify(self.config.token)
+        payload = Identify(token=self.config.token)
         if self.sequence > -1:
             payload.sn = self.sequence
         try:
@@ -101,7 +98,7 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
         if resp.type != aiohttp.WSMsgType.TEXT:
             logger.error(f"Received unexpected payload: {resp}")
             return False
-        data = resp.json()
+        data = decode(cast(str, resp.data))
         if data["op"] != Opcode.READY:
             logger.error(f"Received unexpected payload: {data}")
             return False
@@ -141,7 +138,7 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
     async def daemon(self, manager: Launart, session: aiohttp.ClientSession):
         while not manager.status.exiting:
             try:
-                async with session.ws_connect(self.config.ws_base / "events", timeout=30) as self.connection:
+                async with session.ws_connect(self.config.ws_base / "events", timeout=300) as self.connection:
                     logger.debug(f"{self.id} Websocket client connected")
                     self.close_signal.clear()
                     result = await self._authenticate()

{satori_python-0.16.7 → satori_python-0.17.0}/src/satori/client/protocol.py

@@ -4,7 +4,7 @@ from collections.abc import Iterable
 from typing import TYPE_CHECKING, Any, cast, overload
 from typing_extensions import deprecated
 
-from aiohttp import FormData
+from aiohttp import ClientSession, ClientTimeout, FormData
 from graia.amnesia.builtins.aiohttp import AiohttpClientService
 from launart import Launart
 
@@ -39,6 +39,11 @@ if TYPE_CHECKING:
 class ApiProtocol:
     def __init__(self, account: Account):
         self.account = account
+        try:
+            self.session = Launart.current().get_component(AiohttpClientService).session
+        except (LookupError, ValueError):
+            self.session = ClientSession()
+        self.timeout = ClientTimeout(self.account.config.timeout or 300)
 
     async def download(self, url: str):
         """访问资源链接。"""
@@ -67,7 +72,7 @@ class ApiProtocol:
             "Satori-Platform": self.account.platform,
             "Satori-User-ID": self.account.self_id,
         }
-        aio = Launart.current().get_component(AiohttpClientService)
+
         if multipart:
             data = FormData(quote_fields=False)
             if params is None:
@@ -78,17 +83,19 @@ class ApiProtocol:
                     data.add_field(k, v["value"], filename=v.get("filename"), content_type=v["content_type"])
                 else:
                     data.add_field(k, v)
-            async with aio.session.post(
+            async with self.session.post(
                 endpoint,
                 data=data,
                 headers=headers,
+                timeout=self.timeout,
             ) as resp:
                 return await validate_response(resp)
-        async with aio.session.request(
+        async with self.session.request(
             method,
             endpoint,
             json=params or {},
             headers=headers,
+            timeout=self.timeout,
         ) as resp:
             return await validate_response(resp)
 
@@ -635,9 +642,7 @@ class ApiProtocol:
             {"channel_id": channel_id, "message_id": message_id, "emoji": emoji},
         )
 
-    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: str, user_id: str | None = None) -> None:
         """从特定消息删除某个用户添加的特定表态。
 
         如果没有传入用户 ID 则表示删除自己的表态。