Question

在Python中使用argparse模块时，我正在寻找一种方法来捕获无效选项并更好地报告它们。 https://docs.python.org/3/library/argparse.html#invalid-arguments上的文档提供了一个示例：

parser = argparse.ArgumentParser(prog='PROG'
parser.add_argument('--foo', type=int)
parser.add_argument('bar', nargs='?')

# invalid option
parser.parse_args(['--bar'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: no such option: --bar

然而，由于不首先报告错误选项，所以很容易将其绊倒。例如：

import argparse
import datetime

def convertIsoTime(timestamp):
    """read ISO-8601 time-stamp using the AMS conventional format YYYY-MM-DDThh:mm:ssUTC"""
    try:
        return datetime.datetime.strptime(timestamp,"%Y-%m-%dT%H:%M:%SUTC")
    except:
        raise argparse.ArgumentTypeError("'{}' is not a valid ISO-8601 time-stamp".format(timestamp))

parser = argparse.ArgumentParser()
parser.add_argument('startTime', type=convertIsoTime)
parser.add_argument('--good', type=int,
                    help='foo')

args = parser.parse_args(['--gold','5','2015-01-01T00:00:00UTC'])

将报告：

error: argument startTime: '5' is not a valid ISO-8601 time-stamp

当我希望它报告更有用时：

error: no such option: --gold

有可能实现这一目标吗？在我看来，这是一个非常基本的用例。直接编写参数解析器时，我通常使用模式这样任何以 - 选项前缀不是已知选项开头的东西都会立即被拒绝。例如在bash中

# Process command-line arguments
while [ $# -gt 0 ]; do
   case "$1" in
   --debug)
      DEBUGOPTION="--debug"
      shift
      break;;
   --)
      shift
      break;;
   --*)
      handleUsageError "$1"
      shift;;
   *)
      break;;
   esac
done

我相信argparse在内部使用正则表达式，但我不认为它们可以通过add_argument（）访问

有没有办法用argparse轻松完成等效的工作？

Answer 1

简短的回答是parse_args使用parse_known_args。此方法允许您处理--gold等未知参数。因此，参数类型错误会在unknown arguments错误之前引发。

我添加了一个解决方案，该解决方案涉及对ArgumentParser进行子类化并在其调用堆栈中深入修改方法。

我会尝试概述适用于您的示例的parse_args。

它首先要做的是将字符串归类为O或A。简而言之，以-开头的O，其他A。它还尝试将O与定义的参数匹配。

在您的示例中，它找到OAA。正则表达式用于将此字符串与参数nargs定义的模式进行匹配。（如果需要，我可以更详细地解释这一步骤）

--gold不匹配;在某些时候（无论是在这个初始循环中还是以后），它都被放入extras列表中。（我会查看代码以获取详细信息）。

对于通过字符串的第二个循环，它会交替尝试处理postionals和optionals。

尝试将5与starttime匹配时，您的Action类会引发类型错误，该错误会传播到打印用法并退出。由于未定义--gold，因此5不会被视为可选的参数。因此它被解析为第一个位置字符串。（某些类型的可选项采用0个参数，因此它不会假设--...之后的任何内容是一个选项参数。）

我认为，如果没有5，最后一个字符串就会匹配。 parse_known_args将在--gold字词中返回extras。 parse_args使用parse_known_args，但在extras不为空时会引发错误。

因此，在某种意义上，解析器确实检测到了这两个错误，但它是触发错误消息的starttime错误。它一直等到最后抱怨无法识别的--gold。

作为一般原则，argparse不会尝试检测并显示所有错误。它不会收集错误列表以显示在最终的综合消息中。

我会查看代码以查看详细信息。我认为你不能轻易改变基本的解析模式。如果我想办法强制提前unrecognized option错误，我会编辑此答案。

