如何在python argparse中使参数可选

时间:2013-04-02 00:34:14

标签: python argparse

我想对myprog的这些调用工作,而不是其他人。

$ python3 myprog.py -i infile -o outfile
$ python3 myprog.py -o outfile
$ python3 myprog.py -o
$ python3 myprog.py 

特别是我想指定infile而不是outfile是非法的。

在第三种情况下,假定outfile的默认名称为“out.json”。在第二种,第三种和第四种情况下,假定输入文件的默认名称为“file.n.json”,其中n是整数版本号。在第四种情况下,输出文件将是“file.n + 1.json”,其中n + 1是比输入文件上的版本号大1的版本号。我的代码的相关部分是:

import argparse

parser = argparse.ArgumentParser(description="first python version")
parser.add_argument('-i', '--infile', nargs=1, type=argparse.FileType('r'), help='input file, in JSON format')
parser.add_argument('-o', '--outfile', nargs='?', type=argparse.FileType('w'), default='out.json', help='output file, in JSON format')

args = parser.parse_args()

print("Here's what we saw on the command line: ")
print("args.infile",args.infile)
print("args.outfile",args.outfile)

if args.infile and not args.outfile:
    parser.error("dont specify an infile without specifying an outfile")
elif not args.infile:
    print("fetching infile")
else: # neither was specified on the command line
    print("fetching both infile and outfile")

问题是,当我跑

$ python3 myprog.py -i infile.json

而不是我希望的解析器错误,我得到:

Here's what we saw on the command line: 
args.infile [<_io.TextIOWrapper name='infile.json' mode='r' encoding='UTF-8'>]
args.outfile <_io.TextIOWrapper name='out.json' mode='w' encoding='UTF-8'>
fetching both infile and outfile

...这表明即使命令行上没有“-o”,它也会表现得好像。

2 个答案:

答案 0 :(得分:15)

作为所选答案的附加内容:

可以使用-o结合const来完成运行nargs='?'而不指定文件的选项。

来自文档:

  

使用选项字符串调用add_argument()时(如-f或--foo)   和nargs ='?'。这将创建一个可以遵循的可选参数   通过零个或一个命令行参数。解析命令行时,   如果遇到没有命令行参数的选项字符串   在它之后,将改为使用const的值。见   叙述说明的例子。

答案 1 :(得分:11)

您为outfile指定了默认参数。

parser.add_argument('-o', '--outfile', nargs='?', type=argparse.FileType('w'), default='out.json', help='output file, in JSON format')

如果未在命令行中指定-o选项,则arg解析器会插入默认参数。

将其更改为:

parser.add_argument('-o', '--outfile', nargs='?', type=argparse.FileType('w'), help='output file, in JSON format')

并且事情应该如你所愿。


如果您希望能够指定-o,而没有文件名,则可能需要以下内容:

out_file = args.out if args.out is not None else 'json.out'

如果您指定None没有参数,我不确定相关参数是''还是-o(即空字符串) - 我怀疑它是{{ 1}},但我不确定。你必须测试它才能确定。

如果没有argparse的额外逻辑,我不知道怎么做。