argparse 可选位置参数？

Posted 2023-02-23

【中文标题】argparse 可选位置参数？

【英文标题】：Argparse optional positional arguments?

【发布时间】：2011-05-27 16:13:10

【问题描述】：

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

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

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

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

不幸的是，当我没有指定dir 参数时，我得到Error: 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

【讨论】：

? 和 * 在正则表达式中的含义是否相同（即? 需要 0 或 1，* 需要 0 或更多）？如果是这样，+ 也可以吗？

@dolan：是的，+ 也可以。详情请见docs.python.org/2/library/argparse.html#nargs。

有没有办法让 dir 出现在可选参数中？或者似乎位置参数应该有一个前面的“可选”限定符。是否可以这样注册（就帮助而言）？

@ant 从上面可以看出 dir 是可选的（它出现在 argparse 输出中的方括号中表明了这一点）。

这里是更新的 (Python 3) 文档——仔细阅读它可以解释一切：docs.python.org/3/library/argparse.html#nargs。对于 argparse 模块的新手，请从教程开始：docs.python.org/3/howto/argparse.html

【参考方案2】：

作为@VinaySajip 答案的扩展。 There are additional nargs worth mentioning.

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='?' The docs 说：“？”。如果可能，将从命令行使用一个参数并作为单个项目生成。如果不存在命令行参数，则将生成默认值。

【讨论】：

但应注意nargs='?' 不会生成列表。

@A-B-B 答案的最后一行Generally this means a single command-line argument will be consumed and a single item (not a list) will be produced. 希望这会有所帮助...

引用的行是指没有定义nargs，但nargs='?'正在定义的情况。 docs 说：'?'。如果可能，将从命令行使用一个参数，并将其作为单个项目生成。如果不存在命令行参数，则将生成默认值。

@A-B-B 如果您觉得缺少某些内容，只需编辑答案。谢谢。

nargs=argparse.REMAINDER 和 nargs='*' 有什么区别，在我看来，它们的效果是相同的（在 Python 2.7.10 和 Python 3.6.1 中测试）？

【参考方案3】：

parser.add_argument 也有一个开关必需。您可以使用required=False。 这是 Python 2.7 的示例 sn-p：

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

【讨论】：

OP 询问的是位置参数，而不是“--dir”。 'required' 是位置参数的无效参数。而“假”是一个错字，她的意思是“假”。新手 +1，草率 -1。

我们不能使用required 作为位置参数。