Pythonのargparseモジュールは、コマンドライン引数の解析を容易にするためのツールです。この記事では、argparseモジュールのadd_argument()
メソッドのdefault
引数について詳しく説明します。
add_argument()
メソッドは、コマンドライン引数の仕様をパーサーに追加するためのメソッドです。このメソッドのdefault
引数は、コマンドライン引数が提供されなかった場合に使用する値を指定します。
例えば、以下のコードは--example
というオプション引数を定義しています。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--example', nargs='?', const=1, type=int)
args = parser.parse_args()
print(args)
このコードを実行すると、以下のような結果が得られます。
% test.py
Namespace(example=None)
% test.py --example
Namespace(example=1)
% test.py --example 2
Namespace(example=2)
nargs='?'
は0または1の引数を意味し、const=1
は0の引数がある場合のデフォルト値を設定します。type=int
は引数を整数に変換します。
したがって、--example
オプションが指定されず値も提供されない場合、args.example
はNone
になります。--example
オプションが指定され、値が提供されない場合、args.example
はconst
で設定した1
になります。--example
オプションが指定され、値2
が提供される場合、args.example
は提供された値2
になります。
このように、argparseモジュールのdefault
引数を使用することで、コマンドライン引数が提供されなかった場合のデフォルト値を簡単に設定することができます。
以上がPythonのargparseモジュールのdefault
引数の基本的な使い方になります。この情報がPythonのコマンドライン引数の解析を行う際の参考になれば幸いです。