satori-python 0.15.2__tar.gz → 0.16.1__tar.gz

{satori_python-0.15.2 → satori_python-0.16.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satori-python
-Version: 0.15.2
+Version: 0.16.1
 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>
@@ -80,9 +80,9 @@ pip install satori-python-server
 客户端：
 
 ```python
-from satori import EventType, WebsocketsInfo
+from satori import EventType
 from satori.event import MessageEvent
-from satori.client import Account, App
+from satori.client import Account, App, WebsocketsInfo
 
 app = App(WebsocketsInfo(port=5140))
 

{satori_python-0.15.2 → satori_python-0.16.1}/README.md

@@ -50,9 +50,9 @@ pip install satori-python-server
 客户端：
 
 ```python
-from satori import EventType, WebsocketsInfo
+from satori import EventType
 from satori.event import MessageEvent
-from satori.client import Account, App
+from satori.client import Account, App, WebsocketsInfo
 
 app = App(WebsocketsInfo(port=5140))
 

{satori_python-0.15.2 → satori_python-0.16.1}/pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Operating System :: OS Independent",
 ]
-version = "0.15.2"
+version = "0.16.1"
 
 [project.license]
 text = "MIT"

{satori_python-0.15.2 → satori_python-0.16.1}/src/satori/__init__.py

@@ -1,5 +1,3 @@
-from .config import WebhookInfo as WebhookInfo
-from .config import WebsocketsInfo as WebsocketsInfo
 from .const import Api as Api
 from .const import EventType as EventType
 from .element import At as At
@@ -43,4 +41,4 @@ from .model import Role as Role
 from .model import Upload as Upload
 from .model import User as User
 
-__version__ = "0.15.2"
+__version__ = "0.16.1"

{satori_python-0.15.2 → satori_python-0.16.1}/src/satori/client/__init__.py

@@ -14,12 +14,14 @@ from launart import Launart, Service, any_completed
 from loguru import logger
 
 from satori import event as events
-from satori.config import Config, WebhookInfo, WebsocketsInfo
 from satori.const import EventType
 from satori.model import Event, LoginStatus
 
 from .account import Account as Account
 from .account import ApiInfo as ApiInfo
+from .config import Config
+from .config import WebhookInfo as WebhookInfo
+from .config import WebsocketsInfo as WebsocketsInfo
 from .network.base import BaseNetwork as BaseNetwork
 from .network.webhook import WebhookNetwork
 from .network.websocket import WsNetwork
@@ -187,16 +189,15 @@ class App(Service):
     async def post(self, event: Event, conn: BaseNetwork):
         if not self.event_callbacks:
             return
-        identity = f"{event.platform_}/{event.self_id_}"
-        if identity not in self.accounts:
+        login_sn = f"{event.login.sn}@{id(conn)}"
+        if login_sn not in self.accounts:
             if event.type == EventType.LOGIN_ADDED:
                 if TYPE_CHECKING:
                     assert isinstance(event, events.LoginEvent)
                 account = Account(
-                    event.platform_,
-                    event.self_id_,
                     event.login,
                     conn.config,
+                    conn.proxy_urls,
                     self.default_api_cls,
                 )
                 logger.info(f"account added: {account}")
@@ -205,26 +206,23 @@ class App(Service):
                     if event.login.status == LoginStatus.ONLINE
                     else account.connected.clear()
                 )
-                self.accounts[identity] = account
-                conn.accounts[identity] = account
-                await self.account_update(account, LoginStatus.CONNECT)
-                await self.account_update(account, LoginStatus.ONLINE)
+                self.accounts[login_sn] = account
+                conn.accounts[login_sn] = account
+                await self.account_update(account, event.login.status)
             elif event.type == EventType.LOGIN_UPDATED:
                 if TYPE_CHECKING:
                     assert isinstance(event, events.LoginEvent)
                 if event.login.status == LoginStatus.ONLINE:
                     account = Account(
-                        event.platform_,
-                        event.self_id_,
                         event.login,
                         conn.config,
+                        conn.proxy_urls,
                         self.default_api_cls,
                     )
                     logger.info(f"account added: {account}")
                     account.connected.set()
