Pythonのargparseで無効な引数を処理する方法をわかりやすく解説

Pythonのargparseで無効な引数を処理する方法

Python標準ライブラリのargparseモジュールを使うと、コマンドライン引数を簡単かつ柔軟に解析できます。しかし、スクリプト側で定義されていない引数が渡された場合、argparseは自動的にエラーメッセージを表示してプログラムを終了します。本記事では、サンプルコードと実行例をもとに、無効な引数が渡されたときのargparseの挙動を解説します。

サンプルコード

以下は、独自の例外クラスInvalidArgErrorを定義し、argparseで引数を処理するサンプルスクリプトです。

#foo.py
import argparse

class InvalidArgError(Exception):
    pass

parser = argparse.ArgumentParser()
parser.add_argument("echo")

args = parser.parse_args()

try:
    print(args.echo)
    raise InvalidArgError
except InvalidArgError as e:
    print(e)

スクリプトの実行方法

ターミナルから以下のようにスクリプトを実行します。ここでは、定義済みの位置引数「echo」に加えて、余分な引数「bar」も一緒に渡しています。

$ python foo.py echo bar

実行結果

スクリプトで定義されていない引数「bar」が渡されたため、argparseは以下のような使用方法（usage）とエラーメッセージを出力し、プログラムを終了します。

usage: foo.py [-h] echo
foo.py: error: unrecognized arguments: bar

ポイント解説

add_argument("echo")では位置引数（positional argument）が1つだけ定義されているため、「echo」と「bar」の2つの値を渡すと、argparseは余分な引数を受け付けられずエラーとなります。

このように、argparseは不正な引数や未知のオプションを検出すると、自動的にusageメッセージとともにエラーを表示してくれるため、開発者が引数検証用のコードを自前で書く必要はほとんどありません。必要に応じて、ArgumentParserのコンストラクタにusageやdescriptionを指定したり、parse_known_args()メソッドを使って未知の引数を許容しつつ別途処理したりすることも可能です。