关于python:使用argparse分析布尔值

Parsing boolean values with argparse

我想使用argparse解析写为"-foo-true"或"-foo-false"的布尔命令行参数。例如：

1	my_program --my_boolean_flag False

但是，以下测试代码不符合我的要求：

1
2
3
4
5

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("")的评价是False的评价。

如何让argparse解析"False"、"F"及其小写变体为False？

相关讨论

我认为更规范的方法是通过：

1	command --feature

和

1	command --no-feature

argparse很好地支持这个版本：

1
2
3

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 版本，你可以通过ast.literal_eval作为"类型"，或者用户定义的函数…

1
2
3
4
5
6
7
8

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?

相关讨论

我仍然认为type=bool应该是开箱即用的(考虑位置参数！).即使您另外指定了choices=[False,True]，也会得到"假"和"真"都被认为是真的(由于从字符串到bool的转换？).可能相关问题
@dolphin——您可以使用type = {'True':True,'False':False}.get，但是记住，bool('False')是True，因此传递bool作为类型构造函数函数在这里不起作用。
对，我只是认为没有理由不按预期工作。这是非常误导，因为没有安全检查和错误信息。
@海豚——你说的"不按预期工作"是什么意思？如我所见，这完全符合预期。type参数对来自命令行的字符串输入进行操作，以构造输出。你说的误导是什么？我的答案中有什么可以改进的吗？如果是，请具体告诉我，我会尽力澄清。最终，argparse是结构化的，因为大多数程序没有像--arg True|False这样的标志。OP在这里寻找的是非标准的，这就是为什么它不是由argparse提供的。
在docs.python.org/2.7/library/argparse.html action中阅读。
@mgilson——我发现误导的是，您可以设置type=bool，不会收到错误消息，但是，对于"false"和"true"字符串参数，您可以在假定的布尔变量中得到true(这是由于类型转换在python中的工作方式)。因此，无论是类型=bool，都应该是明显不受支持的(发出一些警告、错误等)，或者它应该以一种有用且直观的方式工作。
@海豚——我不同意。我认为这种行为正是它应该做的，并且与Python的禅"特殊情况不足以打破规则"。但是，如果您对此有强烈的感觉，为什么不在各种各样的python邮件列表中提出它呢？在那里，你可能有机会说服有权处理这个问题的人。即使你能说服我，你也只能成功地说服我，而且这种行为不会改变，因为我不是一个开发者。
@mgilson好吧，有各种各样的python规则，无论您采用哪种规则，type=bool参数的当前解决方案都是无用的和误导性的(或者我是否缺少对type=bool的当前行为的任何使用？)它是否也与int参数的行为不一致？(我猜"0"得0，"5"得5)。我不认为这是最高优先级的问题，只是觉得bool的当前解决方案没有它可能的那么有用，而且对一些程序员来说，可能会在他们的应用程序中导致意想不到的结果。
我们是在讨论python bool()函数应该做什么，还是在type=fn中应该接受什么argparse？所有argparse支票都是可以调用的。它期望fn接受一个字符串参数，并返回一个值。fn的行为是程序设计者的责任，而不是argparse's的责任。
这种行为绝对是误导性的：它对str有效，对int有效，但对bool无效？！
@克里斯托弗鲁西——我仍然认为这是最好的行为……你在找Python来施魔法。(根据这个答案的流行程度，可能有很多人是这样的)。然而，魔法的问题是，每个人都希望它的表现有所不同。你接受什么？江户十一〔4〕、江户十一〔17〕？那True呢？那么yes/no呢？对于说西班牙语的人来说，Si怎么样？弄清楚在哪里划线变得困难。我认为，在这种情况下，最好做到最少，并强制用户明确。
@mgilson我希望它在帮助中显示允许的值"true或false(任何情况)"，否则它将失败并拒绝bool。我对python非常陌生，所以这是我从一个工具中所期望的，这个工具应该能够处理诸如str、int、bool等标准情况。我知道这有点神奇，因为案件处理…
虽然--no-feature版本很好，但是对--feature=false的支持可以在没有指定参数的情况下工作，这是非常有效的用例：当客户机准备好标志的布尔值并说用--feature=$value调用程序时。
您应该使用'TRUE'.startswith(ua)，而不是ua == 'TRUE'[:len(ua)]。这不仅更清楚，而且效率更高，因为您没有为比较创建临时字符串。
@Tomkarzes——是的，我不知道为什么3岁小的我没有想到这一点。——P。这也让我想知道，在看到这个答案的64.5K用户中，有多少人只是盲目地将它复制/粘贴到他们的代码中……
嗨，大家好，抱歉，在检查了所有讨论之后，我不明白什么是最好的解决方案，我试图将type=bool替换为type='true'：true，'false'：false.get不起作用。我们必须在回复中使用"--feature"或定义类似"def t_or_f(arg)"的函数来完成这个技巧吗？
@志宏——据我所知，这是最好的方法。你有什么理由不想那样做吗？
关于这个答案的评论是荒谬的。为什么会有人期望bool('my non-empty, and truthy string')返回False？如果你不愿意，为什么会期望bool('False')返回True？你不明白传递给type=的参数只是一个函数(或任何可调用的，真的吗)？这就是int工作的原因——因为int('5')返回一个整数。str('foo')工作，因为str返回一个字符串。对此有什么争议？？也许type是关键字参数的坏名字——也许parse_func或者其他什么东西会使它更明显地不是魔法？？
这种默认行为是愚蠢的
@Joshburkart——也许这是不具有说服力的，尽管称之为"白痴"可能有点侮辱那些与你意见不同的人(那些为创建一个非常好的命令行解析库贡献了大量时间的人)。在任何情况下，如果你和其他评论员/上届投票者真的对此感兴趣，为什么不向图书馆维护人员提出(而不是在这里张贴，这是不太可能达到眼睛/耳朵的人实际上有权改变什么？)。
@我的评论确实是侮辱性的，非常不恰当。正如你所指出的，完全不是建设性的。我非常抱歉。
布尔标志是一个非常常见的用例，所以一行解决方案对我来说似乎是非常可取的。用户也没有理由期望设置type=bool会导致解析器成为bool函数。(事实上，似乎不太可能存在一个用于生成布尔标志的用例，该布尔标志将"blah random string"解释为True…？)我会考虑在将来努力改进这一点！：)
我不明白你为什么要对布尔值的两边都有一个论点。为非默认情况添加参数。默认为默认情况。完成。parser.add_argument('-n', '--no-feature', dest='nofeature', default=False, action='store_true'); ...; feature_bool = not parser.parse_args().nofeature为什么在默认情况下输入用户类型？
@斯威比克伦——我会告诉你和我在这篇文章里告诉其他人的一样的事情。如果您不喜欢这个API，并且有一个关于改进它的干净方法的建议，为什么不将一个想法发布到Python的想法中呢？在那里，你会有一个听众有权考虑你的想法，要么实施它，要么给你一个他们不愿意的理由。这将比向我抱怨更有成效(互联网上的一些随机的人，碰巧知道一两件关于python的事)。

