ErisPulse-TerminalAdapter 1.0.0__py3-none-any.whl

TerminalAdapter/Core.py

@@ -0,0 +1,301 @@
+"""TerminalAdapter：把命令行标准输入/输出作为消息通道，用于本地开发调试。
+
+终端输入的每一行即一条私聊消息，Bot 的回复通过 SendDSL 打印到终端。
+"""
+
+from __future__ import annotations
+
+import asyncio
+import sys
+import time
+import uuid
+from dataclasses import dataclass, field
+from typing import Any
+
+from ErisPulse.Core import BaseAdapter, SendDSL
+from ErisPulse.Core.Bases import BaseConfig, BaseI18n, I18nKey
+
+
+class TerminalAdapter(BaseAdapter):
+    """终端适配器：命令行即聊天会话，用于本地开发调试。"""
+
+    _platform = "terminal"
+
+    @dataclass
+    class ConfigClass(BaseConfig):
+        bot_id: str = field(
+            default="terminal_bot",
+            metadata={
+                "description": "Bot 的用户 ID",
+                "ui": {"widget": "text", "group": "basic", "order": 1},
+            },
+        )
+        bot_name: str = field(
+            default="TerminalBot",
+            metadata={
+                "description": "Bot 昵称",
+                "ui": {"widget": "text", "group": "basic", "order": 2},
+            },
+        )
+        user_id: str = field(
+            default="terminal_user",
+            metadata={
+                "description": "模拟用户的 ID（与 Bot 对话的终端用户）",
+                "ui": {"widget": "text", "group": "basic", "order": 3},
+            },
+        )
+        user_name: str = field(
+            default="User",
+            metadata={
+                "description": "模拟用户昵称",
+                "ui": {"widget": "text", "group": "basic", "order": 4},
+            },
+        )
+        prompt: str = field(
+            default="> ",
+            metadata={
+                "description": "输入提示符",
+                "ui": {"widget": "text", "group": "ui", "order": 5},
+            },
+        )
+        reply_prefix: str = field(
+            default="[Bot] ",
+            metadata={
+                "description": "Bot 回复的行前缀（留空则不加前缀）",
+                "ui": {"widget": "text", "group": "ui", "order": 6},
+            },
+        )
+        echo_input: bool = field(
+            default=False,
+            metadata={
+                "description": "是否回显用户输入（管道输入场景下开启）",
+                "ui": {"widget": "switch", "group": "ui", "order": 7},
+            },
+        )
+
+    class I18nClass(BaseI18n):
+        welcome: I18nKey = I18nKey(
+            default="Terminal adapter started. Type a message to chat with the Bot. Ctrl+C / EOF to quit.",
+            zh_CN="终端适配器已启动。直接输入消息即可与 Bot 对话，Ctrl+C 或 EOF 退出。",
+            zh_TW="終端介面卡已啟動。直接輸入訊息即可與 Bot 對話，Ctrl+C 或 EOF 退出。",
+            en="Terminal adapter started. Type a message to chat with the Bot. Ctrl+C / EOF to quit.",
+            ja="ターミナルアダプターが起動しました。メッセージを入力して Bot と会話できます。Ctrl+C / EOF で終了。",
+            ru="Терминальный адаптер запущен. Введите сообщение для общения с ботом. Ctrl+C / EOF — выход.",
+        )
+        goodbye: I18nKey = I18nKey(
+            default="Terminal adapter stopped.",
+            zh_CN="终端适配器已停止。",
+            zh_TW="終端介面卡已停止。",
+            en="Terminal adapter stopped.",
+            ja="ターミナルアダプターを停止しました。",
+            ru="Терминальный адаптер остановлен.",
+        )
+        input_hint: I18nKey = I18nKey(
+            default="Use /help to list commands.",
+            zh_CN="输入 /help 查看可用命令。",
+            zh_TW="輸入 /help 查看可用指令。",
+            en="Use /help to list commands.",
+            ja="/help でコマンド一覧を表示。",
+            ru="Введите /help для списка команд.",
+        )
+
+    class Send(SendDSL):
+        """终端发送 DSL：把 OB12 消息段渲染为文本打印到 stdout。"""
+
+        def Raw_ob12(self, message, **kwargs):
+
+            async def _do_send():
+                segments = self._apply_modifiers(message)
+                text = self._adapter._render_segments(segments)
+                self._adapter._output(text)
+                return self._adapter.make_response(
+                    message_id=str(uuid.uuid4()),
+                    data={"text": text, **self.send_context},
+                )
+
+            return asyncio.create_task(_do_send())
+
+    def __init__(self, sdk=None):
+        super().__init__(sdk)
+        self._running = False
+        self._read_task: asyncio.Task | None = None
+
+    async def start(self) -> None:
+        """启动适配器：上线 Bot、打印欢迎语、启动 stdin 读取循环"""
+        cfg = self.cfg
+        self._running = True
+
+        await self.emit_meta("connect", cfg.bot_id, user_name=cfg.bot_name, avatar="")
+
+        try:
+            from ErisPulse import i18n
+
+            say = i18n.t
+        except Exception:
+
+            def say(key, default=None):
+                return default or key
+
+        self._write_raw("\n")
+        self._output_raw(say("TerminalAdapter.welcome"))
+        self._output_raw(say("TerminalAdapter.input_hint"))
+        self._write_raw("\n")
+
+        self._read_task = asyncio.create_task(self._read_loop())
+        self.logger.info("TerminalAdapter 已启动")
+
+    async def shutdown(self) -> None:
+        """关闭适配器：停止读取、下线 Bot"""
+        self._running = False
+        if self._read_task and not self._read_task.done():
+            self._read_task.cancel()
+            try:
+                await self._read_task
+            except (asyncio.CancelledError, Exception):
+                pass
+
+        cfg = self.cfg
+        try:
+            from ErisPulse import i18n
+
+            self._output_raw(i18n.t("TerminalAdapter.goodbye"))
+        except Exception:
+            pass
+
+        await self.emit_meta("disconnect", cfg.bot_id)
+        self.logger.info("TerminalAdapter 已关闭")
+
+    def on_config_update(self, old_config, new_config):
+        """配置热更新回调"""
+        self.logger.info("TerminalAdapter 配置已热更新")
+
+    async def call_api(self, endpoint: str, **params: Any) -> dict:
+        """模拟常用平台 API，使框架标准动作可用。"""
+        cfg = self.cfg
+
+        if endpoint == "get_self_info":
+            return self.make_response(data={"user_id": cfg.bot_id, "user_name": cfg.bot_name, "platform": "terminal"})
+        if endpoint == "get_user_info":
+            uid = str(params.get("user_id", cfg.user_id))
+            is_bot = uid == cfg.bot_id
+            return self.make_response(
+                data={
+                    "user_id": uid,
+                    "user_name": cfg.bot_name if is_bot else cfg.user_name,
+                    "user_displayname": cfg.bot_name if is_bot else cfg.user_name,
+                    "platform": "terminal",
+                }
+            )
+        if endpoint in ("get_friend_list", "get_user_list"):
+            return self.make_response(data=[{"user_id": cfg.user_id, "user_name": cfg.user_name}])
+        if endpoint == "get_group_list":
+            return self.make_response(data=[])  # 终端无群组
+        if endpoint in ("get_group_info", "get_group_member_info", "get_group_member_list"):
+            return self.make_error(retcode=10002, message="终端适配器不支持群组操作")
+        if endpoint == "send_message":
+            return self.make_response(message_id=str(uuid.uuid4()))
+        if endpoint == "delete_message":
+            return self.make_response()  # 终端无法撤回，返回成功
+
+        return self.make_error(retcode=10002, message=f"终端适配器不支持 {endpoint}")
+
+    async def _read_loop(self) -> None:
+        """异步读取 stdin：每行作为一条私聊消息 emit 给框架。"""
+        loop = asyncio.get_running_loop()
+        cfg = self.cfg
+
+        while self._running:
+            try:
+                self._write_raw(cfg.prompt)
+                line = await loop.run_in_executor(None, sys.stdin.readline)
+                if not line:
+                    # EOF（无更多输入）
+                    break
+                text = line.rstrip("\r\n")
+                if not text:
+                    continue
+                if cfg.echo_input:
+                    self._output_raw(f"< {text}")
+                await self._handle_input(text)
+            except asyncio.CancelledError:
+                break
+            except Exception as e:
+                self.logger.warning(f"读取 stdin 失败: {e}")
+                await asyncio.sleep(0.5)
+
+    async def _handle_input(self, text: str) -> None:
+        """把一行文本构造为 OB12 message 事件并 emit"""
+        cfg = self.cfg
+        try:
+            from ErisPulse.Core.adapter import adapter as adapter_mgr
+        except ImportError:
+            self.logger.error("无法访问 adapter manager")
+            return
+
+        event = {
+            "id": str(uuid.uuid4()),
+            "time": int(time.time()),
+            "type": "message",
+            "detail_type": "private",
+            "platform": "terminal",
+            "self": {
+                "platform": "terminal",
+                "user_id": cfg.bot_id,
+                "user_name": cfg.bot_name,
+            },
+            "user_id": cfg.user_id,
+            "message": [{"type": "text", "data": {"text": text}}],
+            "alt_message": text,
+            "terminal_raw": {"text": text},
+            "terminal_raw_type": "stdin_line",
+        }
+        await adapter_mgr.emit(event)
+
+    @staticmethod
+    def _render_segments(segments: list[dict]) -> str:
+        parts: list[str] = []
+        for seg in segments:
+            seg_type = seg.get("type", "")
+            data = seg.get("data", {}) or {}
+            if seg_type == "text":
+                parts.append(str(data.get("text", "")))
+            elif seg_type == "image":
+                parts.append(f"[image: {data.get('file', '')}]")
+            elif seg_type == "audio":
+                parts.append(f"[voice: {data.get('file', '')}]")
+            elif seg_type == "video":
+                parts.append(f"[video: {data.get('file', '')}]")
+            elif seg_type == "file":
+                parts.append(f"[file: {data.get('file', '')}]")
+            elif seg_type == "mention":
+                parts.append(f"@{data.get('user_id', '')}")
+            elif seg_type == "mention_all":
+                parts.append("@all")
+            elif seg_type == "reply":
+                parts.append(f"[reply:{data.get('message_id', '')}]")
+            else:
+                parts.append(f"[{seg_type}]")
+        return "".join(parts)
+
+    def _output(self, text: str) -> None:
+        """带 Bot 前缀地输出一段文本（多行逐行加前缀）"""
+        prefix = self.cfg.reply_prefix or ""
+        for line in str(text).split("\n"):
+            self._write_raw(prefix + line + "\n")
+
+    def _output_raw(self, text: str) -> None:
+        """原样输出一段文本（不加前缀，自动换行）"""
+        if text:
+            self._write_raw(str(text) + "\n")
+
+    @staticmethod
+    def _write_raw(s: str) -> None:
+        """底层写 stdout"""
+        try:
+            sys.stdout.write(s)
+            sys.stdout.flush()
+        except Exception:
+            pass
+
+
+__all__ = ["TerminalAdapter"]

