Python argparse 不带参数的命令行标志

Question

如何向命令行参数添加可选标志？

例如。所以我可以写

python myprog.py 

或者

python myprog.py -w

我尝试过

parser.add_argument('-w')

但我只是收到一条错误消息，说

Usage [-w W]
error: argument -w: expected one argument

我认为这意味着它需要 -w 选项的参数值。接受旗帜的方式是什么？

我发现 http://docs.python.org/library/argparse.html 在这个问题上相当不透明。

Answer 1

正如您所看到的，参数 w 需要命令行上 -w 之后的值。如果您只是想通过设置变量 True 或 False 来切换开关，请查看 此处（特别是 store_true 和 store_false）

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-w', action='store_true')

，其中 action='store_true' 暗示 default=False 。

相反，您可以使用action='store_false'，这意味着default=True。

Answer 2

添加一个快速片段以使其准备好执行：

来源：myparser.py

import argparse
parser = argparse.ArgumentParser(description="Flip a switch by setting a flag")
parser.add_argument('-w', action='store_true')

args = parser.parse_args()
print args.w

用法：

python myparser.py -w
>> True

Answer 3

你的剧本是对的。但默认情况下是 None 类型。因此，除了 None 之外的任何其他值都被视为 true 被分配给 args.argument_name 变量。

我建议您添加一个 action="store_true"。这将形成 True/False 类型的标志。如果使用则为 True，否则为 False。

import argparse
parser = argparse.ArgumentParser('parser-name')
parser.add_argument("-f","--flag",action="store_true",help="just a flag argument")

用法

$ python3 script.py -f

解析后，用 args.f 检查时返回 true，

args = parser.parse_args()
print(args.f)

>>>true

Answer 4

如果您正在寻找二进制标志，则 argparse 操作 store_true 或 store_false 正是提供了这一点。 @Jdog 接受的答案很好地解释了这种方法。

官方文档也相当清楚。我只会用一行完成该示例，因此为了非常清楚 store_true/store_false 的作用：

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--fov', action='store_true')  # this is not in the docs!
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())  # --baz and --fov are missing
Out[4]: Namespace(bar=False, baz=True, foo=True, fov=False)  # mind the fov=False

---

一种稍微更强大的方法是使用 <代码>计数操作。在运行命令时设置详细级别时，您通常已经使用了这种类型的标志。

例如，ssh 的详细模式标志 -v 是一个计数器：

-v 详细模式。使 ssh 打印有关其进度的调试消息。这有助于调试连接、身份验证和配置问题。 多个-v
选项增加了冗长性。最大值为 3。

因此，如果您运行 ssh ，它是非详细的，ssh -v 稍微详细，ssh -vvv 是极其冗长。

使用Python中的argparse，这样的计数器标志可以定义如下：

parser.add_argument('--verbose', '-v', action='count', default=0)

如果你想将它用作布尔值（True/False）标志，那么您需要将 args.verbose 转换为布尔值。您可以自己明确地执行此操作，也可以依赖条件语句，例如 if args.verbose: ...。

这是一个完整的工作示例，说明如何使用计数器标志：

使用脚本test.py：

#!/usr/bin/env python3
# test.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--verbose', '-v', action='count', default=0)
args = parser.parse_args()

if args.verbose:
    print('verbose')
    print(f'verbosity level: {args.verbose}')
else:
    print('non-verbose')

您将获得以下输出：

python test.py 
>> non-verbose 

python test.py -v
>> verbose
>> verbosity level: 1

python test.py -vvv
>> verbose
>> verbosity level: 3

Answer 5

这是一种快速的方法，除了 sys 之外不需要任何东西。尽管功能有限：

flag = "--flag" in sys.argv[1:]

[1:] 是指完整文件名是 --flag