-                    self.accounts[identity] = account
-                    conn.accounts[identity] = account
-                    await self.account_update(account, LoginStatus.CONNECT)
+                    self.accounts[login_sn] = account
+                    conn.accounts[login_sn] = account
                     await self.account_update(account, LoginStatus.ONLINE)
                 else:
                     logger.warning(f"Received event for unknown account: {event}")
@@ -233,7 +231,7 @@ class App(Service):
                 logger.warning(f"Received event for unknown account: {event}")
                 return
         else:
-            account = self.accounts[identity]
+            account = self.accounts[login_sn]
         if event.type == EventType.LOGIN_UPDATED:
             if TYPE_CHECKING:
                 assert isinstance(event, events.LoginEvent)
@@ -243,6 +241,7 @@ class App(Service):
                 if event.login.status in (LoginStatus.ONLINE, LoginStatus.CONNECT)
                 else account.connected.clear()
             )
+            await self.account_update(account, event.login.status)
 
         await asyncio.gather(*(callback(account, event) for callback in self.event_callbacks))
 
@@ -251,9 +250,9 @@ class App(Service):
                 assert isinstance(event, events.LoginEvent)
             logger.info(f"account removed: {account}")
             account.connected.clear()
-            await self.account_update(account, LoginStatus.DISCONNECT)
-            del self.accounts[identity]
-            del conn.accounts[identity]
+            await self.account_update(account, LoginStatus.OFFLINE)
+            del self.accounts[login_sn]
+            del conn.accounts[login_sn]
 
     async def launch(self, manager: Launart):
         for conn in self.connections:

{satori_python-0.15.2 → satori_python-0.16.1}/src/satori/client/account.py

@@ -6,7 +6,7 @@ from typing import Generic, TypeVar
 
 from yarl import URL
 
-from satori.model import LoginType
+from satori.model import Login
 
 from .protocol import ApiProtocol
 
@@ -33,44 +33,47 @@ class ApiInfo:
 class Account(Generic[TP]):
     def __init__(
         self,
-        platform: str,
-        self_id: str,
-        self_info: LoginType,
+        login: Login,
         config: ApiInfo,
+        proxy_urls: list[str],
         protocol_cls: type[TP] = ApiProtocol,
     ):
-        self.platform = platform
-        self.self_id = self_id
-        self.self_info = self_info
+        self.sn = login.sn
+        self.adapter = login.adapter
+        self.self_info = login
         self.config = config
+        self.proxy_urls = proxy_urls
         self.protocol = protocol_cls(self)  # type: ignore
         self.connected = asyncio.Event()
 
+    @property
+    def platform(self):
+        return self.self_info.platform or "satori"
+
+    @property
+    def self_id(self):
+        return self.self_info.id
+
     def custom(
         self, config: ApiInfo | None = None, protocol_cls: type[TP1] = ApiProtocol, **kwargs
     ) -> "Account[TP1]":
         return Account(
-            self.platform,
-            self.self_id,
             self.self_info,
             config or (ApiInfo(**kwargs) if kwargs else self.config),
+            self.proxy_urls,
             protocol_cls,  # type: ignore
         )
 
-    @property
-    def identity(self):
-        return f"{self.platform}/{self.self_id}"
-
     def ensure_url(self, url: str) -> URL:
         """确定链接形式。
 
         若链接符合以下条件之一，则返回链接的代理形式 ({host}/{path}/{version}/proxy/{url})：
-            - 链接以 "upload://" 开头
-            - 链接开头出现在 self_info.proxy_urls 中的某一项
+            - 链接以 "internal:" 开头
+            - 链接开头出现在 proxy_urls 中的某一项
         """
-        if url.startswith("upload"):
+        if url.startswith("internal:"):
             return self.config.api_base / "proxy" / url.lstrip("/")
-        for proxy_url in self.self_info.proxy_urls:
+        for proxy_url in self.proxy_urls:
             if url.startswith(proxy_url):
                 return self.config.api_base / "proxy" / url.lstrip("/")
         return URL(url)

{satori_python-0.15.2 → satori_python-0.16.1}/src/satori/client/account.pyi

@@ -1,6 +1,7 @@
 import asyncio
 from collections.abc import Iterable
 from typing import Any, Generic, Protocol, TypeVar, overload
