python / python/cpython

Documentation of `pkgutil.walk_packages` is unclear

Ouverte
#92,229 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

Documentation

Documentation for the function pkgutil.walk_packages says:

Yields ModuleInfo for all modules recursively on path , or, if path is None , 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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la documentation de la bibliothèque concernant pkgutil.walk_packages et comparez la description de la découverte récursive avec le paramètre prefix. Précisez que la récursivité dépend de la fourniture du préfixe du paquet, en utilisant les exemples xml signalés pour rendre clairs le comportement et la sortie attendue.

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

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
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.