协慌网

登录 贡献 社区

Argparse 可选的位置参数?

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

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

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

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

不幸的是,当我不指定dir参数时,出现Error: Too few arguments

答案

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

作为 @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='?'文档说:“?”。如果可能,将从命令行使用一个参数并将其作为单个项目产生。如果不存在命令行参数,则将生成默认值。

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