apache / apache/iceberg-python

Explicitly declare supported public APIs with '__all__'

未关闭
#1,099 4 条评论 6 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
1.1k
派生
581
平均合并
1 天 17 小时
30 天内合并 PR
78

描述

### Feature Request / Improvement

Currently, we rely on the informal naming conventions (with or without underscore) to distinguish between a public or private API.

It will be helpful to declare the names of public APIs in the `__all__` attribute on all our public API supporting modules as it will:
- control what APIs we expose to wildcard imports
- enhance discoverability of public APIs (when reading the source code as users or developers)
- and allow tools like [Griffe](https://mkdocstrings.github.io/griffe/guide/users/navigating/#object-visibility) to detect the correct public APIs for backwards compatibility analysis in our CI

贡献指南

这个仓库没有索引到贡献指南

调研方向

首先确定支持公共 API 的模块,并检查其当前的命名约定。为预期的公共名称添加 __all__ 声明,然后验证通配符导入,并确认 Griffe 为兼容性分析检测到相同的 API 表面。

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

评估

技术栈
python
领域
api, developer-experience
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

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