[Priority: Low] [Enhancement] 明确 Python API facade 导出契约
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- python
- Bereich
- backend-api-design
Rechercherichtung
Beginne mit src/opencode_a2a/contracts/extensions/init.py und untersuche dessen Produktionsnutzer sowie die vorhandenen Vertragstests. Ermittle und dokumentiere, ob diese Fassade stabil oder intern ist, und verfolge anschließend den ausgewählten Pfad: Definiere die minimalen all- und Import-Vertragstests oder plane schrittweise Importe aus den Definitionsmodulen. Führe bash ./scripts/doctor.sh aus und überprüfe die Abnahmekriterien.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
背景
在 #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 的兼容性复核经验。
- Vorherrschende Sprache
- Python
- Sterne
- 38
- Forks
- 13
- Ø Merge
- 3 Std. 43 Min.
- Gemergte PRs (30 T.)
- 4
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus Intelligent-Internet/opencode-a2a
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 20/100
Intelligent-Internet/opencode-a2a#550 · 3 Kommentare · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
status:todo
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 42/100
Intelligent-Internet/opencode-a2a#451 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in Intelligent-Internet/opencode-a2a
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
UKGovernmentBEIS/inspect_ai#6512 ·
Maintainer antworten meist innerhalb von 1 Tag
-
area/c++ area/core kind/bug-report
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
tensorflow/quantum#1140 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
Kav-K/GPTDiscord#501 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
UKGovernmentBEIS/inspect_evals#2863 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag