Argparse可选的位置参数?


651

我有一个打算像这样使用的脚本: usage: installer.py dir [-h] [-v]

dir 是一个位置参数,其定义如下:

parser.add_argument('dir', default=os.getcwd())

我希望dir可以是可选的:未指定时,它应该只是cwd

不幸的是,当我不指定dir参数时,我得到了Error: Too few arguments

Answers:


825

使用nargs='?'(或nargs='*' 如果您需要多个目录)

parser.add_argument('dir', nargs='?', default=os.getcwd())

扩展示例:

>>> import os, argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-v', action='store_true')
_StoreTrueAction(option_strings=['-v'], dest='v', nargs=0, const=True, default=False, type=None, choices=None, help=None, metavar=None)
>>> parser.add_argument('dir', nargs='?', default=os.getcwd())
_StoreAction(option_strings=[], dest='dir', nargs='?', const=None, default='/home/vinay', type=None, choices=None, help=None, metavar=None)
>>> parser.parse_args('somedir -v'.split())
Namespace(dir='somedir', v=True)
>>> parser.parse_args('-v'.split())
Namespace(dir='/home/vinay', v=True)
>>> parser.parse_args(''.split())
Namespace(dir='/home/vinay', v=False)
>>> parser.parse_args(['somedir'])
Namespace(dir='somedir', v=False)
>>> parser.parse_args('somedir -h -v'.split())
usage: [-h] [-v] [dir]

positional arguments:
  dir

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

14
执行?*意味着他们在正则表达式(即意味着同样的事情?需要0或1,和*需要0或以上)?如果是这样,是否+还有效?
Dolan Antenucci 2013年

37
@dolan:是的+,也可以。有关详细信息,请参见docs.python.org/2/library/argparse.html#nargs
Vinay Sajip,2013年

2
有什么办法让dir显示在可选参数中?或位置参数似乎应该有一个前置的“可选”限定词。是否可以这样注册(就帮助而言)?
scagnetti 2014年

6
@ant从上面,您可以看到dir是可选的(它在argparse输出中的方括号中表示)。
Vinay Sajip 2014年

1
Tx!我尝试从而options.dir不是从访问目录args.dir
ptim

69

作为@VinaySajip答案的扩展。还有其他nargs值得一提的

  1. parser.add_argument('dir', nargs=1, default=os.getcwd())

N(整数)。命令行中的N个参数将一起收集到一个列表中

  1. parser.add_argument('dir', nargs='*', default=os.getcwd())

'*'。存在的所有命令行参数都收集到一个列表中。请注意,使用多个位置参数通常没有多大意义nargs='*',但可以使用多个可选参数nargs='*'

  1. parser.add_argument('dir', nargs='+', default=os.getcwd())

'+'。就像'*'一样,所有存在的命令行参数都被收集到一个列表中。此外,如果没有至少一个命令行参数,则会生成一条错误消息。

  1. parser.add_argument('dir', nargs=argparse.REMAINDER, default=os.getcwd())

argparse.REMAINDER。所有其余的命令行参数都收集到一个列表中。这对于分派到其他命令行实用工具的命令行实用工具通常很有用

如果nargs未提供关键字参数,则消耗的参数数量由操作确定。通常,这意味着将使用单个命令行参数,并且将生成单个项目(而不是列表)。

编辑(从@Acumenus的评论复制) nargs='?' 文档说:“?”。如果可能,将从命令行使用一个参数,并将其作为单个项目产生。如果不存在命令行参数,则将生成默认值。


3
但是应该注意,nargs='?'它不会产生列表。
Acumenus

@ABB答案的最后一行Generally this means a single command-line argument will be consumed and a single item (not a list) will be produced.希望这对您有所帮助……
Matas Vaitkevicius

1
带引号的行是指未定义nargs,但nargs='?'正在定义它的情况。该文件说:“?”。如果可能,将从命令行使用一个参数,并将其作为单个项目产生。如果不存在命令行参数,则将生成默认值。
Acumenus's

@ABB如果您觉得缺少某些内容,请编辑答案。谢谢。
Matas Vaitkevicius

在我看来,nargs=argparse.REMAINDER和之间的区别是什么nargs='*'(在Python 2.7.10和Python 3.6.1中测试),它们之间的区别是相同的吗?

-5

parser.add_argument需要一个开关。您可以使用required=False。这是Python 2.7的样本片段:

parser = argparse.ArgumentParser(description='get dir')
parser.add_argument('--dir', type=str, help='dir', default=os.getcwd(), required=False)
args = parser.parse_args()

11
OP询问的是位置参数,而不是“ --dir”。'required'是无效的位置参数。“假”是一个错字,她的意思是“假”。+1代表新手,-1代表草率。
SoloPilot 2016年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.