Pythonのargparseモジュールは、コマンドライン引数を簡単に扱うための標準ライブラリです。このモジュールを使用すると、プログラムで処理したいファイル名やパラメータなどを実行時に指定できます。
基本的な使用方法
argparseモジュールの使用は、以下の4つのステップで行います。
- argparseをインポートする
- ArgumentParserのインスタンスを作成する
- 引数を設定する
- 引数を解析する
以下に具体的なコードを示します。
import argparse # argparseをインポート
# ArgumentParserのインスタンスを作成
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)
このコードでは、arg1とarg2は位置引数、--arg3と--arg4はオプション引数として設定されています。
オプション引数
引数名を-aや--alphaのようにハイフン(‘-‘)を1～2個つけたものにすると、オプション引数となります。オプション引数は、指定しなくても良く、指定する順番も自由です。
デフォルト値と型指定
オプション引数で指定されなかった場合はNoneになりますが、デフォルト値を指定することもできます。また、指定された値はデフォルトでは文字列型ですが、整数値や実数値を指定したい場合は、type引数を使用して型を指定できます。
フラグとしての使用
add_argumentにactionを指定すると、フラグとして使用できます。フラグは、指定されているとTrue、そうでないときはFalseになります。
以上がPythonのargparseモジュールの基本的な使用方法です。これを使うと、コマンドライン引数を簡単に扱うことができます。