Pythonのargparse
モジュールは、コマンドライン引数の解析を容易にするためのツールです。このモジュールを使用すると、プログラムが必要とする引数を定義し、それらをsys.argv
から解析する方法をargparse
に指示することができます。
以下に、必須のコマンドライン引数を設定する基本的な方法を示します。
import argparse
parser = argparse.ArgumentParser(description='Foo')
parser.add_argument('-i', '--input', help='Input file name', required=True)
parser.add_argument('-o', '--output', help='Output file name', default="stdout")
args = parser.parse_args()
print("Input file: %s" % args.input)
print("Output file: %s" % args.output)
上記のコードでは、-i
または--input
オプションが必須となっています。このオプションが指定されていない場合、プログラムはエラーメッセージを出力し、終了します。
また、argparse
モジュールは、ユーザーがプログラムに無効な引数を与えたときにエラーを発行する機能も提供しています。
このように、argparse
を使用すると、Pythonでコマンドラインツールを作成する際の引数の取り扱いを大幅に簡単にすることができます。