Pythonのargparse
モジュールは、コマンドライン引数の解析を容易にします。この記事では、argparse
を使用して必須引数を設定する方法について説明します。
argparseとは?
argparse
はPythonの標準ライブラリで、プログラム実行時にコマンドラインで引数を受け取る処理を簡単に実装できます。
必須引数の設定方法
argparse
で必須引数を設定するには、add_argument
メソッドの第1引数で引数名を指定します。以下に基本的な使用例を示します。
import argparse
# argparseをインポート
parser = argparse.ArgumentParser(description='このプログラムの説明(なくてもよい)')
# 必須の引数を追加
parser.add_argument('arg1', help='この引数の説明(なくてもよい)')
parser.add_argument('arg2', help='foooo')
args = parser.parse_args()
print('arg1='+args.arg1)
print('arg2='+args.arg2)
この例では、arg1
とarg2
が必須引数として設定されています。これらの引数は、プログラムを実行する際に指定する順番が決まっており、指定し忘れるとエラーになります。
オプション引数との違い
オプション引数は、引数名を-a
や--alpha
のようにハイフン(‘-‘)を1~2個つけたものにすると、実行時には指定してもしなくても良く(指定されなかった場合はNoneになる)、指定する順番も自由です。
まとめ
Pythonのargparse
モジュールを使用すると、コマンドライン引数の解析を簡単に行うことができます。必須引数は、プログラムを実行する際に必ず指定する必要がある引数で、add_argument
メソッドの第1引数で指定します。この機能を利用することで、より柔軟なコマンドラインインターフェースを実装することが可能になります。