Python argparse：至少需要一个参数

Question

我一直在使用 argparse 作为一个可以 -process、-upload 或两者兼有的 Python 程序：

parser = argparse.ArgumentParser(description='Log archiver arguments.')
parser.add_argument('-process', action='store_true')
parser.add_argument('-upload',  action='store_true')
args = parser.parse_args()

如果没有至少一个参数，该程序就毫无意义。如何配置 argparse 来强制选择至少一个参数？

更新：

按照评论：用至少一个选项参数化程序的 Pythonic 方法是什么？

Answer 1

if not (args.process or args.upload):
    parser.error('No action requested, add -process or -upload')

Answer 2

我知道这已经很古老了，但是需要一个选项但禁止多个选项（XOR）的方法是这样的：

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument('-process', action='store_true')
group.add_argument('-upload',  action='store_true')
args = parser.parse_args()
print(args)
    

输出：

>opt.py  
usage: multiplot.py [-h] (-process | -upload)  
multiplot.py: error: one of the arguments -process -upload is required  
    
>opt.py -upload  
Namespace(process=False, upload=True)  
  
>opt.py -process  
Namespace(process=True, upload=False)  
  
>opt.py -upload -process  
usage: multiplot.py [-h] (-process | -upload)  
multiplot.py: error: argument -process: not allowed with argument -upload  

Answer 3

args = vars(parser.parse_args())
if not any(args.values()):
    parser.error('No arguments provided.')

Answer 4

如果不是“或两者”部分（我最初错过了这一点），你可以使用这样的东西：

parser = argparse.ArgumentParser(description='Log archiver arguments.')
parser.add_argument('--process', action='store_const', const='process', dest='mode')
parser.add_argument('--upload',  action='store_const', const='upload', dest='mode')
args = parser.parse_args()
if not args.mode:
    parser.error("One of --process or --upload must be given")

不过，使用 子命令 代替。

Answer 5

需求审查

• 使用 argparse（我将忽略这一点）
• 允许调用一两个操作（至少需要一个）。
• 尝试使用Pythonic（我宁愿称其为“POSIX”式的）

在命令行中也有一些隐含的要求：

• 以易于理解的方式向用户解释用法
• 选项应该是可选的
• 允许指定标志和选项
• 允许与其他参数（如文件名或名称）组合。

使用 docopt 的示例解决方案（文件 managelog.py）：

"""Manage logfiles
Usage:
    managelog.py [options] process -- <logfile>...
    managelog.py [options] upload -- <logfile>...
    managelog.py [options] process upload -- <logfile>...
    managelog.py -h

Options:
    -V, --verbose      Be verbose
    -U, --user <user>  Username
    -P, --pswd <pswd>  Password

Manage log file by processing and/or uploading it.
If upload requires authentication, you shall specify <user> and <password>
"""
if __name__ == "__main__":
    from docopt import docopt
    args = docopt(__doc__)
    print args

尝试运行它：

$ python managelog.py
Usage:
    managelog.py [options] process -- <logfile>...
    managelog.py [options] upload -- <logfile>...
    managelog.py [options] process upload -- <logfile>...
    managelog.py -h

显示帮助：

$ python managelog.py -h
Manage logfiles
Usage:
    managelog.py [options] process -- <logfile>...
    managelog.py [options] upload -- <logfile>...
    managelog.py [options] process upload -- <logfile>...
    managelog.py -h

Options:
    -V, --verbose      Be verbose
    -U, --user <user>  Username
    -P, --pswd <pswd>  P    managelog.py [options] upload -- <logfile>...

Manage log file by processing and/or uploading it.
If upload requires authentication, you shall specify <user> and <password>

并使用它：

$ python managelog.py -V -U user -P secret upload -- alfa.log beta.log
{'--': True,
 '--pswd': 'secret',
 '--user': 'user',
 '--verbose': True,
 '-h': False,
 '<logfile>': ['alfa.log', 'beta.log'],
 'process': False,
 'upload': True}

简短的替代方案 short.py

还可以有更短的变体：

"""Manage logfiles
Usage:
    short.py [options] (process|upload)... -- <logfile>...
    short.py -h

Options:
    -V, --verbose      Be verbose
    -U, --user <user>  Username
    -P, --pswd <pswd>  Password

Manage log file by processing and/or uploading it.
If upload requires authentication, you shall specify <user> and <password>
"""
if __name__ == "__main__":
    from docopt import docopt
    args = docopt(__doc__)
    print args

用法如下所示：

$ python short.py -V process upload  -- alfa.log beta.log
{'--': True,
 '--pswd': None,
 '--user': None,
 '--verbose': True,
 '-h': False,
 '<logfile>': ['alfa.log', 'beta.log'],
 'process': 1,
 'upload': 1}

注意，“process”和“upload”键不是布尔值，而是计数器。

事实证明，我们无法避免重复这些词：

$ python short.py -V process process upload  -- alfa.log beta.log
{'--': True,
 '--pswd': None,
 '--user': None,
 '--verbose': True,
 '-h': False,
 '<logfile>': ['alfa.log', 'beta.log'],
 'process': 2,
 'upload': 1}

结论

设计良好的命令行界面有时可能具有挑战性。

基于命令行的程序有多个方面：

• argparse的命令行的良好设计
• 选择/使用适当的解析器

提供了很多，但限制了可能的场景并且可能变得非常复杂。

使用docopt，事情会变得更短，同时保持可读性并提供高度的灵活性。如果您设法从字典中获取解析后的参数，并手动（或通过其他名为 schema），您可能会发现 docopt 非常适合命令行解析。