+from typing_extensions import deprecated
 
 from yarl import URL
 
@@ -10,10 +11,11 @@ from satori.model import (
     Direction,
     Event,
     Guild,
-    LoginType,
+    Login,
     Member,
     MessageObject,
     MessageReceipt,
+    Meta,
     Order,
     PageDequeResult,
     PageResult,
@@ -39,23 +41,25 @@ class ApiInfo(Api):
     ): ...
 
 class Account(Generic[TP]):
-    platform: str
-    self_id: str
-    self_info: LoginType
+    sn: str
+    adapter: str
+    self_info: Login
+    proxy_urls: list[str]
     config: Api
     protocol: TP
     connected: asyncio.Event
 
     def __init__(
         self,
-        platform: str,
-        self_id: str,
-        self_info: LoginType,
+        login: Login,
         config: Api,
+        proxy_urls: list[str],
         protocol_cls: type[TP] = ApiProtocol,
     ): ...
     @property
-    def identity(self) -> str: ...
+    def platform(self) -> str: ...
+    @property
+    def self_id(self) -> str: ...
     @overload
     def custom(self, config: Api, protocol_cls: type[TP1] = ApiProtocol) -> Account[TP1]: ...
     @overload
@@ -496,7 +500,7 @@ class Account(Generic[TP]):
             PageResult[User]: `User` 的分页列表
         """
 
-    async def login_get(self) -> LoginType:
+    async def login_get(self) -> Login:
         """获取当前登录信息。返回一个 `Login` 对象。
 
         Returns:
@@ -535,21 +539,36 @@ class Account(Generic[TP]):
             None: 该方法无返回值
         """
 
-    async def internal(self, action: str, **kwargs) -> Any:
+    async def internal(self, action: str, method: str = "POST", **kwargs) -> Any:
         """内部接口调用。
 
         Args:
             action (str): 内部接口名称
+            method (str, optional): 请求方法，默认为 POST
             **kwargs: 参数
         """
 
-    async def admin_login_list(self) -> list[LoginType]:
+    async def meta_get(self) -> Meta:
+        """获取元信息。返回一个 `Meta` 对象。
+
+        Returns:
+            Meta: `Meta` 对象
+        """
+
+    @deprecated("Use `meta_get` instead")
+    async def admin_login_list(self) -> list[Login]:
         """获取登录信息列表。返回一个 `Login` 对象构成的数组。
 
         Returns:
             list[Login]: `Login` 对象构成的数组
         """
 
+    async def webhook_create(self, url: str, token: str | None = None):
+        """创建 Webhook。"""
+
+    async def webhook_delete(self, url: str):
+        """删除 Webhook。"""
+
     @overload
     async def upload_create(self, *uploads: Upload) -> list[str]: ...
     @overload
@@ -564,3 +583,6 @@ class Account(Generic[TP]):
 
     async def download(self, url: str):
         """访问内部链接。"""
+
+    async def request_internal(self, url: str, method: str = "GET", **kwargs) -> dict:
+        """访问内部链接。"""

satori_python-0.16.1/src/satori/client/network/base.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+import asyncio
+from typing import TYPE_CHECKING, Generic, TypeVar
+
+from launart import Service
+
+from ..config import Config as Config
+
+if TYPE_CHECKING:
+    from .. import App
+
+TConfig = TypeVar("TConfig", bound=Config)
+
+
+class BaseNetwork(Generic[TConfig], Service):
+    close_signal: asyncio.Event
+    sequence: int
+
+    def __init__(self, app: App, config: TConfig):
+        super().__init__()
+        self.app = app
+        self.config = config
+        self.accounts = {}
+        self.close_signal = asyncio.Event()
+        self.sequence = -1
+        self.proxy_urls = []
+
+    async def wait_for_available(self): ...
+
+    @property
+    def alive(self) -> bool: ...
+
+    async def connection_closed(self):
+        self.close_signal.set()

satori_python-0.16.1/src/satori/client/network/webhook.py

@@ -0,0 +1,111 @@
+from __future__ import annotations
+
+import asyncio
+
+from aiohttp import web
+from launart.manager import Launart
+from loguru import logger
+
+from satori.model import Event, LoginStatus, MetaPayload, Opcode
+
+from ..account import Account
+from ..config import WebhookInfo as WebhookInfo
+from .base import BaseNetwork
+
+
+class WebhookNetwork(BaseNetwork[WebhookInfo]):
+    required: set[str] = set()
+    stages: set[str] = {"preparing", "blocking", "cleanup"}
+    wsgi: web.Application | None = None
+
+    @property
+    def id(self):
+        return f"satori/network/webhook/{self.config.identity}#{id(self)}"
+
+    async def handle_request(self, req: web.Request):
+        header = req.headers
+        auth = header["Authorization"]
+        if not auth.startswith("Bearer"):
+            return web.Response(status=401)
+        token = auth.split(" ", 1)[1]
+        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()
+        if op_code == Opcode.META:
+            payload = MetaPayload.parse(body)
+            self.proxy_urls = payload.proxy_urls
+            return web.Response()
+        if op_code != Opcode.EVENT:
+            return web.Response(status=202)
+        # if "X-Platform" in header and "X-Self-ID" in header:
+        #     platform = header["X-Platform"]
+        #     self_id = header["X-Self-ID"]
+        # elif "Satori-Platform" in header and "Satori-User-ID" in header:
+        #     platform = header["Satori-Platform"]
+        #     self_id = header["Satori-User-ID"]
+        # else:
+        #     return web.Response(status=400)
+        try:
+            event = Event.parse(body)
+        except Exception as e:
+            if (
+                "self_id" in body
+                or ("login" in body and "self_id" in body["login"])
+                or ("login" in body and "user" in body["login"] and "self_id" in body["login"]["user"])
+            ):
+                logger.warning(f"Failed to parse event: {body}\nCaused by {e!r}")
+            else:
+                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
+        login_sn = f"{event.login.sn}@{id(self)}"
+        if login_sn in self.app.accounts:
+            account = self.app.accounts[login_sn]
+            account.connected.set()
+            account.config = self.config
+        else:
+            account = Account(event.login, self.config, self.proxy_urls)
+            logger.info(f"account registered: {account}")
+            account.connected.set()
+            self.app.accounts[login_sn] = account
+            self.accounts[login_sn] = account
+            await self.app.account_update(account, LoginStatus.ONLINE)
+        asyncio.create_task(self.app.post(event, self))
+        return web.Response()
+
+    @property
+    def alive(self):
+        return self.wsgi is not None
+
+    async def wait_for_available(self):
+        await self.status.wait_for_available()
+
+    async def launch(self, manager: Launart):
+        async with self.stage("preparing"):
+            logger.info(f"starting server on {self.config.identity}")
+            self.wsgi = web.Application(logger=logger)  # type: ignore
+            self.wsgi.router.freeze = lambda: None  # monkey patch
+            self.wsgi.router.add_post(self.config.path, self.handle_request)
+            runner = web.AppRunner(self.wsgi)
+            await runner.setup()
+            site = web.TCPSite(runner, self.config.host, self.config.port)
+
+        async with self.stage("blocking"):
+            await site.start()
+            await manager.status.wait_for_sigexit()
+            logger.info(f"{self.id} Webhook server exiting...")
+            self.close_signal.set()
+            for v in list(self.app.accounts.values()):
+                if (identity := f"{v.sn}@{id(self)}") in self.accounts:
+                    v.connected.clear()
+                    await self.app.account_update(v, LoginStatus.OFFLINE)
+                    del self.app.accounts[identity]
+                    del self.accounts[identity]
+
+        async with self.stage("cleanup"):
+            await site.stop()
+            await self.wsgi.shutdown()
+            await self.wsgi.cleanup()

{satori_python-0.15.2 → satori_python-0.16.1}/src/satori/client/network/websocket.py

@@ -10,10 +10,10 @@ from launart.manager import Launart
 from launart.utilles import any_completed
 from loguru import logger
 
-from satori.config import WebsocketsInfo as WebsocketsInfo
-from satori.model import Login, LoginPreview, LoginStatus, Opcode
+from satori.model import Event, Identify, LoginStatus, Opcode, Ready
 
 from ..account import Account
+from ..config import WebsocketsInfo as WebsocketsInfo
 from .base import BaseNetwork
 
 
@@ -27,6 +27,26 @@ 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}")
+            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))
+
     async def message_receive(self):
         if self.connection is None:
             raise RuntimeError("connection is not established")
@@ -40,7 +60,7 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
                 logger.trace(f"Received payload: {data}")
                 if data["op"] == Opcode.EVENT:
                     self.post_event(data["body"])
-                elif data["op"] > 4:
+                elif data["op"] > 5:
                     logger.warning(f"Received unknown event: {data}")
                 continue
         else:
@@ -63,18 +83,13 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
         """鉴权连接"""
         if not self.connection:
             raise RuntimeError("connection is not established")
-        payload = {
-            "op": Opcode.IDENTIFY,
-            "body": {
-                "token": self.config.token,
-            },
-        }
+        payload = Identify(self.config.token)
         if self.sequence > -1:
-            payload["body"]["sequence"] = self.sequence
+            payload.sn = self.sequence
         try:
-            await self.send(payload)
+            await self.send({"op": Opcode.IDENTIFY.value, "body": payload.dump()})
         except Exception as e:
-            logger.error(f"Error while sending IDENTIFY event: {e}")
+            logger.error(f"Error while sending IDENTIFY event: {e!r}")
             return False
 
         resp = await self.connection.receive()
@@ -85,32 +100,24 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
         if data["op"] != Opcode.READY:
             logger.error(f"Received unexpected payload: {data}")
             return False
-        for login in data["body"]["logins"]:
-            obj = LoginPreview.parse(login) if "user" in login else Login.parse(login)
-            if obj.id is None:
-                continue
-            platform = obj.platform or "satori"
-            self_id = obj.id
-            identity = f"{platform}/{self_id}"
-            if identity in self.app.accounts:
-                account = self.app.accounts[identity]
-                self.accounts[identity] = account
-                if not obj.status or obj.status == LoginStatus.ONLINE:
+        ready = Ready.parse(data["body"])
+        self.proxy_urls = ready.proxy_urls
+        for login in ready.logins:
+            login_sn = f"{login.sn}@{id(self)}"
+            if login_sn in self.app.accounts:
+                account = self.app.accounts[login_sn]
+                self.accounts[login_sn] = account
+                if login.status == LoginStatus.ONLINE:
                     account.connected.set()
                 else:
                     account.connected.clear()
                 account.config = self.config
             else:
-                account = Account(platform, self_id, obj, self.config, self.app.default_api_cls)
+                account = Account(login, self.config, ready.proxy_urls, self.app.default_api_cls)
                 logger.info(f"account registered: {account}")
-                (
-                    account.connected.set()
-                    if not obj.status or obj.status == LoginStatus.ONLINE
-                    else account.connected.clear()
-                )
-                self.app.accounts[identity] = account
-                self.accounts[identity] = account
-                await self.app.account_update(account, LoginStatus.CONNECT)
+                (account.connected.set() if login.status == LoginStatus.ONLINE else account.connected.clear())
+                self.app.accounts[login_sn] = account
+                self.accounts[login_sn] = account
             await self.app.account_update(account, LoginStatus.ONLINE)
         if not self.accounts:
             logger.warning(f"No account available for {self.config}")
@@ -151,9 +158,11 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
                         self.close_signal.set()
                         self.connection = None
                         for v in list(self.app.accounts.values()):
-                            if v.identity in self.accounts:
+                            if (identity := f"{v.sn}@{id(self)}") in self.accounts:
                                 v.connected.clear()
-                                del self.accounts[v.identity]
+                                await self.app.account_update(v, LoginStatus.OFFLINE)
+                                del self.app.accounts[identity]
+                                del self.accounts[identity]
                         return
                     if close_task in done:
                         receiver_task.cancel()
@@ -162,7 +171,7 @@ class WsNetwork(BaseNetwork[WebsocketsInfo]):
                             logger.debug(f"Unregistering satori account {k}...")
                             account = self.app.accounts[k]
                             account.connected.clear()
-                            await self.app.account_update(account, LoginStatus.DISCONNECT)
+                            await self.app.account_update(account, LoginStatus.RECONNECT)
                         self.accounts.clear()
                         await asyncio.sleep(5)
                         logger.info(f"{self} Reconnecting...")