python - pydoc で doc テキストのみを表示する方法

Question

perl 開発者として、perldocユーティリティを認識しています。私はpythonが初めてで、同じものを探していてpydocを見つけました。しかし、pydoc の問題は、三重引用符で囲まれたドキュメントのみを見たいときに、スクリプトも実行していることです。どんな助けでも大歓迎です。

Answer 1

おそらく最良の方法は、(コマンド ラインではなく) Python で作業することです。sysモジュールを例に取りましょう。最初にモジュールをインポートしてから、次help()のように使用します。

import sys
help(sys)

docstring を見たい場合:

print(sys.__doc__)

自分で開発したモジュールの場合、ドキュメントで説明されているように、モジュールが実行されないようにガードを構築できます。

注: オブジェクトとそのドキュメントを検索するために、pydoc はドキュメント化するモジュールをインポートします。したがって、モジュール レベルのすべてのコードは、その際に実行されます。ガードを使用してif __name__ == '__main__':、ファイルがインポートされただけでなく、スクリプトとして呼び出されたときにのみコードを実行します。