Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[v2][Python] Make generated implementation modules private

未关闭
#2,048 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
55/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
api

调研方向

从 python/copilot/generated/init.py、python/copilot/rpc.py、python/copilot/session_events.py 以及生成的 rpc.py 和 session_events.py 模块开始。在更改包名或导出列表之前,追踪哪些生成的符号应当是公开的。完成的标准是实现模块为私有,且公共模块只公开预期的 API,不会意外公开生成的符号。

由索引模型根据 Issue 内容生成。

描述

bug sdk-v2

https://github.com/github/copilot-sdk/blob/main/python/copilot/generated/__init__.py Makes it clear that the copilot.generated subpackage is not meant to be public:

https://github.com/github/copilot-sdk/blob/cd2b10b07e8f393b09379dfda6b30f658b2963d2/python/copilot/generated/__init__.py#L3

But the subpackage doesn't start with an underscore to signify it's an implementation detail: copilot._generated.

As well, https://github.com/github/copilot-sdk/blob/main/python/copilot/rpc.py and https://github.com/github/copilot-sdk/blob/main/python/copilot/session_events.py which are meant to act as the public API potentially over-expose things. While copilot.rpc does export something explicitly:

https://github.com/github/copilot-sdk/blob/cd2b10b07e8f393b09379dfda6b30f658b2963d2/python/copilot/rpc.py#L10-L11

... both files also do an import * followed by an import of __all__ from the generated code which lists everything contained in the generated code. E.g.:

https://github.com/github/copilot-sdk/blob/cd2b10b07e8f393b09379dfda6b30f658b2963d2/python/copilot/session_events.py#L9-L10

exposes 330 symbols in the module:

https://github.com/github/copilot-sdk/blob/cd2b10b07e8f393b09379dfda6b30f658b2963d2/python/copilot/generated/session_events.py#L9883-L10215

I'm not sure if all 330 symbols are meant to be exposed, but at least copilot.generated should be made private by renaming it to copilot._generated. If all of those symbols are meant to be exposed then that one-liner in copilot.rpc might as well be removed. If they are not meant to be exposed then the import __all__ and import * should go and you can explicitly set __all__ in the exporting modules.

主要语言
Java
星标
10.5k
派生
1.5k
平均合并
1 天 9 小时
30 天内合并 PR
130

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/copilot-sdk 的其他 Issue

查看 github/copilot-sdk 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。