apache / apache/iceberg-python

Explicitly declare supported public APIs with '__all__'

Ouverte
#1,099 4 commentaires 6 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
1.1k
Forks
581
Merge moyen
1 j 17 h
PR mergées (30 j)
77

Description

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par identifier les modules qui prennent en charge l’API publique et par examiner leurs conventions de nommage actuelles. Ajoutez des déclarations __all__ pour les noms publics prévus, puis vérifiez les imports génériques et confirmez que Griffe détecte la même surface d’API pour l’analyse de compatibilité.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
api, developer-experience
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.