apache / apache/iceberg-python

Explicitly declare supported public APIs with '__all__'

Aberta
#1,099 4 comentários 6 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
1.1k
Forks
581
Merge médio
1d 13h
PRs com merge (30d)
76

Descrição

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

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Comece identificando os módulos que dão suporte à API pública e revisando suas convenções de nomenclatura atuais. Adicione declarações __all__ para os nomes públicos pretendidos; em seguida, verifique as importações curinga e confirme que o Griffe detecta a mesma superfície da API para a análise de compatibilidade.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
api, developer-experience
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
48/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.