Argparse optional positional arguments？

python argparse

2022-09-05 01:20:35

我有一个脚本，可以这样使用：usage: installer.py dir [-h] [-v]

dir是一个位置参数，定义如下：

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

我希望是可选的：当它未指定时，它应该只是.dircwd

不幸的是，当我不指定参数时，我得到.dirError: Too few arguments

答案 1

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

答案 2

作为@VinaySajip答案的扩展。还有其他值得一提的麻醉剂。

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

编辑（从@Acumenus的评论中复制）文档说：“？”。如果可能，将从命令行使用一个参数，并将其作为单个项生成。如果不存在命令行参数，则将生成默认值。nargs='?'