Python ArgumentParserでコマンドラインから実行時に強制的に引数を渡させる

きっと書いておかないと忘れるので書いておきます。

ArgumentParserという便利なライブラリがあります。

公式サイトはこちら。

平たく言うと、コマンドラインから

python main.py

って走らせるときに、引数がないと動作しないようにする、とか、ヘルプを表示させたりとか、コマンドラインの引数に応じて、実行することを変えたりすることができるのです。

超シンプルな使い方は下記のようにします。

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')

parser.add_argument('integers', metavar='N', type=int)

args = parser.parse_args()
print(args.integers)

コマンドラインから引数なしで実行すると、次のように表示されます。

 

G:\test>python argparse_sample.py
usage: argparse_sample.py [-h] N
argparse_sample.py: error: the following arguments are required: N

引数を渡すと、次のように引数が表示されます。

G:\test>python argparse_sample.py 5
5