Documentation of `pkgutil.walk_packages` is unclear
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100