python-tty 0.1.4__tar.gz → 0.1.6__tar.gz

{python_tty-0.1.4/src/python_tty.egg-info → python_tty-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-tty
-Version: 0.1.4
+Version: 0.1.6
 Summary: A multi-console TTY framework for complex CLI/TTY apps
 Home-page: https://github.com/ROOKIEMIE/python-tty
 Author: ROOKIEMIE
@@ -12,8 +12,12 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
+Requires-Dist: fastapi>=0.110.0
+Requires-Dist: grpcio>=1.60.0
 Requires-Dist: prompt_toolkit>=3.0.32
+Requires-Dist: protobuf>=4.25.0
 Requires-Dist: tqdm
+Requires-Dist: uvicorn>=0.27.0
 Dynamic: author
 Dynamic: classifier
 Dynamic: description

{python_tty-0.1.4 → python_tty-0.1.6}/docs/LOG.md

@@ -1,5 +1,74 @@
 # 阶段记录
 
+## 2026/01/27/02
+
+1. rpc侧应该模仿console/core模块中execute和run方法的实现，重新构建invocation并投递至executor，source为rpc。不要复用现有console的submit过程，应该形成一条独立的submit过程。
+2. 新增runtime.proto。
+3. 新增grpc aio server，协程模式。
+
+## 2026/01/27/01
+
+目标:
+1. 把框架的整体结构并发式地跑起来：
+一个进程，两类 event loop：
+- 主线程：一个 asyncio loop
+   - FastAPI（Meta API：HTTP + WS）
+   - gRPC aio server（Invoke + StreamEvents）
+   - CommandExecutor（作为“唯一运行时入口”，最好也在这个 loop 上）
+- TTY 线程：一个独立线程
+   - prompt_toolkit 的 PromptSession/应用运行（它内部也会用 asyncio，但你可以在这个线程里创建自己的 loop 或让 prompt_toolkit 管理）
+   - TTY 发起命令：通过 submit_threadsafe() 把 invocation 投递到主线程 executor loop
+   - 输出：OutputRouter 把事件安全地写回 TTY（run_in_terminal / patch_stdout 等）
+2. 原始的V2开发规划：
+- Step 0：把 Executor 插进去（让命令可后台执行）
+   - 把 BaseConsole.execute 改成 submit invocation
+   - TTY 调用也走 executor
+   - 先用同步等待结果也行，但建议至少把执行从 console loop 中剥离
+- Step 1：定义 Invocation / Run / Event 三个核心数据结构
+   - 这是 Web/RPC/TTY 共用的“运行时协议”
+   - 有了它，Meta/RPC 都只是“外壳”
+- Step 2：Meta Descriptor v1（argv-only）
+   - 从 registry 导出 consoles/commands/argspec(min/max)
+   - revision hash
+- Step 3：RPC proto v1（Invoke + StreamEvents）
+   - 先走通 unary invoke + server streaming 事件
+- Step 4：Meta HTTP/WS server（只读）
+   - /meta + ws snapshot
+   - ETag 缓存
+- Step 5：把 allowlist + audit + mTLS 完整接入 RPC
+   - RPC 默认 deny
+   - 命令必须显式 exposure.rpc=true 才可调用
+   - audit 强制落盘
+
+下一步规划:
+1. RPC proto + aio server：直接复用你现有 Invocation/RunState/RuntimeEvent，把 RuntimeEvent 流映射为 gRPC server streaming。
+2. Meta HTTP/WS：GET /meta 返回 export_meta()，ETag = revision（你已算出 revision）。WS snapshot 可先做“连接后推一次 meta+revision”，后续再做增量。
+3. Web实现位于frontends/web，RPC实现位于frontends/rpc；根据需要可以进一步增加子包。
+
+## 2026/01/26/02
+
+1. 修改了OutputRouter的emit，使之可以输出STATE。
+2. 就目前的实现来说“全量输出审计”仅针对executor生效，对于proxy_print以及ConsoleHandler暂不生效；需要为OutputRouter增加一个attach_audit_sink方法，从而允许在factory中将auditsink注入其中，任何地方只要走 OutputRouter，就会被审计（如果开启）。
+3. 为ConsoleRegistry 增加公开读取 API（例如 iter_consoles() / get_root() / get_subs()），meta 不要直接获取私有成员；meta v1 就带上 ConsoleManager 里已经维护了的 tree: {root, children} 或在 console entry 上带 children: []，之后外部系统生成 UI/适配更简单。
+
+## 2026/01/26/01
+
+1. 为UIEvent补充三个字段
+   - source: "tty" | "rpc" | "framework" | "service"（输入源：框架tty、rpc、使用者custom调用输出）
+   - ts/seq: 时间戳/序号（用于审计与重放顺序稳定）
+2. 增加一个类AuditSink，用以实现“Invocation + RunState + Events”落盘，audit的完整传递路径为：Executor 发出 state/log/stdout 事件 → OutputRouter 渲染其中 stdout/log → AuditSink 把“Invocation + RunState + Events”落盘。目前utils包中的ui_logger模块似乎并没有使用，我认为是使用增加一个包，叫做audit，然后将这个模块移至audit包下重命名并重构其中的实现，以满足这里对于audit落盘的需要。
+3. 把框架的整体结构并发式地跑起来：
+一个进程，两类 event loop：
+- 主线程：一个 asyncio loop
+   - FastAPI（Meta API：HTTP + WS）
+   - gRPC aio server（Invoke + StreamEvents）
+   - CommandExecutor（作为“唯一运行时入口”，最好也在这个 loop 上）
+- TTY 线程：一个独立线程
+   - prompt_toolkit 的 PromptSession/应用运行（它内部也会用 asyncio，但你可以在这个线程里创建自己的 loop 或让 prompt_toolkit 管理）
+   - TTY 发起命令：通过 submit_threadsafe() 把 invocation 投递到主线程 executor loop
+   - 输出：OutputRouter 把事件安全地写回 TTY（run_in_terminal / patch_stdout 等）
+4. 给出一个初步的meta实现（目前meta包中的实现还是空的），需要从从 registry 导出 consoles/commands/argspec 的 JSON（或 dict）结构；revision hash：未看到对 meta 做 canonical 序列化并生成 hash/ETag 的实现。
+
 ## 2026/01/24/01
 
 目前存在问题及初步解决方案：
@@ -205,13 +274,11 @@ BaseConsole.execute(cmd)：
       收益：你从“一个 TTY 框架作者”升级成“一个 CLI+API 双栈控制平面作者”。
 
 
-
 ## 2024/03/29
 
 Demo中的File Manager正在开发中......
 
 
-
 ## 2024/03/27
 为BaseCommand中的校验器CommandValidator添加了一个变量``` enable_undefined_command ```，
 用于控制Console级别的校验器是否在用户输入一些非命令时的拦截行为，该变量在BaseCommand构造时将传入Console校验器CommandValidator中，