两个argparse参数,可以是位置的也可以是可选的

时间:2018-03-01 20:43:54

标签: python argparse

我试图在Python 3.5(Debian 9附带的Python版本)中创建一个带有两个命令行参数的程序:输入文件名和输出文件名。

  • 输入文件名必须位于输出文件名或之前 本身前面有-i
  • 输出文件名是可选的。如果存在,则输入文件 名称前面没有-i,它必须跟在输入文件之后 名称或其本身前面有-o

因此我想接受以下命令行:

programname.py infilename
programname.py -i infilename
programname.py infilename outfilename
programname.py -i infilename outfilename
programname.py infilename -o outfilename
programname.py -i infilename -o outfilename
programname.py outfilename -i infilename
programname.py -o outfilename -i infilename
programname.py -o outfilename infilename

用法消息可能如下所示:

programname.py [-i] infilename [[-o] outfilename]

但我不能从documentation of the argparse module告诉我如何在add_argument()的论据中表达这一点。当我为一个参数赋予两个名称时,一个位置和一个名称,add_argument()引发异常:

ValueError: invalid option string 'infilename': must start with a character '-'

我在Stack Overflow中搜索了类似的问题,找到了hpaulj's answer to Python argparse - mandatory argument - either positional or optionalhpaulj's answer to argparse: let the same required argument be positional OR optional。这些答案中的构造使用一组两个互斥的参数,一个是位置的,一个是命名的。但它似乎不适用于多个这样的论点。尝试使用以这种方式构建的解析器来解析-i infilename outfilename会产生一个不同的异常:

argparse.ArgumentError: argument INFILE: not allowed with argument -i

但是,argparse本身无法打印此例外,甚至无法显示--help

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  [8+ layers of method calls within `argparse.py` omitted]
  File "/usr/lib/python3.5/argparse.py", line 396, in _format_actions_usage
    start = actions.index(group._group_actions[0])
IndexError: list index out of range

已弃用的optparse模块将位置参数存储在单独的列表中,解析后运行的代码可以读取以填充is None的每个参数。 argparse中与此列表直接对应的是parser.add_argument('args', nargs=argparse.REMAINDER)。在调用parse_args()之后手动处理位置参数是使用argparse接受上面显示的所有命令行表单的唯一方法吗?

#!/usr/bin/env python3
import argparse
import traceback

def mkparser1():
    """Raise an error.

ValueError: invalid option string 'infilename': must start with a character '-'
"""
    parser = argparse.ArgumentParser()
    parser.add_argument("infilename", "-i", metavar="INFILE")
    parser.add_argument("outfilename", "-o", required=False, metavar="INFILE")
    return parser

def mkparser2():
    """Do not raise an error but return an inadequate parser.

When asked -i infilename outfilename
"""
    parser = argparse.ArgumentParser()
    group = parser.add_mutually_exclusive_group(required=True)
    group.add_argument("infilename", nargs="?", metavar="INFILE")
    group.add_argument('-i', dest="infilename", metavar="INFILE")
    group = parser.add_mutually_exclusive_group(required=False)
    parser.add_argument("outfilename", nargs="?", metavar="OUTFILE")
    parser.add_argument("-o", dest="outfilename", metavar="OUTFILE")
    return parser

def test():
    parser = mkparser2()
    argstrings = [
        "infilename",
        "-i infilename",
        "infilename outfilename",
        "-i infilename outfilename",
        "infilename -o outfilename",
        "-i infilename -o outfilename",
        "outfilename -i infilename",
        "-o outfilename -i infilename",
        "-o outfilename infilename",
        "--help",
    ]
    for s in argstrings:
        print("for", s)
        try:
            pargs = parser.parse_args(s.split())
        except Exception as e:
            traceback.print_exc()
        else:
            print("infilename is %s and outfilename is %s"
                  % (pargs.infilename, pargs.outfilename))

if __name__=='__main__':
    test()

1 个答案:

答案 0 :(得分:1)

您也许可以让您的程序接受可变数量的位置参数(0到2之间),这些位置参数将被添加到位置参数列表中(使用action="append"),还可以调用add_argument("-i",...)和{ {1}}处理标志的等效项。

通常,argparse选项属于位置类别或可选类别(但不能同时属于这两种类别)。因此,您需要将设置传递给argparse,以允许一些冗余,并在解析后处理冲突。例如,您可以将argparse配置为通过add_argument("-o",...)和位置-i INPUT接受输入文件,但是在解析后添加自定义检查以确保仅使用两种形式之一。 / p>

伪代码:

INPUT