argparse 可选位置参数？

Question

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

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

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

我希望 dir 是可选的：如果未指定，它应该只是 cwd 。

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

原文由 Waldo Bronchart 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 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

原文由 Vinay Sajip 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

作为@VinaySajip 答案的扩展。 还有额外的 nargs 值得一提。

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

N（整数）。来自命令行的 N 个参数将被收集到一个列表中

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

‘*‘。存在的所有命令行参数都收集到一个列表中。 请注意，使用 nargs='*' 设置多个位置参数通常没有多大意义，但可以使用 nargs='*' 多个可选参数。

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

’+‘。就像’*‘一样，所有存在的命令行参数都被收集到一个列表中。此外，如果不存在至少一个命令行参数，则会生成一条错误消息。

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

argparse.REMAINDER 。所有剩余的命令行参数都收集到一个列表中。这对于分派到其他命令行实用程序的命令行实用程序通常很有用

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

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

原文由 Matas Vaitkevicius 发布，翻译遵循 CC BY-SA 4.0 许可协议