Pythonのargparse
モジュールは、コマンドライン引数を簡単に扱うための強力なツールです。この記事では、argparse
を使用して任意の引数を受け取る方法について説明します。
argparseの基本
まず、argparse
モジュールをインポートし、ArgumentParser
のインスタンスを作成します。
import argparse
parser = argparse.ArgumentParser(description='このプログラムの説明(なくてもよい)')
次に、add_argument
メソッドを使用して引数を追加します。このメソッドは、位置引数とオプション引数の両方をサポートしています。
parser.add_argument('arg1', help='この引数の説明(なくてもよい)') # 必須の引数を追加
parser.add_argument('--arg3') # オプション引数(指定しなくても良い引数)を追加
最後に、parse_args
メソッドを使用して引数を解析します。
args = parser.parse_args()
print('arg1='+args.arg1)
print('arg3='+args.arg3)
任意の引数を受け取る
任意の引数を受け取るには、引数名の前に--
を付けます。この引数は、コマンドライン上で指定しなくてもプログラムはエラーにならず、指定されなかった場合の値はNone
になります。
parser.add_argument("--start_at", help="対象年月日のはじめ")
parser.add_argument("--end_at", help="対象年月日の終わり")
このようにすると、--start_at
や--end_at
のような任意の引数をコマンドラインから受け取ることができます。
以上が、Pythonのargparse
モジュールを使用して任意の引数を受け取る基本的な方法です。これを活用して、より柔軟なコマンドラインインターフェースを作成してみてください。