Documentation of `pkgutil.walk_packages` is unclear
オープン
まだ誰も着手していません。
docs
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 36k
- 平均マージ
- 1日 9時間
- マージ済み PR(30日)
- 558
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
pkgutil.walk_packages のライブラリドキュメントから始め、再帰的な検出の説明をパラメーター prefix と比較してください。再帰はパッケージプレフィックスを指定することに依存する点を明確にし、報告されている xml の例を使って動作と期待される出力を明らかにしてください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100