問題タブ [pydoc]

これらが正式に何と呼ばれているのかはよくわかりませんが、Python にはメタデータがあり、通常は__version__ = '0.1'.

PyDoc でサポートされているすべてのリストを見つけるにはどうすればよいですか?

標準ライブラリ クラスのメソッドとその pydoc にすばやく簡単にアクセスできるリソースはありますか?

たとえば、Match クラスで使用できるメソッドと、関連する pydoc の説明を確認したいと考えています。pydoc -p 8888 を開始すると部分的に役立ちますが、このユースケースには対応していません。

ありがとう。

初めてパッケージを作成しましたが、ユーザーが呼び出したときに表示されるドキュメントhelp(my_package)が不完全であることに気付きました。を呼び出すときに、クラス、メソッド、関数、および属性のリストを取得できれば幸いですhelp()。そして理想的には、docstringsからの機能の説明。

ドキュメントを読んでpydocも、そこに提供されている情報が少しまばらであるため、まだ方法がわかりません。

私が正しく理解しhelp()た場合、ユーザーがこの関数を呼び出すと、の「出力」が自動的に作成されますか? または、何か特別なものを提供して指定する必要がありますか?

現在、help()パッケージ (ここでは pdbsr) を呼び出すと、次のようになります。

そして、pdbsr.exceptions などのサブモジュールを呼び出すと、次のようになります。

現在のフォルダー構造の概要は次のとおりです。

そして、私のセットアップファイルは現在次のようになっています：

そして、これは私の一番上の__init__.pyファイルの内容です:

ネストされた関数のドキュメント、この場合は pydoc を生成する方法を探しています。これはpydocで可能ですか? 他のツールで可能ですか？

例えば：

pydoc を次のように生成します: pydoc -w -filename- は、モジュールと foo() に対して pydoc を生成しますが、bar() に対しては生成しません。

通常はこれで問題ありません。問題は、私が教育目的でライブラリを構築しようとしていることであり、クロージャー内で何が起こるかを文書化することは特に役立ちます。内部関数をグローバル スコープに公開せずに文書化する方法を見つけたいと考えています。