Documentation of `pkgutil.walk_packages` is unclear

Offen
#92,229 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
48/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginnen Sie mit der Bibliotheksdokumentation zu pkgutil.walk_packages und vergleichen Sie die Beschreibung der rekursiven Suche mit dem Parameter prefix. Stellen Sie klar, dass die Rekursion davon abhängt, dass das Paketpräfix angegeben wird, und verwenden Sie die gemeldeten xml-Beispiele, um das Verhalten und die erwartete Ausgabe deutlich zu machen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

docs

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
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
558

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/cpython

Alle Issues in python/cpython

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.