Pythonのargparse
モジュールは、コマンドライン引数を取り扱うための強力なツールです。この記事では、その基本的な使い方を紹介します。
argparseとは?
argparse
はPythonの標準ライブラリで、コマンドライン引数を簡単に解析することができます。以下のような形式でコマンドライン引数を受け取ることができます。
python my_prog.py arg1 arg2
ここで、arg1
とarg2
は引数です。
argparseの基本的な使い方
argparse
を使うための基本的な手順は以下の通りです。
argparse
をインポートする- パーサーを作る
- 引数を設定する
- 引数を解析する
以下に具体的なコードを示します。
import argparse
# 1. argparseをインポート
parser = argparse.ArgumentParser(description='このプログラムの説明(なくてもよい)')
# 2. パーサーを作る
parser.add_argument('arg1', help='この引数の説明(なくてもよい)') # 必須の引数を追加
parser.add_argument('arg2', help='foooo')
parser.add_argument('--arg3') # オプション引数(指定しなくても良い引数)を追加
parser.add_argument('-a', '--arg4') # よく使う引数なら省略形があると使う時に便利
# 3. 引数を設定する
args = parser.parse_args()
# 4. 引数を解析する
print('arg1='+args.arg1)
print('arg2='+args.arg2)
print('arg3='+args.arg3)
print('arg4='+args.arg4)
このコードを実行すると、以下のような結果が得られます。
$ python test.py input.txt output.txt --arg3 11111 -a 22222
arg1=input.txt
arg2=output.txt
arg3=11111
arg4=22222
以上がargparse
の基本的な使い方です。このモジュールを使うと、コマンドライン引数を簡単に取り扱うことができます。さらに詳しい使い方については、公式ドキュメンテーションを参照してください。