109

我一直在使用argparse一个 Python 程序,它可以-process-upload或两者兼而有之:

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 方法是什么?

4

11 回答 11

133
if not (args.process or args.upload):
    parser.error('No action requested, add -process or -upload')
于 2011-07-17T09:51:37.687 回答
38
args = vars(parser.parse_args())
if not any(args.values()):
    parser.error('No arguments provided.')
于 2013-03-02T13:59:23.967 回答
34

我知道这已经很老了,但是需要一个选项但禁止多个选项(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  
于 2015-10-09T22:30:52.640 回答
20

如果不是“或两者”部分(我最初错过了这个),你可以使用这样的东西:

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

不过,使用子命令可能是一个更好的主意。

于 2011-07-17T09:52:42.440 回答
10

需求审查

  • 使用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}

请注意,“进程”和“上传”键的布尔值不是计数器,而是计数器。

事实证明,我们无法防止这些词的重复:

$ 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非常适合命令行解析。

于 2014-06-09T21:13:04.327 回答
7

对于http://bugs.python.org/issue11588,我正在探索推广该mutually_exclusive_group概念以处理此类案例的方法。

通过这个开发argparse.pyhttps://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)清楚吗?一个必需的互斥组产生相同的东西。有其他的符号吗?

  • 使用这样的组是否比phihag's简单的测试更直观?

于 2014-06-10T20:42:06.757 回答
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 的参数

group = parser.add_mutually_exclusive_group(required=True)
于 2017-06-10T04:56:48.103 回答
5

如果您需要使用至少一个参数运行 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 管理整个参数解析器而不仅仅是选项。(我的意思是,如果你有一个--option带有 的标志nargs="+",那么--optionflag 至少需要一个参数。如果你有optionnargs="+"它需要至少一个参数。)

于 2013-07-20T00:12:21.837 回答
4

这达到了目的,这也将反映在 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#choices

于 2019-07-13T10:50:15.177 回答
3

也许使用子解析器?

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'您还可以绑定函数以在给定的子命令上直接调用(请参阅文档)。

于 2019-04-09T10:46:34.027 回答
1

将 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()
于 2014-06-10T18:35:03.777 回答