1. ホーム
  2. python

[解決済み] Pythonファイルを実行するときにdocstringを表示するには?

2023-03-18 23:46:58

質問

docstringを持つPythonスクリプトを持っています。コマンドライン引数の解析が成功しない場合、ユーザーの情報のためにdocstringを表示したいです。

これを行う方法はありますか?

最小限の例

#!/usr/bin/env python
"""
Usage: script.py

This describes the script.
"""

import sys


if len(sys.argv) < 2:
    print("<here comes the docstring>")

どのように解決するのですか?

docstring は、モジュールの __doc__ グローバルの中にあります。

print(__doc__)

ちなみに、これはどのモジュールにも言えることです。 import sys; print(sys.__doc__) . 関数やクラスの文字列もその __doc__ 属性で指定します。