argparseによるブール値の解析

argparseを使用して、「-foo True」または「--foo False」と記述されたブールコマンドライン引数を解析したいと思います。例えば：

my_program --my_boolean_flag False

ただし、次のテストコードでは希望どおりの結果が得られません。

import argparse
parser = argparse.ArgumentParser(description="My parser")
parser.add_argument("--my_bool", type=bool)
cmd_line = ["--my_bool", "False"]
parsed_args = parser.parse(cmd_line)

悲しいことに、にparsed_args.my_bool評価されTrueます。これは私が変更されてもそうであるcmd_lineように["--my_bool", ""]するので、驚くべきことであるこれは、bool("")evalutatesへFalse。

どうやって取得argparse解析することができ"False"、"F"およびその下のケースのように変異体はFalse？

前の提案を使用したさらに別の解決策ですが、次の「正しい」解析エラーがありますargparse。

def str2bool(v):
    if isinstance(v, bool):
       return v
    if v.lower() in ('yes', 'true', 't', 'y', '1'):
        return True
    elif v.lower() in ('no', 'false', 'f', 'n', '0'):
        return False
    else:
        raise argparse.ArgumentTypeError('Boolean value expected.')

これは、デフォルト値でスイッチを作成するのに非常に役立ちます。例えば

parser.add_argument("--nice", type=str2bool, nargs='?',
                        const=True, default=False,
                        help="Activate nice mode.")

私が使用できるようにします：

script --nice
script --nice <bool>

それでもデフォルト値を使用します（ユーザー設定に固有）。そのアプローチの（間接的に関連する）欠点の1つは、「ナグ」が位置の引数をキャッチする可能性があることです。この関連する質問とこのargparseバグレポートを参照してください。

これを行うためのより標準的な方法は、

command --feature

そして

command --no-feature

argparse このバージョンをうまくサポートしています：

parser.add_argument('--feature', dest='feature', action='store_true')
parser.add_argument('--no-feature', dest='feature', action='store_false')
parser.set_defaults(feature=True)

もちろん、本当に--arg <True|False>バージョンが必要な場合はast.literal_eval、「タイプ」またはユーザー定義関数として渡すことができます...

def t_or_f(arg):
    ua = str(arg).upper()
    if 'TRUE'.startswith(ua):
       return True
    elif 'FALSE'.startswith(ua):
       return False
    else:
       pass  #error condition maybe?

私は、相互に排他的なグループでmgilsonの答えをお勧めしますが、
あなたが使用できないように--featureし、--no-feature同時に。

command --feature

そして

command --no-feature

だがしかし

command --feature --no-feature

脚本：

feature_parser = parser.add_mutually_exclusive_group(required=False)
feature_parser.add_argument('--feature', dest='feature', action='store_true')
feature_parser.add_argument('--no-feature', dest='feature', action='store_false')
parser.set_defaults(feature=True)

それらの多くを設定する場合は、このヘルパーを使用できます。

def add_bool_arg(parser, name, default=False):
    group = parser.add_mutually_exclusive_group(required=False)
    group.add_argument('--' + name, dest=name, action='store_true')
    group.add_argument('--no-' + name, dest=name, action='store_false')
    parser.set_defaults(**{name:default})

add_bool_arg(parser, 'useful-feature')
add_bool_arg(parser, 'even-more-useful-feature')

デフォルト値を設定するための追加の行がない別のバリエーションがあります。boolには常に値が割り当てられているため、事前チェックなしで論理ステートメントで使用できます。

import argparse
parser = argparse.ArgumentParser(description="Parse bool")
parser.add_argument("--do-something", default=False, action="store_true" , help="Flag to do something")
args = parser.parse_args()

if args.do_something:
     print("Do something")
else:
     print("Don't do something")
print("Check that args.do_something=" + str(args.do_something) + " is always a bool")

一発ギャグ：

parser.add_argument('--is_debug', default=False, type=lambda x: (str(x).lower() == 'true'))

何type=boolをtype='bool'意味し、何を意味するのかについて、いくつかの混乱があるようです。1つ（または両方）は、「関数を実行する」bool()または「ブール値を返す」という意味ですか？現状のままではtype='bool'何も意味しません。 、またはを使用した場合と同じようにadd_argument、'bool' is not callableエラーが発生します。type='foobar'type='int'

