apache / apache/iceberg-python
Explicitly declare supported public APIs with '__all__'
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 581
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 78
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
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.