Answer 6

对于http://bugs.python.org/issue11588，我正在探索概括mutually_exclusive_group的方法 概念来处理这样的情况。

通过此开发 argparse.py，https://github .com/hpaulj/argparse_issues/blob/nested/argparse.py
我可以写：

parser = argparse.ArgumentParser(prog='PROG', 
    description='Log archiver arguments.')
group = parser.add_usage_group(kind='any', required=True,
    title='possible actions (at least one is required)')
group.add_argument('-p', '--process', action='store_true')
group.add_argument('-u', '--upload',  action='store_true')
args = parser.parse_args()
print(args)

它会产生以下 help:

usage: PROG [-h] (-p | -u)

Log archiver arguments.

optional arguments:
  -h, --help     show this help message and exit

possible actions (at least one is required):
  -p, --process
  -u, --upload

这接受像 '-u'、'-up'、'--proc --up' 等输入。

它最终会运行类似的测试到 https://stackoverflow.com/a/6723066/901925，尽管错误消息需要更清晰：

usage: PROG [-h] (-p | -u)
PROG: error: some of the arguments process upload is required

我想知道：

• 参数 kind='any', required=True 是否足够清晰（接受任意一组；至少需要一个）？

• 用法(-p | -u)清楚吗？所需的mutual_exclusive_group 会产生相同的结果。是否有一些替代符号？

• 使用这样的组比 phihag 的 简单测试更直观吗？

Answer 7

最好的方法是使用 python 内置模块 add_mutually_exclusive_group。

parser = argparse.ArgumentParser(description='Log archiver arguments.')
group = parser.add_mutually_exclusive_group()
group.add_argument('-process', action='store_true')
group.add_argument('-upload',  action='store_true')
args = parser.parse_args()

如果您只想通过命令行选择一个参数，只需使用 required=True 作为组的参数

group = parser.add_mutually_exclusive_group(required=True)

Answer 8

这达到了目的，并且这也将反映在 argparse 自动生成的 --help 输出中，恕我直言，这是大多数理智的程序员想要的（也适用于可选参数）：

parser.add_argument(
    'commands',
    nargs='+',                      # require at least 1
    choices=['process', 'upload'],  # restrict the choice
    help='commands to execute'
)

关于此的官方文档：
https://docs.python.org/3/library/argparse.html#选择

Answer 9

如果您需要 python 程序至少使用一个参数运行，请添加一个不具有选项前缀（默认为 - 或 --）的参数，并设置 nargs=+（至少需要一个参数）。我发现这个方法的问题是，如果不指定参数，argparse 将生成“参数太少”错误，并且不会打印出帮助菜单。如果您不需要该功能，请按以下方式在代码中执行此操作：

import argparse

parser = argparse.ArgumentParser(description='Your program description')
parser.add_argument('command', nargs="+", help='describe what a command is')
args = parser.parse_args()

我认为当您添加带有选项前缀的参数时，nargs 控制整个参数解析器而不仅仅是选项。 （我的意思是，如果您有一个带有 nargs="+" 的 --option 标志，那么 --option 标志至少需要如果您有 option 和 nargs="+"，则它至少需要一个参数。）

Answer 10

也许使用子解析器？

import argparse

parser = argparse.ArgumentParser(description='Log archiver arguments.')
subparsers = parser.add_subparsers(dest='subparser_name', help='sub-command help')
parser_process = subparsers.add_parser('process', help='Process logs')
parser_upload = subparsers.add_parser('upload', help='Upload logs')
args = parser.parse_args()

print("Subparser: ", args.subparser_name)

现在 --help 显示：

$ python /tmp/aaa.py --help
usage: aaa.py [-h] {process,upload} ...

Log archiver arguments.

positional arguments:
  {process,upload}  sub-command help
    process         Process logs
    upload          Upload logs

optional arguments:
  -h, --help        show this help message and exit
$ python /tmp/aaa.py
usage: aaa.py [-h] {process,upload} ...
aaa.py: error: too few arguments
$ python3 /tmp/aaa.py upload
Subparser:  upload

您也可以向这些子解析器添加其他选项。此外，您还可以绑定要在给定子命令上直接调用的函数，而不是使用 dest='subparser_name' （请参阅文档）。

Answer 11

对于像这样的情况

parser.add_argument("--a")
parser.add_argument("--b")

我们可以使用以下

if not args.a and not args.b:
    parser.error("One of --a or --b must be present")

Answer 12

对操作列表使用append_const，然后检查该列表是否已填充：

parser.add_argument('-process', dest=actions, const="process", action='append_const')
parser.add_argument('-upload',  dest=actions, const="upload", action='append_const')

args = parser.parse_args()

if(args.actions == None):
    parser.error('Error: No actions requested')

您甚至可以直接在常量中指定方法。

def upload:
    ...

parser.add_argument('-upload',  dest=actions, const=upload, action='append_const')
args = parser.parse_args()

if(args.actions == None):
    parser.error('Error: No actions requested')

else:
    for action in args.actions:
        action()

Answer 13

使用

    parser = argparse.ArgumentParser(description='Log archiver arguments.')
    parser.add_argument('-process', action='store_true')
    parser.add_argument('-upload',  action='store_true')
    args = parser.parse_args()

Maybe try：

    if len([False for arg in vars(args) if vars(args)[arg]]) == 0: 
        parsers.print_help()
        exit(-1)

至少这是我刚刚使用的；希望这对将来的人有帮助！