apache / apache/iceberg-python

Explicitly declare supported public APIs with '__all__'

未關閉
#1,099 4 則留言 6 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Python
星號
1.1k
分支
581
平均合併
1 天 13 小時
30 天內合併 PR
76

描述

### 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 摘要。