ErisPulse 2.4.6.dev4__tar.gz → 2.4.6.dev5__tar.gz

{erispulse-2.4.6.dev4 → erispulse-2.4.6.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.4.6.dev4
+Version: 2.4.6.dev5
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: ErisDev <erisdev@88.com>
 Maintainer-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>
@@ -155,34 +155,40 @@ Description-Content-Type: text/markdown
 
 ---
 
-### 支持的适配器
+### 快速开始
 
-<div align="center">
-<!-- <img src=".github/assets/adapter-showcase.png" width="520" alt="适配器展示" /> -->
+#### 一键安装脚本（推荐）
 
-欢迎您贡献适配器！
+安装脚本会自动检测您的环境（Docker、Python、uv），引导选择最适合的安装方式，支持多语言（中文/English/日本語/Русский/繁體中文）。
 
-| 适配器 | 说明 |
-|--------|------|
-| <img src=".github/assets/adapter_logo/kook.svg" height="20" alt="Kook" /> [Kook](https://github.com/shanfishapp/ErisPulse-KookAdapter) | Kook（开黑啦）即时通讯平台 |
-| <img src=".github/assets/adapter_logo/matrix.svg" height="20" alt="Matrix" /> [Matrix](https://github.com/ErisPulse/ErisPulse-MatrixAdapter) | Matrix 去中心化通讯协议 |
-| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot11](https://github.com/ErisPulse/ErisPulse-OneBot11Adapter) | OneBot v11 通用机器人协议 |
-| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot12](https://github.com/ErisPulse/ErisPulse-OneBot12Adapter) | OneBot v12 标准协议 |
-| <img src=".github/assets/adapter_logo/qqbot.svg" height="20" alt="QQ" /> [QQ](https://github.com/ErisPulse/ErisPulse-QQBotAdapter) | QQ 官方机器人平台 |
-| <img src=".github/assets/adapter_logo/sandbox.png" height="20" alt="Sandbox" /> [沙箱](https://github.com/ErisPulse/ErisPulse-SandboxAdapter) | 网页端调试，无需接入真实平台 |
-| <img src=".github/assets/adapter_logo/telegram.svg" height="20" alt="Telegram" /> [Telegram](https://github.com/ErisPulse/ErisPulse-TelegramAdapter) | 全球性即时通讯平台 |
-| <img src=".github/assets/adapter_logo/email.svg" height="20" alt="Email" /> [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) | 邮件协议收发适配器 |
-| <img src=".github/assets/adapter_logo/yunhu.png" height="20" alt="Yunhu" /> [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) | 企业级即时通讯平台（机器人接入） |
-| [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) | 基于云湖用户协议的接入适配器 |
-| [花枫咖啡馆](https://github.com/ErisPulse/ErisPulse-Ideaura/) | Allons! \(・ω・) / |
+Windows (PowerShell):
+```powershell
+irm https://get.erisdev.com/install.ps1 -OutFile install.ps1; powershell -ExecutionPolicy Bypass -File install.ps1
+```
 
-查看 [适配器详情介绍](docs/zh-CN/platform-guide/README.md)
+macOS / Linux:
+```bash
+curl -fsSL https://get.erisdev.com/install.sh -o install.sh && chmod +x install.sh && ./install.sh
+```
 
-</div>
+<table>
+<tr>
+<td align="center" width="50%">
 
----
+**Docker 安装演示**
 
-### 快速开始
+<video src="https://github.com/user-attachments/assets/a367a466-4678-46a9-b101-073a86388ede" controls width="100%"></video>
+
+</td>
+<td align="center" width="50%">
+
+**pip 安装演示**
+
+<video src="https://github.com/user-attachments/assets/a2df4009-dba6-411e-b79d-4454a168d063" controls width="100%"></video>
+
+</td>
+</tr>
+</table>
 
 #### 使用 Docker (推荐)
 
@@ -279,19 +285,28 @@ bash <(curl -sL https://get-1panel.erisdev.com/install.sh)
 pip install ErisPulse
 ```
 
-<img src=".github/assets/docs/install_pip.gif" alt="安装演示" />
-
-> 如果您的 Python 版本低于 3.10，可以使用一键安装脚本自动配置环境。详见 [安装脚本说明](scripts/install/)。
+> 也可以使用上方的一键安装脚本，自动检测环境并引导配置。
 
 #### 运行效果
 
 
 ##### 仪表盘：
-> 有一个gif，但是太大了没放到这里~ 抱歉~
-> [GIF演示](.github/assets/docs/dashboard-demo.gif)
+
+<table>
+<tr>
+<td width="50%">
 
 <img src=".github/assets/docs/dashboard.png" alt="Dashboard 演示" />
 
+</td>
+<td width="50%">
+
+<video src="https://github.com/user-attachments/assets/157191c4-9a84-433c-b311-0c57e3a21151" controls width="100%"></video>
+
+</td>
+</tr>
+</table>
+
 
 ##### 同一端代码，多个平台响应：
 
@@ -394,6 +409,28 @@ epsdk run main.py --reload
 
 ---
 
+### 支持的适配器
+
+欢迎您贡献适配器！
+
+| 适配器 | 说明 |
+|--------|------|
+| <img src=".github/assets/adapter_logo/kook.svg" height="20" alt="Kook" /> [Kook](https://github.com/shanfishapp/ErisPulse-KookAdapter) | Kook（开黑啦）即时通讯平台 |
+| <img src=".github/assets/adapter_logo/matrix.svg" height="20" alt="Matrix" /> [Matrix](https://github.com/ErisPulse/ErisPulse-MatrixAdapter) | Matrix 去中心化通讯协议 |
+| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot11](https://github.com/ErisPulse/ErisPulse-OneBot11Adapter) | OneBot v11 通用机器人协议 |
+| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot12](https://github.com/ErisPulse/ErisPulse-OneBot12Adapter) | OneBot v12 标准协议 |
+| <img src=".github/assets/adapter_logo/qqbot.svg" height="20" alt="QQ" /> [QQ](https://github.com/ErisPulse/ErisPulse-QQBotAdapter) | QQ 官方机器人平台 |
+| <img src=".github/assets/adapter_logo/sandbox.png" height="20" alt="Sandbox" /> [沙箱](https://github.com/ErisPulse/ErisPulse-SandboxAdapter) | 网页端调试，无需接入真实平台 |
+| <img src=".github/assets/adapter_logo/telegram.svg" height="20" alt="Telegram" /> [Telegram](https://github.com/ErisPulse/ErisPulse-TelegramAdapter) | 全球性即时通讯平台 |
+| <img src=".github/assets/adapter_logo/email.svg" height="20" alt="Email" /> [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) | 邮件协议收发适配器 |
+| <img src=".github/assets/adapter_logo/yunhu.png" height="20" alt="Yunhu" /> [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) | 企业级即时通讯平台（机器人接入） |
+| [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) | 基于云湖用户协议的接入适配器 |
+| [花枫咖啡馆](https://github.com/ErisPulse/ErisPulse-Ideaura/) | Allons! \(・ω・) / |
+
+查看 [适配器详情介绍](docs/zh-CN/platform-guide/README.md)
+
+---
+
 ### 应用场景
 
 <div align="center">

{erispulse-2.4.6.dev4 → erispulse-2.4.6.dev5}/README.md

@@ -83,34 +83,40 @@
 
 ---
 
-### 支持的适配器
+### 快速开始
 
-<div align="center">
-<!-- <img src=".github/assets/adapter-showcase.png" width="520" alt="适配器展示" /> -->
+#### 一键安装脚本（推荐）
 
-欢迎您贡献适配器！
+安装脚本会自动检测您的环境（Docker、Python、uv），引导选择最适合的安装方式，支持多语言（中文/English/日本語/Русский/繁體中文）。
 
-| 适配器 | 说明 |
-|--------|------|
-| <img src=".github/assets/adapter_logo/kook.svg" height="20" alt="Kook" /> [Kook](https://github.com/shanfishapp/ErisPulse-KookAdapter) | Kook（开黑啦）即时通讯平台 |
-| <img src=".github/assets/adapter_logo/matrix.svg" height="20" alt="Matrix" /> [Matrix](https://github.com/ErisPulse/ErisPulse-MatrixAdapter) | Matrix 去中心化通讯协议 |
-| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot11](https://github.com/ErisPulse/ErisPulse-OneBot11Adapter) | OneBot v11 通用机器人协议 |
-| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot12](https://github.com/ErisPulse/ErisPulse-OneBot12Adapter) | OneBot v12 标准协议 |
-| <img src=".github/assets/adapter_logo/qqbot.svg" height="20" alt="QQ" /> [QQ](https://github.com/ErisPulse/ErisPulse-QQBotAdapter) | QQ 官方机器人平台 |
-| <img src=".github/assets/adapter_logo/sandbox.png" height="20" alt="Sandbox" /> [沙箱](https://github.com/ErisPulse/ErisPulse-SandboxAdapter) | 网页端调试，无需接入真实平台 |
-| <img src=".github/assets/adapter_logo/telegram.svg" height="20" alt="Telegram" /> [Telegram](https://github.com/ErisPulse/ErisPulse-TelegramAdapter) | 全球性即时通讯平台 |
-| <img src=".github/assets/adapter_logo/email.svg" height="20" alt="Email" /> [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) | 邮件协议收发适配器 |
-| <img src=".github/assets/adapter_logo/yunhu.png" height="20" alt="Yunhu" /> [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) | 企业级即时通讯平台（机器人接入） |
-| [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) | 基于云湖用户协议的接入适配器 |
-| [花枫咖啡馆](https://github.com/ErisPulse/ErisPulse-Ideaura/) | Allons! \(・ω・) / |
+Windows (PowerShell):
+```powershell
+irm https://get.erisdev.com/install.ps1 -OutFile install.ps1; powershell -ExecutionPolicy Bypass -File install.ps1
+```
 
-查看 [适配器详情介绍](docs/zh-CN/platform-guide/README.md)
+macOS / Linux:
+```bash
+curl -fsSL https://get.erisdev.com/install.sh -o install.sh && chmod +x install.sh && ./install.sh
+```
 
-</div>
+<table>
+<tr>
+<td align="center" width="50%">
 
----
+**Docker 安装演示**
 
-### 快速开始
+<video src="https://github.com/user-attachments/assets/a367a466-4678-46a9-b101-073a86388ede" controls width="100%"></video>
+
+</td>
+<td align="center" width="50%">
+
+**pip 安装演示**
+
+<video src="https://github.com/user-attachments/assets/a2df4009-dba6-411e-b79d-4454a168d063" controls width="100%"></video>
+
+</td>
+</tr>
+</table>
 
 #### 使用 Docker (推荐)
 
@@ -207,19 +213,28 @@ bash <(curl -sL https://get-1panel.erisdev.com/install.sh)
 pip install ErisPulse
 ```
 
-<img src=".github/assets/docs/install_pip.gif" alt="安装演示" />
-
-> 如果您的 Python 版本低于 3.10，可以使用一键安装脚本自动配置环境。详见 [安装脚本说明](scripts/install/)。
+> 也可以使用上方的一键安装脚本，自动检测环境并引导配置。
 
 #### 运行效果
 
 
 ##### 仪表盘：
-> 有一个gif，但是太大了没放到这里~ 抱歉~
-> [GIF演示](.github/assets/docs/dashboard-demo.gif)
+
+<table>
+<tr>
+<td width="50%">
 
 <img src=".github/assets/docs/dashboard.png" alt="Dashboard 演示" />
 
+</td>
+<td width="50%">
+
+<video src="https://github.com/user-attachments/assets/157191c4-9a84-433c-b311-0c57e3a21151" controls width="100%"></video>
+
+</td>
+</tr>
+</table>
+
 
 ##### 同一端代码，多个平台响应：
 
@@ -322,6 +337,28 @@ epsdk run main.py --reload
 
 ---
 
+### 支持的适配器
+
+欢迎您贡献适配器！
+
+| 适配器 | 说明 |
+|--------|------|
+| <img src=".github/assets/adapter_logo/kook.svg" height="20" alt="Kook" /> [Kook](https://github.com/shanfishapp/ErisPulse-KookAdapter) | Kook（开黑啦）即时通讯平台 |
+| <img src=".github/assets/adapter_logo/matrix.svg" height="20" alt="Matrix" /> [Matrix](https://github.com/ErisPulse/ErisPulse-MatrixAdapter) | Matrix 去中心化通讯协议 |
+| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot11](https://github.com/ErisPulse/ErisPulse-OneBot11Adapter) | OneBot v11 通用机器人协议 |
+| <img src=".github/assets/adapter_logo/onebot.png" height="20" alt="OneBot" /> [OneBot12](https://github.com/ErisPulse/ErisPulse-OneBot12Adapter) | OneBot v12 标准协议 |
+| <img src=".github/assets/adapter_logo/qqbot.svg" height="20" alt="QQ" /> [QQ](https://github.com/ErisPulse/ErisPulse-QQBotAdapter) | QQ 官方机器人平台 |
+| <img src=".github/assets/adapter_logo/sandbox.png" height="20" alt="Sandbox" /> [沙箱](https://github.com/ErisPulse/ErisPulse-SandboxAdapter) | 网页端调试，无需接入真实平台 |
+| <img src=".github/assets/adapter_logo/telegram.svg" height="20" alt="Telegram" /> [Telegram](https://github.com/ErisPulse/ErisPulse-TelegramAdapter) | 全球性即时通讯平台 |
+| <img src=".github/assets/adapter_logo/email.svg" height="20" alt="Email" /> [邮件](https://github.com/ErisPulse/ErisPulse-EmailAdapter) | 邮件协议收发适配器 |
+| <img src=".github/assets/adapter_logo/yunhu.png" height="20" alt="Yunhu" /> [云湖](https://github.com/ErisPulse/ErisPulse-YunhuAdapter) | 企业级即时通讯平台（机器人接入） |
+| [云湖用户](https://github.com/wsu2059q/ErisPulse-YunhuUserAdapter) | 基于云湖用户协议的接入适配器 |
+| [花枫咖啡馆](https://github.com/ErisPulse/ErisPulse-Ideaura/) | Allons! \(・ω・) / |
+
+查看 [适配器详情介绍](docs/zh-CN/platform-guide/README.md)
+
+---
+
 ### 应用场景
 
 <div align="center">

{erispulse-2.4.6.dev4 → erispulse-2.4.6.dev5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ErisPulse"
-version = "2.4.6-dev.4"
+version = "2.4.6-dev.5"
 description = "ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。"
 readme = "README.md"
 requires-python = ">=3.10"

erispulse-2.4.6.dev5/src/ErisPulse/Core/Bases/__init__.py

@@ -0,0 +1,25 @@
+"""
+ErisPulse 基础模块
+
+提供平台适配器、模块、存储后端、路由和客户端的基类与抽象接口
+"""
+
+from .adapter import SendDSL, RequestDSL, BaseAdapter
+from .module import BaseModule
+from .storage import BaseStorage, BaseQueryBuilder
+from .router import HttpRequest, WebSocketConnection, WebSocketDisconnect
+from .client import BaseHttpClient, BaseHttpResponse
+
+__all__ = [
+    "BaseAdapter",
+    "SendDSL",
+    "RequestDSL",
+    "BaseModule",
+    "BaseStorage",
+    "BaseQueryBuilder",
+    "HttpRequest",
+    "WebSocketConnection",
+    "WebSocketDisconnect",
+    "BaseHttpClient",
+    "BaseHttpResponse",
+]

{erispulse-2.4.6.dev4 → erispulse-2.4.6.dev5}/src/ErisPulse/Core/Bases/__init__.pyi

@@ -7,9 +7,11 @@
 """
 ErisPulse 基础模块
 
-提供平台适配器、模块和存储后端的基类
+提供平台适配器、模块、存储后端、路由和客户端的基类与抽象接口
 """
 
 from .adapter import SendDSL, RequestDSL, BaseAdapter
 from .module import BaseModule
 from .storage import BaseStorage, BaseQueryBuilder
+from .router import HttpRequest, WebSocketConnection, WebSocketDisconnect
+from .client import BaseHttpClient, BaseHttpResponse

erispulse-2.4.6.dev5/src/ErisPulse/Core/Bases/client.py

@@ -0,0 +1,227 @@
+"""
+ErisPulse HTTP 客户端抽象基类
+
+定义 HTTP 客户端和响应的抽象接口，使模块和适配器无需直接依赖 aiohttp。
+具体实现由 Core.client 模块提供（基于 aiohttp）。
+
+{!--< tips >!--}
+1. 支持 get / post / put / delete / patch / request 等常用方法
+2. 自动记录请求日志和统计信息
+3. 推荐所有模块和适配器使用此客户端发送 HTTP 请求
+{!--< /tips >!--}
+"""
+
+from __future__ import annotations
+
+from typing import Any
+from collections.abc import Callable
+
+
+class BaseHttpResponse:
+    """
+    HTTP 响应抽象基类
+
+    定义统一的响应访问接口，具体实现由 Core.client.HttpResponse 提供。
+
+    {!--< tips >!--}
+    通过 .raw 属性可访问底层原生响应对象
+    {!--< /tips >!--}
+
+    :example:
+    >>> resp = await sdk.client.get("https://httpbin.org/get")
+    >>> print(resp.status)
+    >>> data = await resp.json()
+    """
+
+    @property
+    def status(self) -> int:
+        """
+        HTTP 状态码
+
+        :return: int 状态码 (如 200, 404)
+        """
+        raise NotImplementedError
+
+    @property
+    def reason(self) -> str | None:
+        """
+        状态描述
+
+        :return: str | None 状态原因短语
+        """
+        raise NotImplementedError
+
+    @property
+    def headers(self):
+        """
+        响应头
+
+        :return: object 大小写不敏感的响应头映射
+        """
+        raise NotImplementedError
+
+    @property
+    def content_type(self) -> str | None:
+        """
+        Content-Type 值
+
+        :return: str | None 内容类型
+        """
+        raise NotImplementedError
+
+    @property
+    def url(self):
+        """
+        响应 URL (可能因重定向而与请求 URL 不同)
+
+        :return: object URL 对象
+        """
+        raise NotImplementedError
+
+    @property
+    def raw(self):
+        """
+        底层框架原生 Response 对象
+
+        :return: object 原生响应实例
+        """
+        raise NotImplementedError
+
+    async def read(self) -> bytes:
+        """
+        读取响应体原始字节
+
+        :return: bytes 响应体内容
+        """
+        raise NotImplementedError
+
+    async def text(self, encoding: str | None = None) -> str:
+        """
+        读取响应体为文本
+
+        :param encoding: str | None 指定编码 (可选, 默认自动检测)
+        :return: str 文本内容
+        """
+        raise NotImplementedError
+
+    async def json(self, **kwargs) -> Any:
+        """
+        解析响应体为 JSON
+
+        :param kwargs: 传递给解析器的额外参数
+        :return: Any 解析后的数据
+        """
+        raise NotImplementedError
+
+
+class BaseHttpClient:
+    """
+    HTTP 客户端抽象基类
+
+    定义统一的异步 HTTP 请求接口，具体实现由 Core.client.HttpClient 提供。
+
+    {!--< tips >!--}
+    1. 通过 sdk.client 获取全局单例，也可自行实例化
+    2. 使用 get/post/put/delete/patch 快捷方法或通用 request 方法
+    3. 推荐所有模块和适配器使用此客户端发送 HTTP 请求
+    {!--< /tips >!--}
+
+    :example:
+    >>> resp = await sdk.client.get("https://httpbin.org/get")
+    >>> data = await resp.json()
+    """
+
+    async def request(
+        self,
+        method: str,
+        url: str,
+        *,
+        params: dict[str, str] | None = None,
+        headers: dict[str, str] | None = None,
+        data: Any = None,
+        json: Any = None,
+        timeout: float | None = None,
+        max_retries: int | None = None,
+        **kwargs,
+    ) -> BaseHttpResponse:
+        """
+        发送 HTTP 请求
+
+        :param method: str HTTP 方法 (GET, POST, PUT, DELETE, PATCH 等)
+        :param url: str 请求 URL
+        :param params: dict[str, str] | None 查询参数 (可选)
+        :param headers: dict[str, str] | None 额外请求头 (可选)
+        :param data: Any 请求体 (表单或原始数据) (可选)
+        :param json: Any JSON 请求体 (可选)
+        :param timeout: float | None 本次请求超时 (秒) (可选, 覆盖默认值)
+        :param max_retries: int | None 本次最大重试次数 (可选, 覆盖默认值)
+        :param kwargs: 传递给底层请求的额外参数
+        :return: BaseHttpResponse 响应对象
+        """
+        raise NotImplementedError
+
+    async def get(self, url: str, **kwargs) -> BaseHttpResponse:
+        """
+        发送 GET 请求
+
+        :param url: str 请求 URL
+        :return: BaseHttpResponse 响应对象
+        """
+        return await self.request("GET", url, **kwargs)
+
+    async def post(self, url: str, **kwargs) -> BaseHttpResponse:
+        """
+        发送 POST 请求
+
+        :param url: str 请求 URL
+        :return: BaseHttpResponse 响应对象
+        """
+        return await self.request("POST", url, **kwargs)
+
+    async def put(self, url: str, **kwargs) -> BaseHttpResponse:
+        """
+        发送 PUT 请求
+
+        :param url: str 请求 URL
+        :return: BaseHttpResponse 响应对象
+        """
+        return await self.request("PUT", url, **kwargs)
+
+    async def delete(self, url: str, **kwargs) -> BaseHttpResponse:
+        """
+        发送 DELETE 请求
+
+        :param url: str 请求 URL
+        :return: BaseHttpResponse 响应对象
+        """
+        return await self.request("DELETE", url, **kwargs)
+
+    async def patch(self, url: str, **kwargs) -> BaseHttpResponse:
+        """
+        发送 PATCH 请求
+
+        :param url: str 请求 URL
+        :return: BaseHttpResponse 响应对象
+        """
+        return await self.request("PATCH", url, **kwargs)
+
+    async def close(self) -> None:
+        """
+        关闭客户端会话并释放资源
+        """
+        raise NotImplementedError
+
+    @property
+    def stats(self) -> dict[str, int]:
+        """
+        请求统计
+
+        :return: dict[str, int] 统计数据
+        """
+        raise NotImplementedError
+
+    def reset_stats(self) -> None:
+        """
+        重置统计数据
+        """
+        raise NotImplementedError