我想使用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("")的值为False。
我怎么能得到argparse解析“假”，“F”，和他们的小写变体为假?
当前回答
使用前面建议的另一个解决方案，但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>
并且仍然使用默认值(特定于用户设置)。这种方法的一个(间接相关的)缺点是'nargs'可能会捕获一个位置参数——请参阅这个相关问题和这个argparse错误报告。
其他回答
类似的用法是:
feature.add_argument('--feature',action='store_true')
如果你在命令中设置参数-feature
command --feature
参数将为True，如果你不设置type -feature参数默认为False!
一个更简单的方法是使用如下所示。
parser.add_argument('--feature', type=lambda s: s.lower() in ['true', 't', 'yes', '1'])
您可以创建一个BoolAction，然后使用它
class BoolAction(Action):
def __init__(
self,
option_strings,
dest,
nargs=None,
default: bool = False,
**kwargs,
):
if nargs is not None:
raise ValueError('nargs not allowed')
super().__init__(option_strings, dest, default=default, **kwargs)
def __call__(self, parser, namespace, values, option_string=None):
input_value = values.lower()
b = input_value in ['true', 'yes', '1']
if not b and input_value not in ['false', 'no', '0']:
raise ValueError('Invalid boolean value "%s".)
setattr(namespace, self.dest, b)
然后在parser.add_argument()中设置action=BoolAction
我认为更规范的做法是:
command --feature
and
command --no-feature
Argparse很好地支持这个版本:
Python 3.9 +:
parser.add_argument('--feature', action=argparse.BooleanOptionalAction)
Python < 3.9:
parser.add_argument('--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?
对于type=bool和type='bool'可能意味着什么，似乎存在一些混淆。一个(或两个)应该意味着'运行函数bool()，还是'返回布尔值'?type='bool'没有任何意义。Add_argument给出了一个'bool'不可调用的错误，与使用type='foobar'或type='int'时相同。
但argparse确实有注册表，允许你这样定义关键字。它主要用于动作，例如:action = store_true”。你可以看到注册的关键字:
parser._registries
它显示了一个字典
{'action': {None: argparse._StoreAction,
'append': argparse._AppendAction,
'append_const': argparse._AppendConstAction,
...
'type': {None: <function argparse.identity>}}
这里定义了许多操作，但只有一种类型，即默认的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()，但也没有隐藏。在大多数情况下，程序员不需要知道它，因为类型和动作需要函数值和类值。在stackoverflow中有许多为两者定义自定义值的示例。
如果从前面的讨论中不明显，bool()并不意味着“解析字符串”。来自Python文档:
bool(x):使用标准真值测试程序将值转换为布尔值。
对比一下
int(x):将数字或字符串x转换为整数。