def _parse_optional(self, arg_string):尝试对argv字符串进行分类。如果字符串看起来像positional，则返回None。如果它与Action option_string匹配，则返回带有匹配操作的元组＆＃39;（action，option_string，None）`。最后如果不匹配，则返回：

    # it was meant to be an optional but there is no such option
    # in this parser (though it might be a valid option in a subparser)
    return None, arg_string, None

我认为您--gold会发生这种情况。请注意它可能仍然是有效选项的原因。

此功能由

调用

def _parse_known_args(self, arg_strings, namespace):
  ...
  for i, arg_string in enumerate(arg_strings_iter):
      ....
      option_tuple = self._parse_optional(arg_string)
      if option_tuple is None:
         pattern = 'A'
      else:
         option_string_indices[i] = option_tuple
         pattern = 'O'
      arg_string_pattern_parts.append(pattern)
  ...
  # at the end
  # return the updated namespace and the extra arguments
  return namespace, extras

收集'AOO'模式，以及这些元组的列表。

在第二个循环期间，它会在消耗位置和选项之间交替显示。使用可选项的函数是：

def consume_optional(start_index):
    option_tuple = option_string_indices[start_index]
    action, option_string, explicit_arg = option_tuple
    if action is None:
       extras.append(arg_strings[start_index])
    ...otherwise...
       take_action(action, args, option_string)

正如我之前所写，你的--gold被放在extras列表中，而5仍然在可以被解析为位置的参数列表中。

namespace和extras通过parse_known_args传递给您，用户或parse_args。

可以想象，您可以继承ArgumentParser并定义修改后的_parse_optional方法。它可能会引发错误而不是返回(None, arg_string, None)元组。

import argparse
import datetime

class MyParser(argparse.ArgumentParser):
    def _parse_optional(self, arg_string):
        arg_tuple = super(MyParser, self)._parse_optional(arg_string)
        if arg_tuple is None:
            return arg_tuple  # positional
        else:
            if arg_tuple[0] is not None:
                return arg_tuple # valid optional
            else:
                msg = 'error: no such option: %s'%arg_string
                self.error(msg)

def convertIsoTime(timestamp):
    """read ISO-8601 time-stamp using the AMS conventional format YYYY-MM-DDThh:mm:ssUTC"""
    try:
        return datetime.datetime.strptime(timestamp,"%Y-%m-%dT%H:%M:%SUTC")
    except:
        raise argparse.ArgumentTypeError("'{}' is not a valid ISO-8601 time-stamp".format(timestamp))

# parser = argparse.ArgumentParser()
parser = MyParser()
parser.add_argument('startTime', type=convertIsoTime)
parser.add_argument('--good', type=int,
                    help='foo')

args = parser.parse_args(['--good','5','2015-01-01T00:00:00UTC'])
print(args)

args = parser.parse_args(['--gold','5','2015-01-01T00:00:00UTC'])

产生

1505:~/mypy$ python3 stack31317166.py 
Namespace(good=5, startTime=datetime.datetime(2015, 1, 1, 0, 0))
usage: stack31317166.py [-h] [--good GOOD] startTime
stack31317166.py: error: error: no such option: --gold

提供自定义操作的子类化很好argparse（和Python）练习。

如果您希望Python开发人员更多地考虑这种情况，请考虑编写bug/issue（在PEP中是为了更开发的正式创意）。但是有大量的argparse错误/补丁，以及对向后兼容性的大量警告。

http://bugs.python.org/issue?%40columns=id%2Cactivity%2Ctitle%2Ccreator%2Cassignee%2Cstatus%2Ctype&%40sort=-activity&%40filter=status&%40action=searchid&ignore=file%3Acontent&%40search_text=_parse_optional&submit=search&status=-1%2C1%2C2%2C3

是引用_parse_optional的错误/问题列表。可能的变化包括如何处理不明确的选项。（我会扫描它们，看看我是否忘记了任何内容。有些补丁是我的。）但是使用super，我建议的更改不会受到函数内更改的影响。它只受到函数调用方式和返回函数的变化的影响，这种情况发生的可能性要小得多。通过提交您自己的问题，您至少会让开发人员注意到有人依赖此接口。

使用python argparse模块首先报告无效选项（或使用正则表达式）

1 个答案: