satori-python 0.16.3__tar.gz → 0.16.5__tar.gz

{satori_python-0.16.3 → satori_python-0.16.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satori-python
-Version: 0.16.3
+Version: 0.16.5
 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>
@@ -75,6 +75,20 @@ pip install satori-python-client
 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                                            |
+
+### 社区适配器
+
+| 适配器               | 安装                    | 路径           |
+|-------------------|-----------------------|--------------|
+| nekobox(Lagrange) | `pip install nekobox` | nekobox.main |
+
 ## 使用
 
 客户端：

{satori_python-0.16.3 → satori_python-0.16.5}/README.md

@@ -45,6 +45,20 @@ pip install satori-python-client
 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                                            |
+
+### 社区适配器
+
+| 适配器               | 安装                    | 路径           |
+|-------------------|-----------------------|--------------|
+| nekobox(Lagrange) | `pip install nekobox` | nekobox.main |
+
 ## 使用
 
 客户端：

{satori_python-0.16.3 → satori_python-0.16.5}/pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Operating System :: OS Independent",
 ]
-version = "0.16.3"
+version = "0.16.5"
 
 [project.license]
 text = "MIT"
@@ -54,6 +54,7 @@ dev = [
     "fix-future-annotations>=0.5.0",
     "mina-build<0.6,>=0.5.1",
     "pdm-mina>=0.3.2",
+    "nonechat<0.7.0,>=0.6.0",
 ]
 
 [tool.pdm.build]

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/__init__.py

@@ -41,4 +41,4 @@ from .model import Role as Role
 from .model import Upload as Upload
 from .model import User as User
 
-__version__ = "0.16.3"
+__version__ = "0.16.5"

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/client/__init__.py

@@ -35,6 +35,28 @@ MAPPING: dict[type[Config], type[BaseNetwork]] = {
     WebsocketsInfo: WsNetwork,
 }
 
+_app: App | None = None
+
+
+def get_accounts() -> dict[str, Account]:
+    if _app is None:
+        raise RuntimeError("App instance is not initialized.")
+    return _app.accounts
+
+
+def get_app() -> App:
+    """Get the current App instance."""
+    if _app is None:
+        raise RuntimeError("App instance is not initialized.")
+    return _app
+
+
+def get_account(self_id: str) -> Account:
+    """Get an account by its self_id."""
+    if _app is None:
+        raise RuntimeError("App instance is not initialized.")
+    return _app.get_account(self_id)
+
 
 class App(Service):
     id = "satori-python.client"
@@ -51,6 +73,10 @@ class App(Service):
         MAPPING[tc] = tn
 
     def __init__(self, *configs: Config, default_api_cls: type[ApiProtocol] = ApiProtocol):
+        global _app
+
+        if _app is not None:
+            raise RuntimeError("App instance already exists. Only one App instance is allowed.")
         self.accounts = {}
         self.connections = []
         self.event_callbacks = []
@@ -59,6 +85,7 @@ class App(Service):
         for config in configs:
             self.apply(config)
         self.default_api_cls = default_api_cls
+        _app = self
 
     def apply(self, config: Config):
         try:

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/client/network/base.py

@@ -8,7 +8,7 @@ from launart import Service
 from ..config import Config as Config
 
 if TYPE_CHECKING:
-    from .. import Account, App
+    from satori.client import Account, App
 
 TConfig = TypeVar("TConfig", bound=Config)
 

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/element.py

@@ -180,6 +180,7 @@ class Resource(Element):
         raw: Optional[Union[bytes, BytesIO]] = None,
         mime: Optional[str] = None,
         name: Optional[str] = None,
+        duration: Optional[float] = None,
         poster: Optional[str] = None,
         extra: Optional[dict[str, Any]] = None,
         cache: Optional[bool] = None,
@@ -198,6 +199,8 @@ class Resource(Element):
             raise ValueError(f"{cls} need at least one of url, path and raw")
         if name is not None:
             data["title"] = name
+        if duration is not None and cls is Audio:
+            data["duration"] = duration
         if poster is not None and cls in (Video, Audio, File):
             data["poster"] = poster
         if cache is not None:
@@ -231,7 +234,7 @@ class Image(Resource):
 class Audio(Resource):
     """<audio> 元素用于表示语音。"""
 
-    duration: Optional[int] = None
+    duration: Optional[float] = None
     poster: Optional[str] = None
 
     __names__ = ("src", "title", "duration", "poster")
@@ -243,7 +246,7 @@ class Video(Resource):
 
     width: Optional[int] = None
     height: Optional[int] = None
-    duration: Optional[int] = None
+    duration: Optional[float] = None
     poster: Optional[str] = None
 
     __names__ = ("src", "title", "width", "height", "duration", "poster")

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/model.py

@@ -46,7 +46,7 @@ class ChannelType(IntEnum):
 @dataclass
 class Channel(ModelBase):
     id: str
-    type: ChannelType
+    type: ChannelType = ChannelType.TEXT
     name: Optional[str] = None
     parent_id: Optional[str] = None
 

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/parser.py

@@ -358,9 +358,9 @@ def parse(src: str, context: Optional[dict] = None):
     def parse_content(source: str, _start: bool, _end: bool):
         source = unescape(source)
         if _start:
-            source = re.sub(r"^\s*\n\s*", "", source, re.MULTILINE)
+            source = re.sub(r"^\s*\n\s*", "", source, flags=re.MULTILINE)
         if _end:
-            source = re.sub(r"\s*\n\s*$", "", source, re.MULTILINE)
+            source = re.sub(r"\s*\n\s*$", "", source, flags=re.MULTILINE)
         push_text(source)
 
     tag_pat = tag_pat2 if context is not None else tag_pat1

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/server/__init__.py

@@ -8,30 +8,29 @@ import secrets
 import signal
 import threading
 import urllib.parse
-from collections.abc import Iterable
+from collections.abc import Awaitable, Iterable
 from contextlib import suppress
 from itertools import chain
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from traceback import print_exc
-from typing import Any
+from typing import Any, Callable, TypeVar
 
 import aiohttp
 from creart import it
-from graia.amnesia.builtins.asgi import UvicornASGIService
+from graia.amnesia.builtins.aiohttp import AiohttpClientService
+from graia.amnesia.builtins.asgi import UvicornASGIService, asgitypes
 from launart import Launart, Service, any_completed
 from loguru import logger
 from starlette.applications import Starlette
 from starlette.datastructures import FormData as FormData
 from starlette.requests import Request as StarletteRequest
-from starlette.responses import (
-    FileResponse,
-    HTMLResponse,
-    JSONResponse,
-    PlainTextResponse,
-    Response,
-    StreamingResponse,
-)
+from starlette.responses import FileResponse as FileResponse
+from starlette.responses import HTMLResponse as HTMLResponse
+from starlette.responses import JSONResponse as JSONResponse
+from starlette.responses import PlainTextResponse as PlainTextResponse
+from starlette.responses import Response as Response
+from starlette.responses import StreamingResponse as StreamingResponse
 from starlette.routing import Route, WebSocketRoute
 from starlette.staticfiles import StaticFiles
 from starlette.websockets import WebSocket, WebSocketDisconnect
@@ -42,7 +41,7 @@ from satori.model import Event, Meta, ModelBase, Opcode
 
 from .. import EventType
 from .adapter import Adapter as Adapter
-from .conection import WebsocketConnection
+from .connection import WebsocketConnection
 from .formdata import parse_content_disposition as parse_content_disposition
 from .model import Provider as Provider
 from .model import Request as Request
@@ -52,6 +51,10 @@ from .route import RouteCall as RouteCall
 from .route import RouterMixin as RouterMixin
 from .utils import Deque
 
+_T_endpoint = TypeVar("_T_endpoint", bound=Callable[[StarletteRequest], Awaitable[Response] | Response])
+_T_ws_endpoint = TypeVar("_T_ws_endpoint", bound=Callable[[WebSocket], Awaitable[None]])
+StarletteResponse = Response
+
 
 async def _request_handler(
     action: str, request: StarletteRequest, func: RouteCall, platform: str, self_id: str
@@ -115,13 +118,12 @@ class Server(Service, RouterMixin):
         stream_chunk_size: int = 64 * 1024,
     ):
         self.connections = []
-        manager = it(Launart)
-        manager.add_component(UvicornASGIService(host, port))
+        self.host = host
+        self.port = port
         self.version = version
         self.path = path
         if self.path and not self.path.startswith("/"):
             self.path = f"/{self.path}"
-        self.url_base = f"http://{host}:{port}{self.path}/{version}"
         self.token = token
         self._adapters = []
         self.providers = []
@@ -134,8 +136,59 @@ class Server(Service, RouterMixin):
         self.stream_threshold = stream_threshold
         self.stream_chunk_size = stream_chunk_size
         self.resources: dict[str, Path] = {}
+        self.app = Starlette()
         super().__init__()
 
+    def replace_app(self, app: asgitypes.ASGI3Application):
+        """替换当前的 Starlette 应用"""
+        self.app = app
+
+    def asgi_route(
+        self,
+        path: str,
+        methods: list[str] | None = None,
+        name: str | None = None,
+        include_in_schema: bool = True,
+    ) -> Callable[[_T_endpoint], _T_endpoint]:
+        """注册一个 ASGI 路由
+
+        Args:
+            path (str): 路由路径
+            methods (list[str], optional): 支持的 HTTP 方法，默认为 None，表示 ["GET"]
+            name (str, optional): 路由名称，默认为 None
+            include_in_schema (bool, optional): 是否包含在 OpenAPI 文档中，默认为 True
+        """
+
+        def wrapper(endpoint: _T_endpoint, /) -> _T_endpoint:
+            self.app.add_route(
+                path, endpoint, methods=methods, name=name, include_in_schema=include_in_schema
+            )
+            return endpoint
+
+        return wrapper
+
+    def asgi_websocket_route(
+        self,
+        path: str,
+        name: str | None = None,
+    ) -> Callable[[_T_ws_endpoint], _T_ws_endpoint]:
+        """注册一个 ASGI WebSocket 路由
+
+        Args:
+            path (str): 路由路径
+            name (str, optional): 路由名称，默认为 None
+        """
+
+        def wrapper(endpoint: _T_ws_endpoint, /) -> _T_ws_endpoint:
+            self.app.add_websocket_route(path, endpoint, name=name)
+            return endpoint
+
+        return wrapper
+
+    @property
+    def url_base(self):
+        return f"http://{self.host}:{self.port}{self.path}/{self.version}"
+
     def apply(self, item: Provider | Router | Adapter):
         if isinstance(item, Adapter):
             item.ensure_server(self)
@@ -157,9 +210,11 @@ class Server(Service, RouterMixin):
         self._event_cache.append(event)
         self._sequence += 1
         for connection in self.connections:
+            if not connection.alive:
+                continue
             try:
                 await connection.send({"op": Opcode.EVENT, "body": event.dump()})
-            except WebSocketDisconnect:
+            except (WebSocketDisconnect, RuntimeError):
                 break
             except Exception as e:
                 print_exc()
@@ -287,13 +342,14 @@ class Server(Service, RouterMixin):
                     file = Path(self._tempdir.name) / path[5:]
                     if file.exists():
                         return FileResponse(file)
-                    raise FileNotFoundError(f"{path[5:]} not found")
                 assert request is not None
                 for provider in self.providers:
                     if provider.ensure(platform, self_id):
                         return await provider.handle_internal(
                             Request(request, "internal", {}, platform=platform, self_id=self_id), path
                         )
+                if path.startswith("_tmp"):
+                    raise FileNotFoundError(f"File not found: {path[5:]}")
                 raise NotImplementedError(f"Login with {platform}:{self_id} not found")
             raise TypeError(f"Invalid internal url: {url}")
 
@@ -382,8 +438,8 @@ class Server(Service, RouterMixin):
 
         async with self.stage("preparing"):
             asgi_service = manager.get_component(UvicornASGIService)
-            app = Starlette(
-                routes=[
+            self.app.routes.extend(
+                [
                     *chain.from_iterable(ada.get_routes() for ada in self._adapters),
                     WebSocketRoute(f"{self.path}/{self.version}/events", self.websocket_server_handler),
                     Route(
@@ -414,8 +470,8 @@ class Server(Service, RouterMixin):
                 ]
             )
             for path, file in self.resources.items():
-                app.mount(path, StaticFiles(directory=file.parent, html=file.suffix == ".html"))
-            asgi_service.middleware.mounts[""] = app  # type: ignore
+                self.app.mount(path, StaticFiles(directory=file.parent, html=file.suffix == ".html"))
+            asgi_service.middleware.mounts[""] = self.app  # type: ignore
 
         async def event_task(_provider: Provider):
             async for event in _provider.publisher():
@@ -457,7 +513,10 @@ class Server(Service, RouterMixin):
     ):
         if manager is None:
             manager = it(Launart)
+        manager.add_component(UvicornASGIService(self.host, self.port))
         manager.add_component(self)
+        with suppress(ValueError):
+            manager.add_component(AiohttpClientService())
         manager.launch_blocking(loop=loop, stop_signal=stop_signal)
 
     async def run_async(

{satori_python-0.16.3 → satori_python-0.16.5}/src/satori/server/route.py

@@ -88,20 +88,20 @@ class ChannelListParam(TypedDict):
 CHANNEL_LIST: TypeAlias = RouteCall[ChannelListParam, Union[PageResult[Channel], dict[str, Any]]]
 
 
-class ChanneCreateParam(TypedDict):
+class ChannelCreateParam(TypedDict):
     guild_id: str
     data: dict
 
 
-CHANNEL_CREATE: TypeAlias = RouteCall[ChanneCreateParam, Union[Channel, dict[str, Any]]]
+CHANNEL_CREATE: TypeAlias = RouteCall[ChannelCreateParam, Union[Channel, dict[str, Any]]]
 
 
-class ChanneUpdateParam(TypedDict):
+class ChannelUpdateParam(TypedDict):
     channel_id: str
     data: dict
 
 
-CHANNEL_UPDATE: TypeAlias = RouteCall[ChanneUpdateParam, None]
+CHANNEL_UPDATE: TypeAlias = RouteCall[ChannelUpdateParam, None]
 
 
 class ChannelMuteParam(TypedDict):
@@ -261,7 +261,7 @@ FRIEND_LIST: TypeAlias = RouteCall[FriendListParam, Union[PageResult[User], dict
 class ApproveParam(TypedDict):
     message_id: str
     approve: bool
-    comment: str
+    comment: NotRequired[str]
 
 
 APPROVE: TypeAlias = RouteCall[ApproveParam, None]
@@ -402,7 +402,7 @@ class RouterMixin:
     def route(self, path: str) -> Callable[[INTERAL], INTERAL]: ...
 
     def route(self, path: Union[str, Api]) -> Callable[[RouteCall], RouteCall]:
-        """注册一个路由
+        """注册一个 Satori 路由
 
         Args:
             path (str | Api): 路由路径；若 path 不属于 Api，则会被认为是内部接口