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

Pythonのargparseモジュールを使用してコマンドライン引数を扱う際、bool型のフラグをどのように扱うかは一見すると直感的ではありません。以下に、この問題を解決するための方法を示します。

bool型のフラグの問題点

Pythonのargparseモジュールでbool型のフラグを扱う際の一般的な方法は、type=boolと指定することです。しかし、これには問題があります。例えば、次のようなコードを考えてみましょう。

import argparse

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

args = get_args()
print(args.hogeFlag)

このコードをpython test.py --hogeFlag Falseと実行すると、期待通りにFalseが出力されると思いきや、実際にはTrueが出力されます。これは、type=boolと指定すると、Pythonは設定された引数をbool()に入れてbool型に変換しようとするためです。

解決策

この問題を解決するための一つの方法は、action='store_true'またはaction='store_false'を使用することです。これにより、フラグが指定された場合にはTrueが、指定されなかった場合にはFalseが設定されます。以下に、この方法を使用したコードを示します。

import argparse

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

args = get_args()
print(args.hogeFlag)

このコードをpython test.py --hogeFlagと実行すると、Trueが出力され、python test.pyと実行すると、Falseが出力されます。

まとめ

Pythonのargparseモジュールでbool型のフラグを扱う際は、type=boolではなくaction='store_true'またはaction='store_false'を使用することをお勧めします。これにより、直感的な挙動を得ることができます。