Argparse可选的位置参数?

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

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

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

我但愿dir是可选的:未指定时,应该只是cwdthis

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


#1楼

做为@VinaySajip答案的扩展。 还有其余值得一提的nargs命令行

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

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

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

'*'。 存在的全部命令行参数都收集到一个列表中。 请注意 ,使用nargs='*'包含多个位置参数一般没有多大意义,可是可使用多个使用nargs='*'可选参数。 ip

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

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

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

argparse.REMAINDER 。 全部其他的命令行参数都收集到一个列表中。 这对于分派到其余命令行实用工具的命令行实用工具一般颇有用 get

若是未提供nargs关键字参数,则消耗的参数数量由操做肯定。 一般,这意味着将使用单个命令行参数,而且将生成单个项目(而不是列表)。 string

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


#2楼

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

#3楼

使用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
相关文章
相关标签/搜索