Argparse可选的位置参数?

时间:2010-12-18 20:45:36

标签: python argparse

我有一个脚本,意思是这样使用: usage: installer.py dir [-h] [-v]

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

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

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

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

3 个答案:

答案 0 :(得分:699)

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

答案 1 :(得分:57)

作为@VinaySajip答案的延伸。 There are additional nargs worth mentioning

  1. parser.add_argument('dir', nargs=1, default=os.getcwd())
  2. N(整数)。命令行中的N个参数将一起收集到列表中

    1. parser.add_argument('dir', nargs='*', default=os.getcwd())
    2. '*'。存在的所有命令行参数都收集到列表中。 注意,使用nargs='*'多个位置参数通常没有多大意义,但可以使用nargs='*'多个可选参数。

      1. parser.add_argument('dir', nargs='+', default=os.getcwd())
      2. '+'。就像'*'一样,所有存在的命令行参数都被收集到一个列表中。此外,如果不存在至少一个命令行参数,将生成错误消息。

        1. parser.add_argument('dir', nargs=argparse.REMAINDER, default=os.getcwd())
        2. argparse.REMAINDER。所有剩余的命令行参数都收集到一个列表中。这对于调度到其他命令行实用程序的命令行实用程序通常很有用

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

答案 2 :(得分:-5)

required=False还有一个必需的开关。您可以使用parser = argparse.ArgumentParser(description='get dir') parser.add_argument('--dir', type=str, help='dir', default=os.getcwd(), required=False) args = parser.parse_args() 。 以下是使用Python 2.7的示例代码段:

{{1}}