apache / apache/iceberg-python
Explicitly declare supported public APIs with '__all__'
- Vorherrschende Sprache
- Python
- Sterne
- 1.1k
- Forks
- 581
- Ø Merge
- 1 T. 17 Std.
- Gemergte PRs (30 T.)
- 78
Beschreibung
### 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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, die Module zu identifizieren, die die öffentliche API unterstützen, und ihre aktuellen Namenskonventionen zu überprüfen. Füge __all__-Deklarationen für die vorgesehenen öffentlichen Namen hinzu; überprüfe anschließend Wildcard-Imports und bestätige, dass Griffe für die Kompatibilitätsanalyse dieselbe API-Oberfläche erkennt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api, developer-experience
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100