TerminalAdapter/__init__.py

@@ -0,0 +1,3 @@
+from .Core import TerminalAdapter
+
+__all__ = ["TerminalAdapter"]

erispulse_terminaladapter-1.0.0.dist-info/METADATA

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: ErisPulse-TerminalAdapter
+Version: 1.0.0
+Summary: ErisPulse TerminalAdapter - 终端适配器
+Project-URL: homepage, https://github.com/ErisPulse/ErisPulse-TerminalAdapter
+Project-URL: repository, https://github.com/ErisPulse/ErisPulse-TerminalAdapter
+Project-URL: ErisPulse, https://github.com/ErisPulse/ErisPulse
+Author: ErisDev
+License: MIT License
+        
+        Copyright (c) 2026 ErisPulse
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: adapter,cli,debug,erispulse,terminal
+Requires-Python: >=3.10
+Requires-Dist: erispulse>=2.7.0
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<img src=".github/assets/logo.png" width="180" alt="ErisPulse TerminalAdapter" />
+
+# ErisPulse TerminalAdapter
+
+**The terminal is the chat — develop and test your Bot with zero platform setup.**
+
+A terminal adapter for [ErisPulse](https://github.com/ErisPulse/ErisPulse). Each line you type in the terminal is emitted as a private message, and the bot's replies are printed back to stdout. Handy for developing and testing handlers without registering a real platform.
+
+<p>
+  <a href="https://pypi.org/project/ErisPulse-TerminalAdapter/"><img src="https://img.shields.io/pypi/v/ErisPulse-TerminalAdapter?style=for-the-badge&logo=pypi&logoColor=white" alt="PyPI"></a>
+  <a href="https://pypi.org/project/ErisPulse-TerminalAdapter/"><img src="https://img.shields.io/badge/Python-3.10+-FFD43B?style=for-the-badge&logo=python&logoColor=blue" alt="Python"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=for-the-badge" alt="License"></a>
+  <a href="https://github.com/ErisPulse/ErisPulse-TerminalAdapter"><img src="https://img.shields.io/github/stars/ErisPulse/ErisPulse-TerminalAdapter?style=for-the-badge&logo=github&color=brightgreen" alt="Stars"></a>
+  <a href="https://pepy.tech/project/ErisPulse-TerminalAdapter"><img src="https://img.shields.io/pepy/dt/ErisPulse-TerminalAdapter?style=for-the-badge&color=blue" alt="Downloads"></a>
+  <a href="https://github.com/ErisPulse/ErisPulse"><img src="https://img.shields.io/badge/Powered_by-ErisPulse-FF6B9D?style=for-the-badge&logo=bookstack&logoColor=white" alt="ErisPulse"></a>
+</p>
+
+[English](#english) | [简体中文](#简体中文)
+
+</div>
+
+---
+
+<a id="english"></a>
+
+## English
+
+### Features
+
+- **Zero config** — no platform account or token needed, install and run
+- **One line, one message** — every line typed in the terminal becomes a private message that triggers command / module handlers
+- **Replies printed to stdout** — the bot's SendDSL replies are printed with a `[Bot]` prefix
+- **Standard actions work** — `get_user_info` / `get_self_info` / `get_friend_list` return mock data so framework standard actions keep working
+- **Readable rendering** — non-text segments (image / voice / file / mention ...) render as readable placeholders
+- **i18n aware** — welcome / goodbye / hint messages follow the framework's `i18n` language
+
+### Install
+
+```bash
+pip install ErisPulse-TerminalAdapter
+```
+
+Requires ErisPulse >= 2.7.0.
+
+### Configuration
+
+`config.toml`:
+
+```toml
+[TerminalAdapter]
+bot_id = "terminal_bot"
+bot_name = "TerminalBot"
+user_id = "terminal_user"
+user_name = "User"
+prompt = "> "
+reply_prefix = "[Bot] "
+echo_input = false
+```
+
+| Field | Default | Description |
+|------|---------|-------------|
+| `bot_id` | `terminal_bot` | Bot user ID |
+| `bot_name` | `TerminalBot` | Bot nickname |
+| `user_id` | `terminal_user` | Mocked user ID (the terminal user chatting with the bot) |
+| `user_name` | `User` | Mocked user nickname |
+| `prompt` | `> ` | Input prompt |
+| `reply_prefix` | `[Bot] ` | Prefix prepended to each bot reply line (empty for none) |
+| `echo_input` | `false` | Echo user input (useful for piped input) |
+
+The adapter registers under platform name `terminal` and exposes a single private-chat session (no groups).
+
+### Usage
+
+After `epsdk run`, the terminal becomes the chat:
+
+```
+> Terminal adapter started. Type a message to chat with the Bot. Ctrl+C / EOF to quit.
+> Use /help to list commands.
+
+> /hello
+[Bot] Hello, User!
+> ping
+[Bot] ...
+```
+
+You can also pipe input in, which is handy for automated testing:
+
+```bash
+echo "/hello" | epsdk run main.py
+```
+
+Non-text segments render as placeholders (`[image: url]`, `[voice: url]`, `@user_id`, ...). Group-related actions are unsupported (no groups in a terminal).
+
+### Notes
+
+- `stdin` is read in a worker thread, so on shutdown the reader only returns after the next line or EOF (Ctrl+D / Ctrl+Z).
+- Welcome / goodbye / hint messages follow the framework's `i18n` language setting.
+
+---
+
+<a id="简体中文"></a>
+
+## 简体中文
+
+### 特性
+
+- **零配置即用** —— 不需要注册任何平台账号、不需要 token，装上就能跑
+- **一行一消息** —— 终端里每输入一行即一条私聊消息，直接触发命令 / 模块处理器
+- **回复即打印** —— Bot 通过 SendDSL 回复的内容带 `[Bot]` 前缀打印到 stdout
+- **标准动作可用** —— `get_user_info` / `get_self_info` / `get_friend_list` 等返回模拟数据，框架标准动作照常工作
+- **多段渲染** —— 非文本消息段（图片 / 语音 / 文件 / @ 等）渲染成可读占位符
+- **i18n 跟随** —— 欢迎语 / 退出语跟随框架 `i18n` 语言设置
+
+### 安装
+
+```bash
+pip install ErisPulse-TerminalAdapter
+```
+
+需要 ErisPulse >= 2.7.0。
+
+### 配置
+
+`config.toml`：
+
+```toml
+[TerminalAdapter]
+bot_id = "terminal_bot"
+bot_name = "TerminalBot"
+user_id = "terminal_user"
+user_name = "User"
+prompt = "> "
+reply_prefix = "[Bot] "
+echo_input = false
+```
+
+| 字段 | 默认值 | 说明 |
+|------|--------|------|
+| `bot_id` | `terminal_bot` | Bot 的用户 ID |
+| `bot_name` | `TerminalBot` | Bot 昵称 |
+| `user_id` | `terminal_user` | 模拟用户的 ID（与 Bot 对话的终端用户）|
+| `user_name` | `User` | 模拟用户昵称 |
+| `prompt` | `> ` | 输入提示符 |
+| `reply_prefix` | `[Bot] ` | Bot 回复的行前缀（留空则不加前缀）|
+| `echo_input` | `false` | 是否回显用户输入（管道输入场景下开启）|
+
+适配器注册的平台名为 `terminal`，只有一个私聊会话，没有群组概念。
+
+### 使用
+
+`epsdk run` 启动后，终端就是聊天窗口：
+
+```
+> 终端适配器已启动。直接输入消息即可与 Bot 对话，Ctrl+C 或 EOF 退出。
+> 输入 /help 查看可用命令。
+
+> /hello
+[Bot] Hello, User!
+> ping
+[Bot] ...
+```
+
+也可以通过管道喂入，便于自动化测试：
+
+```bash
+echo "/hello" | epsdk run main.py
+```
+
+非文本消息段会渲染成占位符（`[image: url]`、`[voice: url]`、`@user_id` 等）。群组相关操作不支持（终端无群组）。
+
+### 说明
+
+- `stdin` 在独立线程中读取，关闭时需等到下一行或 EOF（Ctrl+D / Ctrl+Z）才会退出。
+- 欢迎语 / 退出语 / 提示语跟随框架 `i18n` 语言设置。
+
+---
+
+<div align="center">
+
+**Related** · [ErisPulse](https://github.com/ErisPulse/ErisPulse) · [Documentation](https://www.erisdev.com) · [Issues](https://github.com/ErisPulse/ErisPulse-TerminalAdapter/issues)
+
+</div>

erispulse_terminaladapter-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+TerminalAdapter/Core.py,sha256=fAYtWkQEBzqn_f8WEZrNSjYp5z9rmvZScQu6pRNDiXE,11540
+TerminalAdapter/__init__.py,sha256=sHIRa0KwCO9CYX-64uh54PFHP2g2Ce5KZKm67vZjBCc,65
+erispulse_terminaladapter-1.0.0.dist-info/METADATA,sha256=incdjH2WTL6ML0rPX4ZuPtcfKR0UTU0zUpVBqDAZcvA,8270
+erispulse_terminaladapter-1.0.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+erispulse_terminaladapter-1.0.0.dist-info/entry_points.txt,sha256=I92EU7dtLXBtuONFzOiYDCBz2CH2jFHZ_vvxZpZdb_g,63
+erispulse_terminaladapter-1.0.0.dist-info/licenses/LICENSE,sha256=x-M-f1_UtTUReGL_ZHkep-yEwmFtH1fPXpMBIN-MHvU,1066
+erispulse_terminaladapter-1.0.0.dist-info/RECORD,,

erispulse_terminaladapter-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

erispulse_terminaladapter-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[erispulse.adapter]
+terminal = TerminalAdapter:TerminalAdapter

erispulse_terminaladapter-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ErisPulse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.