用于传递 "-a="的 Python argparse IndexError

Question

正在研究Python的argparse(3.6.7版本)的源码。如果您熟悉那段代码，将会很有帮助。以下代码将导致此库引发 IndexError:

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-a", action="store_true")
args = parser.parse_args("-a=".split())
print(args)

完整的错误信息是:

Traceback (most recent call last):
  File "argparseRaiseIndexError.py", line 5, in <module>
    args = parser.parse_args("-a=".split())
  File "/usr/lib/python3.6/argparse.py", line 1743, in parse_args
    args, argv = self.parse_known_args(args, namespace)
  File "/usr/lib/python3.6/argparse.py", line 1775, in parse_known_args
    namespace, args = self._parse_known_args(args, namespace)
  File "/usr/lib/python3.6/argparse.py", line 1981, in _parse_known_args
    start_index = consume_optional(start_index)
  File "/usr/lib/python3.6/argparse.py", line 1881, in consume_optional
    option_string = char + explicit_arg[0]
IndexError: string index out of range

如果我做对了，正确的行为是向用户报告错误输入(例如“-a=”)的错误，而不是引发异常。

看了一会儿代码，终于找到原因了。这是因为 '=' 发出 explicit_arg 信号，并且他们假定此字符串永远不会为空。事实上，他们从不对此进行测试，而是测试它是否为 None。在触发异常的函数 consume_optional 中，我们可以看到:

# if there is an explicit argument, try to match the
# optional's string arguments to only this
if explicit_arg is not None:
    # bla bla...
    option_string = char + explicit_arg[0] # Empty!           

这是一个旧错误吗？我应该如何报告这个错误？

Answer 1

这看起来像是几个病态病例的结合

In [177]: import argparse
In [178]: p = argparse.ArgumentParser()
In [179]: a1=p.add_argument('--aa')
In [180]: p.parse_args(['--a=10'])
Out[180]: Namespace(aa='10')
In [181]: p.parse_args(['--a='])
Out[181]: Namespace(aa='')
In [182]: a2=p.add_argument('--bb', action='store_true')
In [183]: p.parse_args(['--aa='])
Out[183]: Namespace(aa='', bb=False)
In [184]: p.parse_args(['--bb='])
usage: ipython3 [-h] [--aa AA] [--bb]
ipython3: error: argument --bb: ignored explicit argument ''
...
In [185]: a3=p.add_argument('-c')
In [186]: a4=p.add_argument('-d', action='store_true')
In [187]: p.parse_args(['-c='])
Out[187]: Namespace(aa=None, bb=False, c='', d=False)
In [188]: p.parse_args(['-d='])
...
-> 1881                         option_string = char + explicit_arg[0]
   1882                         new_explicit_arg = explicit_arg[1:] or None
   1883                         optionals_map = self._option_string_actions

IndexError: string index out of range

它出现在 -a、一个简短的可选和 store_true

据记载，长可选值(带有 --)可能采用 '=value'，如 In[180] 中所示。并且该值可能是 ''，如 In[181] 中所示。

事实证明，'-c=' 也可以这样工作。该代码实际上并没有试图阻止使用短的'='，即使它没有记录。我依稀记得我曾为此调查过另一个 SO 或 Python 错误问题。

将“=”与“store_true”一起使用应该是错误的。 'store_true' 不接受参数。因此 In[184] 引发了关于“显式参数”的正确错误。

short optional 与 long 真正不同的地方在于允许后面的 short，例如

In [190]: p.parse_args(['-dc='])
Out[190]: Namespace(aa=None, bb=False, c='=', d=True)

所以您的错误发生是因为您使用了一个简短的可选值“store_true”和“=”。所以有一系列的错误一起被遗漏了。我将不得不更仔细地研究该函数以准确识别序列。

我同意正确的操作是引发 ArgumentError 导致形式错误，如 In[184] 中所示。但由于它是几个错误的巧合，我也很想建议忽略它。

您可以在 https://bugs.python.org/ 举报.我已经尝试跟踪所有 argparse 错误，尽管我已经有一段时间没有贡献正式补丁了。

===

在 _parse_optional(self, arg_string): 中，'-a=' 导致它

return action, option_string, explicit_arg
(<the a action>, '-a', '')

(此函数不区分“-a=”和“--aa=”；有些人认为应该区分。)

在 consume_optional 中，我们获取该元组

action, option_string, explicit_arg = option_tuple

explicit_arg 不是 None，arg_count 是 0，它是一个单破折号选项，它“尝试解析出更多的单破折号选项”。

它将当前 Action 放回到 action_tuples 列表中作为 (, [], 'a')

它尝试构造一个新的短可选，例如'-'+explicit_arg[0]，同时将其余部分放回 explicit_arg[1:]。

通常此步骤会将 -cdefoo 处理为“-c”、“-d”、“-e=foo”。

这里有些细节我不太了解。但是，如果这在 99.999% 的情况下有效，并且仅在三重病理情况下失败，我会犹豫是否要更改任何内容。引入进一步错误或向后不兼容的可能性太大了。没有全职开发人员负责 argparse。