Python argparseでbool型のフラグを扱う方法

Pythonのargparseライブラリを使用して、コマンドライン引数からbool値を取得する方法について説明します。

argparseとは

argparseはPythonの標準ライブラリで、コマンドライン引数の解析を行うためのモジュールです。このモジュールを使用すると、コマンドラインからの入力を簡単に解析し、Pythonプログラム内で使用できるようにすることができます。

bool型のフラグを扱う方法

argparseを使用してbool型のフラグを扱う場合、以下のようにtype=boolと指定すると思いがちですが、これは期待通りに動作しません。

import argparse

def get_args():
    parser = argparse.ArgumentParser()
    parser.add_argument("--hogeFlag", type=bool, default=True)
    return parser.parse_args()

上記のコードでは、--hogeFlag Falseと指定しても、結果はTrueになります。これは、Pythonが引数をbool()に入れてbool型に変換するためです。しかし、Pythonでは空文字列以外のすべての文字列がTrueと評価されるため、’False’という文字列もTrueと評価されます。

したがって、bool型のフラグを正しく扱うには、action='store_true'またはaction='store_false'を使用します。

import argparse

def get_args():
    parser = argparse.ArgumentParser()
    parser.add_argument("--hogeFlag", action='store_true')
    return parser.parse_args()

上記のコードでは、--hogeFlagを指定した場合に限り、結果はTrueになります。指定しない場合は、結果はFalseになります。

まとめ

argparseを使用してbool型のフラグを扱う場合、type=boolではなく、action='store_true'またはaction='store_false'を使用します。これにより、コマンドライン引数から正確にbool値を取得することができます。