Question

我有一个python脚本，它接受一个可选的位置参数，并有一些子命令。其中一些子命令需要位置参数，有些则不需要。当我尝试使用不需要位置参数的子命令时出现的问题。请考虑以下测试文件：

import argparse

argp = argparse.ArgumentParser()
argp.add_argument('inputfile', type=str, nargs='?',
                  help='input file to process')
argp.add_argument('--main_opt1', type=str,
                  help='global option')

subp = argp.add_subparsers(title='subcommands',
                           dest='parser_name',
                           help='additional help',
                           metavar="<command>")

tmpp = subp.add_parser('command1', help='command1 help')
tmpp.add_argument('pos_arg1', type=str,
                  help='positional argument')

print repr(argp.parse_args())

当我尝试将子命令command1与第一个参数一起使用时，一切顺利。

macbook-pro:~ jmlopez$ python pytest.py filename command1 otherarg
Namespace(inputfile='filename', main_opt1=None, parser_name='command1', pos_arg1='otherarg')

但现在让我们假设command1不需要第一个位置参数。

macbook-pro:~ jmlopez$ python pytest.py command1 otherarg
usage: pytest.py [-h] [--main_opt1 MAIN_OPT1] [inputfile] <command> ...
pytest.py: error: argument <command>: invalid choice: 'otherarg' (choose from 'command1')

我以某种方式期望将inputfile设置为None。 argparse是否可以预测command1实际上是一个子命令，因此inputfile应该设置为无？

Answer 1

要argp，subparser参数看起来就像另一个位置，一个选择（subparsers的名称）。此外argp对pos_arg1一无所知。那是在tmpp的参数列表中。

当argp看到filename command1 otherarg，filename和command1满足其2个位置时。然后otherarg传递tmpp。

使用command1 otherarg，再次输入2个字符串，2个argp个位置。 command被分配到inputfile。没有逻辑可以回溯并说command1更适合subcommands，或者'tmpp'需要其中一个字符串。

您可以将第1个位置更改为可选的--inputfile。

或者你可以inputfile tmpp的另一个位置。如果许多子分析师需要它，请考虑使用parents。

argparse并不像你一样聪明，也不能'提前思考'或'回溯'。如果它似乎做了一些聪明的事情，那是因为它使用re模式匹配来处理nargs值（例如？，*，+）。

修改

“欺骗”argparse识别第一个位置作为subparser的一种方法是在它之后插入一个可选项。使用command1 -b xxx otherarg，-b xxx会拆分位置字符串列表，因此只有command1与inputfile和subcommands匹配。

p=argparse.ArgumentParser()
p.add_argument('file',nargs='?',default='foo')
sp = p.add_subparsers(dest='cmd')
spp = sp.add_parser('cmd1')
spp.add_argument('subfile')
spp.add_argument('-b')

p.parse_args('cmd1 -b x three'.split())
# Namespace(b='x', cmd='cmd1', file='foo', subfile='three')

此处的问题是argparse如何处理变量nargs的postionals。第二个位置是一个subparser的事实并不重要。虽然argparse允许任何顺序的可变长度位置，但它如何处理它们可能会令人困惑。如果只有一个这样的位置，则更容易预测argparse将会做什么，并且它最终会发生。

Answer 2

你需要告诉解析器第一个参数是不同的类型。尝试添加标志选项和默认None值，如下所示：

argp.add_argument('-i','--inputfile', type=str, nargs='?',
              help='input file to process',default=None)

现在，您需要在inputfile参数之前添加-i，但它可以正常工作。

macbook-pro:~ jmlopez$ python pytest.py -i filename command1 otherarg
Namespace(inputfile='filename', main_opt1=None, parser_name='command1', pos_arg1='otherarg')

和

macbook-pro:~ jmlopez$ python pytest.py command1 otherarg
Namespace(inputfile=None, main_opt1=None, parser_name='command1', pos_arg1='otherarg')

argparse可选的位置参数和subparsers参数

2 个答案: