[Priority: Low] [Enhancement] 明确 Python API facade 导出契约
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 活跃
- 技术栈
- python
调研方向
从 src/opencode_a2a/contracts/extensions/init.py 开始，检查其生产消费者和现有的契约测试。确定并记录此 facade 是稳定的还是内部的，然后遵循选定的路径：定义最小的 all 和导入契约测试，或规划从定义模块逐步导入。运行 bash ./scripts/doctor.sh 并验证验收标准。
由索引模型根据 Issue 内容生成。
描述
背景
在 #518 的冗余清理与跨仓库 facade 风险对照中发现，src/opencode_a2a/contracts/extensions/__init__.py 是仓库实际使用的聚合导入入口，目前通过 # ruff: noqa: F401 表达 re-export，但没有显式 __all__ 或独立 facade import contract tests。
当前没有功能故障：该入口有生产代码和契约测试消费者，不会被合理的死代码审查判定为无消费者模块。本 issue 仅作为低优先级 API 治理备忘，不代表现有全部 re-export 已经被承诺为长期稳定的公共 Python API。
需要明确的问题
opencode_a2a.contracts.extensions是否应作为受支持的稳定 Python API facade？- 若是，哪些 symbols 属于有意公开的最小集合，哪些应继续从定义模块导入？
- 稳定性承诺是否只覆盖
client/__init__.py，还是还应覆盖 contracts facade？ py.typed发布与 Python API 兼容策略应如何在文档和测试中体现？
建议方案
- 先记录仓库支持的 Python API 边界，避免仅凭当前导入形状隐式扩大兼容承诺。
- 若确认
contracts.extensions是稳定 facade：- 添加显式
__all__，仅列出有意公开的 symbols； - 添加 package/facade import contract tests；
- 验证 wheel 中的导入路径和类型信息；
- 在兼容性文档中说明变更与弃用策略。
- 添加显式
- 若不承诺该 facade：
- 明确其 internal/convenience 定位；
- 逐步让仓库内部消费者从真实定义模块导入，避免形成更强的事实 API。
非目标
- 不在本 issue 中改变 A2A wire contract、Agent Card、OpenAPI 或 JSON-RPC 行为。
- 不因为添加
__all__就自动承诺当前全部 re-export 永久稳定。 - 不与 #515 的 SDK 升级和 compatibility layer 审计混合实施。
验收标准
- 明确记录受支持的 Python API/facade 边界。
- 对
contracts.extensions作出“稳定 facade”或“内部便利入口”的明确决定。 - 若选择稳定 facade，添加最小显式
__all__和 import contract tests。 - 若选择内部入口，制定不破坏当前仓库调用的渐进收敛方案。
- 执行
bash ./scripts/doctor.sh。
关联
- Follow-up from #518
- 参考跨仓库
https://github.com/liujuanjuan1984/codex-a2a/pull/358中对已发布 JSON-RPC params facade 的兼容性复核经验。
- 主要语言
- Python
- 星标
- 38
- 派生
- 13
- 平均合并
- 3 小时 43 分钟
- 30 天内合并 PR
- 4
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Intelligent-Internet/opencode-a2a 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 20/100
Intelligent-Internet/opencode-a2a#550 · 3 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
status:todo
难度 5/5 一周以上 新手友好度 42/100
Intelligent-Internet/opencode-a2a#451 · 3 条评论 ·
维护者通常 1 天内回复
查看 Intelligent-Internet/opencode-a2a 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
UKGovernmentBEIS/inspect_ai#6512 ·
维护者通常 1 天内回复
-
area/c++ area/core kind/bug-report
难度 2/5 1-3 小时 新手友好度 78/100
tensorflow/quantum#1140 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 68/100
Kav-K/GPTDiscord#501 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
UKGovernmentBEIS/inspect_evals#2863 · 1 条评论 ·
维护者通常 1 天内回复