apache / apache/iceberg-python

Explicitly declare supported public APIs with '__all__'

オープン
#1,099 コメント 4 件 リアクション 6 件 担当者 0 名 GitHub で見る
主要言語
Python
スター
1.1k
フォーク
581
平均マージ
1日 17時間
マージ済み PR(30日)
77

説明

### 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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず、public API をサポートするモジュールを特定し、現在の命名規則を確認します。意図した公開名に対する __all__ 宣言を追加し、その後ワイルドカードインポートを検証して、互換性分析のために Griffe が同じ API サーフェスを検出することを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api, developer-experience
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。