【Python】デフォルト引数で便利な「argparse」の使い方

Pythonでデフォルト引数を扱うときに便利な標準ライブラリ「argparse」の使い方についてまとめました。

「argparse」とは
関連ページ

「argparse」とは

argparseは、Pythonの標準ライブラリで、プログラム実行時にコマンドライン引数を受け取る処理を簡単に実装できます。
具体的には、プログラムで処理したいファイル名やパラメータなどを実行時に指定できます。

以下は、基本的なコードです。

# 1. argparseをインポート
import argparse

# 2. パーサを作成
parser = argparse.ArgumentParser(description='プログラムの説明（省略可能）')

# 3. コマンドラインから受け取り引数の追加
# 必須の引数
parser.add_argument('arg1')  
parser.add_argument('arg2', help='引数の説明') # 引数の説明を追加可能(省略可)
parser.add_argument('--arg3')  # 引数名にハイフン(-)を1～2個つけると、オプション引数（指定しなくても良い任意の引数）になる
parser.add_argument('-a4', '--arg4')  # 省略形も設定可能
parser.add_argument('-a5', '--arg5', default='test') # デフォルト引数も設定可能
parser.add_argument('-a6', '--arg5', default=0, type=int)    # 型を制限可能(デフォルトは文字列型)。例は整数値(int)に限定。

# 4. 引数の取得
args = parser.parse_args()

# 5. パース(解析)した引数の値を表示
print('arg1=' + args.arg1)
print('arg2=' + args.arg2)
print('arg3=' + args.arg3)
print('arg4=' + args.arg4)
print('arg5=' + args.arg3)
print('arg6=' + args.arg4)