Pythonのargparse
モジュールは、コマンドラインインターフェースの作成を容易にします。このモジュールを使用すると、プログラムが必要とする引数を定義し、argparse
がそれらをsys.argv
から解析する方法を決定します。
以下に、argparse
の基本的な使用方法を示します。
import argparse
# argparseをインポート
parser = argparse.ArgumentParser(description='このプログラムの説明(なくてもよい)')
# パーサを作る
parser.add_argument('arg1', help='この引数の説明(なくてもよい)') # 必須の引数を追加
parser.add_argument('arg2', help='foooo')
parser.add_argument('--arg3') # オプション引数(指定しなくても良い引数)を追加
parser.add_argument('-a', '--arg4') # よく使う引数なら省略形があると使う時に便利
# 引数を解析
args = parser.parse_args()
print('arg1='+args.arg1)
print('arg2='+args.arg2)
print('arg3='+args.arg3)
print('arg4='+args.arg4)
上記のコードは、argparse
を使用してコマンドライン引数を解析する基本的な例です。この例では、必須の引数(arg1
とarg2
)とオプション引数(--arg3
と--arg4
)を定義しています。
また、argparse
には、引数のデフォルト値を設定したり、引数の型を指定したりする機能もあります。
parser.add_argument('--message', default='hello!') # デフォルト値を指定
parser.add_argument('--number', type=int) # 整数値(int)
parser.add_argument('--alpha', type=float, default=0.01) # 実数値(float)
これらの機能を活用することで、より柔軟なコマンドラインインターフェースを作成することが可能です。
以上、Pythonのargparse
関数についての簡単な紹介でした。この情報がPythonのコマンドライン引数の解析に役立つことを願っています。