Documentation of `pkgutil.walk_packages` is unclear
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Merge médio
- 1d 9h
- PRs com merge (30d)
- 558
Descrição
Documentation
Documentation for the function pkgutil.walk_packages says:
Yields
ModuleInfofor all modules recursively on path , or, if path isNone, all accessible modules.
Emphasis on modules recursively mine. The function is only recursively if the correct prefix value is provided, which is not super clear from the docs:
prefix is a string to output on the front of every module name on output.
For example:
>>> import pkgutil
>>> len(list(pkgutil.walk_packages(['/usr/lib64/python3.10/xml/'])))
4
>>> len(list(pkgutil.walk_packages(['/usr/lib64/python3.10/xml/'], '')))
4
>>> len(list(pkgutil.walk_packages(['/usr/lib64/python3.10/xml/'], 'xml.')))
21
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pela documentação da biblioteca para pkgutil.walk_packages e compare a descrição da descoberta recursiva com o parâmetro prefix. Esclareça que a recursão depende do fornecimento do prefixo do pacote, usando os exemplos de xml relatados para deixar claro o comportamento e a saída esperada.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 48/100