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
相關文章
相關標籤/搜索