关于Python可选:argparse题元的位置吗?

Argparse optional positional arguments?

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

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

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

我希望dir是可选的:如果没有指定,它应该只是cwd

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


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

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

扩展示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
>>> 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

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

  • parser.add_argument('dir', nargs='*', default=os.getcwd())
  • ‘*’。所有存在的命令行参数都被收集到一个列表中。注意,对于nargs='*'有多个位置参数通常没有多大意义,但是对于nargs='*'有多个可选参数是可能的。

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

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

    如果没有提供nargs关键字参数,则使用的参数数量由操作决定。一般来说,这意味着将使用单个命令行参数并生成单个项(而不是列表)。


    parser.add_argument还需要一个开关。您可以使用required=False。下面是一个使用python 2.7的示例片段:

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