しかしargparse、このようなキーワードを定義できるレジストリがあります。主にに使用されますaction（例： `action = 'store_true'）。登録したキーワードは以下で確認できます。

parser._registries

辞書を表示します

{'action': {None: argparse._StoreAction,
  'append': argparse._AppendAction,
  'append_const': argparse._AppendConstAction,
...
 'type': {None: <function argparse.identity>}}

多くのアクションが定義されていますが、デフォルトのタイプの1つだけですargparse.identity。

このコードは 'bool'キーワードを定義します：

def str2bool(v):
  #susendberg's function
  return v.lower() in ("yes", "true", "t", "1")
p = argparse.ArgumentParser()
p.register('type','bool',str2bool) # add type keyword to registries
p.add_argument('-b',type='bool')  # do not use 'type=bool'
# p.add_argument('-b',type=str2bool) # works just as well
p.parse_args('-b false'.split())
Namespace(b=False)

parser.register()文書化されていませんが、非表示にもされていません。ほとんどの場合、プログラマは関数とクラスの値typeをaction取るため、それについて知る必要はありません。両方のカスタム値を定義するスタックオーバーフローの例はたくさんあります。

前の説明から明らかでない場合でも、bool()「文字列を解析する」ことを意味しません。Pythonのドキュメントから：

bool（x）：標準の真偽テスト手順を使用して、値をブール値に変換します。

これと比較して

int（x）：数値または文字列xを整数に変換します。

私は同じ問題を探していましたが、かなりの解決策は次のとおりです：

def str2bool(v):
  return v.lower() in ("yes", "true", "t", "1")

そして、それを使用して、上記のように文字列をブール値に解析します。

非常に似た方法は次のようにすることです：

feature.add_argument('--feature',action='store_true')

コマンドで引数--featureを設定した場合

 command --feature

type --featureを設定しない場合、引数はTrueになります。引数のデフォルトは常にFalseです！

@mgilsonが言ったことに加えて、またありますことに留意すべきであるArgumentParser.add_mutually_exclusive_group(required=False)、それは些細なことを強制することになるだろう方法--flagと--no-flag同時に使用されていませんが。

これは私が期待するすべてのことで機能します：

add_boolean_argument(parser, 'foo', default=True)
parser.parse_args([])                   # Whatever the default was
parser.parse_args(['--foo'])            # True
parser.parse_args(['--nofoo'])          # False
parser.parse_args(['--foo=true'])       # True
parser.parse_args(['--foo=false'])      # False
parser.parse_args(['--foo', '--nofoo']) # Error

コード：

def _str_to_bool(s):
    """Convert string to bool (in argparse context)."""
    if s.lower() not in ['true', 'false']:
        raise ValueError('Need bool; got %r' % s)
    return {'true': True, 'false': False}[s.lower()]

def add_boolean_argument(parser, name, default=False):                                                                                               
    """Add a boolean argument to an ArgumentParser instance."""
    group = parser.add_mutually_exclusive_group()
    group.add_argument(
        '--' + name, nargs='?', default=default, const=True, type=_str_to_bool)
    group.add_argument('--no' + name, dest=name, action='store_false')

より簡単な方法は、以下のように使用することです。

parser.add_argument('--feature', type=lambda s: s.lower() in ['true', 't', 'yes', '1'])

最も簡単です。柔軟性はありませんが、私は単純さを好みます。

  parser.add_argument('--boolean_flag',
                      help='This is a boolean flag.',
                      type=eval, 
                      choices=[True, False], 
                      default='True')

編集：入力を信頼しない場合は、使用しないでくださいeval。

最も簡単な方法は、選択肢を使用することです：

parser = argparse.ArgumentParser()
parser.add_argument('--my-flag',choices=('True','False'))

args = parser.parse_args()
flag = args.my_flag == 'True'
print(flag)

--my-flagを渡さないと、Falseと評価されます。ユーザーに常に明示的に選択肢を指定させたい場合は、required = Trueオプションを追加できます。

最も標準的な方法は次のようになると思います：

parser.add_argument('--ensure', nargs='*', default=None)

ENSURE = config.ensure is None

class FlagAction(argparse.Action):
    # From http://bugs.python.org/issue8538

    def __init__(self, option_strings, dest, default=None,
                 required=False, help=None, metavar=None,
                 positive_prefixes=['--'], negative_prefixes=['--no-']):
        self.positive_strings = set()
        self.negative_strings = set()
        for string in option_strings:
            assert re.match(r'--[A-z]+', string)
            suffix = string[2:]
            for positive_prefix in positive_prefixes:
                self.positive_strings.add(positive_prefix + suffix)
            for negative_prefix in negative_prefixes:
                self.negative_strings.add(negative_prefix + suffix)
        strings = list(self.positive_strings | self.negative_strings)
        super(FlagAction, self).__init__(option_strings=strings, dest=dest,
                                         nargs=0, const=None, default=default, type=bool, choices=None,
                                         required=required, help=help, metavar=metavar)

    def __call__(self, parser, namespace, values, option_string=None):
        if option_string in self.positive_strings:
            setattr(namespace, self.dest, True)
        else:
            setattr(namespace, self.dest, False)

最も簡単で最も正しい方法は

from distutils import util
arser.add_argument('--feature', dest='feature', type=lambda x:bool(distutils.util.strtobool(x)))

True値はy、yes、t、true、on、および1であることに注意してください。false値は、n、no、f、false、off、および0です。valがそれ以外の場合、ValueErrorが発生します。

すばやく簡単ですが、引数0または1の場合のみです。

parser.add_argument("mybool", default=True,type=lambda x: bool(int(x)))
myargs=parser.parse_args()
print(myargs.mybool)

端末から呼び出した後の出力は「False」になります。

python myscript.py 0

@Akashに似ていますが、ここに私が使用した別のアプローチがあります。これは、使用するstrよりも、lambdaPythonがあるためlambda、常に私にエイリアンの気持ちを与えます。

import argparse
from distutils.util import strtobool

parser = argparse.ArgumentParser()
parser.add_argument("--my_bool", type=str, default="False")
args = parser.parse_args()

if bool(strtobool(args.my_bool)) is True:
    print("OK")

@Akash Desardaの答えの改善として、次のことができます

import argparse
from distutils.util import strtobool

parser = argparse.ArgumentParser()
parser.add_argument("--foo", 
    type=lambda x:bool(strtobool(x)),
    nargs='?', const=True, default=False)
args = parser.parse_args()
print(args.foo)

そしてそれはサポートしています python test.py --foo

(base) [costa@costa-pc code]$ python test.py
False
(base) [costa@costa-pc code]$ python test.py --foo 
True
(base) [costa@costa-pc code]$ python test.py --foo True
True
(base) [costa@costa-pc code]$ python test.py --foo False
False