Python argparseのデフォルト値をヘルプに表示する方法

Pythonのargparseモジュールは、コマンドラインインターフェースの作成を容易にします。しかし、デフォルト値をヘルプメッセージに含める方法は一見するとわかりにくいかもしれません。

argparseには、ヘルプメッセージにデフォルト値を表示するための組み込みの方法があります。それはargparse.ArgumentDefaultsHelpFormatterを使用することです。

import argparse

parser = argparse.ArgumentParser(
    formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
parser.add_argument('--scan-time', type=int, default=5, help="Wait SCAN-TIME seconds between status checks.")
args = parser.parse_args()

上記のコードでは、--scan-timeオプションのデフォルト値が5であることがヘルプメッセージに表示されます。

この方法は、argparseのヘルプメッセージをカスタマイズするための一例です。argparseは非常に柔軟性があり、ユーザーフレンドリーなコマンドラインインターフェースを作成するための強力なツールです。