Python argparse 位置参数和子命令

Question

我正在使用 argparse 并尝试混合子命令和位置参数，出现了以下问题。

此代码运行良好：

import argparse
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()

parser.add_argument('positional')
subparsers.add_parser('subpositional')

parser.parse_args('subpositional positional'.split())

上面的代码将参数解析为 Namespace(positional='positional')，但是当我将位置参数更改为 nargs='?' 时因此：

import argparse
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()

parser.add_argument('positional', nargs='?')
subparsers.add_parser('subpositional')

parser.parse_args('subpositional positional'.split())

它会出错：

usage: [-h] {subpositional} ... [positional]
: error: unrecognized arguments: positional

这是为什么？

Answer 1

起初我认为与 jcollado 相同，但事实是，如果后续（顶级）位置参数具有特定的 nargs (nargs = None, nargs = 整数），那么它就会按您的预期工作。当 nargs 为 '?' 或 '*' 时失败，有时当它为 '+' 时失败。因此，我深入研究代码，弄清楚发生了什么。

它归结为参数被分割以供使用的方式。为了弄清楚谁得到了什么，对 parse_args 的调用将参数总结为 'AA' 等字符串，在您的情况下 ('A'对于位置参数，'O' 表示可选），最终生成一个与该摘要字符串匹配的正则表达式模式，具体取决于您通过 添加到解析器的操作。 add_argument 和.add_subparsers 方法。

在每种情况下，例如，参数字符串最终都是 'AA'。改变的是要匹配的模式（您可以在 argparse.py 中的 _get_nargs_pattern 下看到可能的模式。对于 subpositional ，它最终是 < code>'(-*A[-AO]*)'，这意味着允许一个参数后跟任意数量的选项或参数对于位置，这取决于传递给的值nargs：

• 无 => '(-*A-*)'
• 3 => '(-*A-* A-*A-*)'（每个预期参数一个 '-*A'）
• '?' => '(-* A?-*)'
• '*' => '(-*[A-]*)'
• '+' => '(-*A[A-]*)'< /code>

这些模式被附加，对于 nargs=None （您的工作示例），您最终会得到 '(-*A[-AO]*)(-*A-* )'，匹配两个组['A', 'A'] 这样，subpositional 将仅解析 subpositional （您想要的），而 positional 将匹配其操作。

但是，对于 nargs='?'，您最终会得到 '(-*A[-AO]*)(-*A?-*)'。第二组完全由可选模式组成，并且*是贪婪的，这意味着第一组通配字符串中的所有内容，最终识别出两个组[ 'AA'，'']。这意味着 subpositional 有两个参数，当然最终会令人窒息。

有趣的是，nargs='+' 的模式是 '(-*A[-AO]*)(-*A[A-]*)'，其中只要你只传递一个参数就可以工作。说subpositional a，因为您需要在第二组中至少有一个位置参数。同样，由于第一组是贪婪的，因此传递 subpositional abc d 会得到 ['AAAA', 'A']，这不是您想要的。

简而言之：一团糟。我想这应该被认为是一个错误，但不确定如果模式变成非贪婪模式会产生什么影响......

Answer 2

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('positional', nargs='?')

subparsers = parser.add_subparsers()
subparsers.add_parser('subpositional')

print(parser.parse_args(['positional', 'subpositional']))
# -> Namespace(positional='positional')
print(parser.parse_args(['subpositional']))
# -> Namespace(positional=None)
parser.print_usage()
# -> usage: bpython [-h] [positional] {subpositional} ...

常见的做法是命令之前（左侧）的参数属于主程序，命令之后（右侧）的参数属于命令。因此，positional 应该位于命令 subpositional 之前。示例程序：git、twistd。

此外，带有 narg=? 的参数可能应该是一个选项 (--opt=value)，而不是位置参数。

Answer 3

我认为问题在于，当调用 add_subparsers 时，会向原始解析器添加一个新参数以传递子解析器的名称。

例如，使用以下代码：

import argparse
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()

parser.add_argument('positional')                                             
subparsers.add_parser('subpositional')                                             

parser.parse_args()

您将获得以下帮助字符串：

usage: test.py [-h] {subpositional} ... positional

positional arguments:
  {subpositional}
  positional

optional arguments:
  -h, --help       show this help message and exit

请注意，subpositional 显示在 positional 之前。我想说你要寻找的是在子解析器名称之前有位置参数。因此，您可能正在寻找的是在子解析器之前添加参数：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('positional')

subparsers = parser.add_subparsers()
subparsers.add_parser('subpositional')

parser.parse_args()

使用此代码获得的帮助字符串是：

usage: test.py [-h] positional {subpositional} ...

positional arguments:
  positional
  {subpositional}

optional arguments:
  -h, --help       show this help message and exit

这样，您首先将参数传递给主解析器，然后传递子解析器的名称，最后传递给主解析器的参数子解析器（如果有）。

Answer 4

Python 3.5 中仍然是一团糟。

我建议子类 ArgumentParser 保留所有剩余的位置参数，并稍后处理它们：

import argparse

class myArgumentParser(argparse.ArgumentParser):
    def parse_args(self, args=None, namespace=None):
       args, argv = self.parse_known_args(args, namespace)
       args.remaining_positionnals = argv
       return args

parser = myArgumentParser()

options = parser.parse_args()

剩余的位置参数在列表 options.remaining_positionals 中