我推荐米吉尔森的答案，但有一个相互排斥的小组所以你不能同时使用--feature和--no-feature。

1	command --feature

和

1	command --no-feature

但不是

1	command --feature --no-feature

脚本：

1
2
3
4

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)

然后，如果要设置其中许多帮助器，则可以使用此帮助器：

1
2
3
4
5
6
7
8

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')

相关讨论

另一种解决方案是使用前面的建议，但使用argparse中的"正确"分析错误：

1
2
3
4
5
6
7

def str2bool(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.')

这对于使用默认值进行切换非常有用；例如

1
2
3

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

允许我使用：

1 2	script --nice script --nice <bool>

仍然使用默认值(特定于用户设置)。这种方法的一个(间接相关的)缺点是"nargs"可能捕捉到位置参数——请参阅这个相关问题和argparse bug报告。

相关讨论

关于type=bool和type='bool'的含义似乎有些困惑。一个(或两个)是指"运行函数EDOCX1"〔5〕还是"返回布尔值"？从目前的情况来看，type='bool'毫无意义。add_argument给出'bool' is not callable错误，与使用type='foobar'或type='int'相同。

但是，argparse确实有注册表，允许您这样定义关键字。它主要用于action，例如"action='store'u true"。您可以看到注册关键字：

1	parser._registries

显示字典

1
2
3
4
5

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

定义了很多操作，但只有一种类型，默认类型，argparse.identity。

此代码定义了一个"bool"关键字：

1
2
3
4
5
6
7
8
9

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采用函数和类值。有很多stackoverflow示例可以为两者定义自定义值。

如果前面的讨论不明显，那么bool()并不意味着"分析字符串"。从python文档中：

bool(x): Convert a value to a Boolean, using the standard truth testing procedure.

把这个和

int(x): Convert a number or string x to an integer.

相关讨论

oneliner：

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

相关讨论

这里是另一个没有额外行/秒来设置默认值的变体。bool总是分配一个值，这样就可以在没有预检查的情况下在逻辑语句中使用它。

1
2
3
4
5
6
7
8
9
10

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 == True:
print("Do something")
else:
print("Don't do something")
print("Check that args.do_something=" + str(args.do_something) +" is always a bool")

相关讨论

我也在寻找同样的问题，我想最好的解决办法是：

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

并使用它将字符串解析为布尔值，如上所述。

相关讨论

除了@mgilson所说的，还应该注意到还有一个ArgumentParser.add_mutually_exclusive_group(required=False)方法，可以使强制执行--flag和--no-flag不同时使用变得简单。

这适用于我所期望的一切：

1
2
3
4
5
6
7

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

代码：

1
2
3
4
5
6
7
8
9
10
11
12

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')

相关讨论

类似的方法是使用：

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

如果您设置了参数——命令中的特性

1	command --feature

如果不设置类型，参数将为true——特性参数默认值始终为false！

相关讨论

一个简单的方法是如下使用。

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

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)

我认为最典型的方法是：

1
2
3

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

ENSURE = config.ensure is None