处理 Python ArgumentParser 中的错误

Question

我想手动处理parse_args() 在参数未知值的情况下引发错误的情况。例如： 如果我有以下名为script.py的python文件：

argp = argparse.ArgumentParser(description='example')
argp.add_argument('--compiler', choices=['default', 'clang3.4', 'clang3.5'])
args = argp.parse_args()

我使用以下参数运行脚本python script.py --compiler=foo 它会引发以下错误：

error: argument --compiler: invalid choice: 'foo' (choose from 'default', 'clang3.4', 'clang3.5')
SystemExit: 2

我需要做什么才能自己处理这种行为而不是脚本自行退出？一个想法是继承 argparse.ArgumentParser 并覆盖 parse_args() 或只是猴子修补该方法，但我想知道是否有更好的方法不需要覆盖标准库行为？

Answer 1

定义选择的重点是让解析器抱怨不在列表中的值。但也有一些替代方案：

• 省略选择（如果需要，可以将它们包含在帮助文本中），并在解析后进行自己的测试。 argparse 不必为您做所有事情。它的主要目的是弄清楚你的用户想要什么。

• 重新定义parser.error 方法（最好通过子类化）以重定向来自sys.exit 的错误。但是您必须解析错误消息以区分此错误和解析器可能引发的其他错误。

• 定义一个type 函数来检查选择并进行默认替换。

“--compiler”选项的解析是这样的：

• 在--compiler标志后面获取字符串参数
• 通过type 函数传递它。默认为lambda x:x。 int 将其转换为整数等。提高 ValueError 是值不正确。
• 对照choices 列表（如果有）检查返回值
• 使用action 将值添加到命名空间（默认只存储它）。

任何这些步骤中的错误都会产生一个ArgumentError，它被parser.error 方法捕获并传递给parser.exit 方法。

由于store_action 出现在type 和choices 检查之后，因此自定义操作不会绕过它们的错误。

这是一个可能的type 解决方案（未测试）

def compile_choices(astr):
   if astr in ['default', 'clang3.4', 'clang3.5']:
       return astr
   else:
       return 'default'
   # could raise ValueError('bad value') if there are some strings you don't like

argp.add_argument('--compiler', type=compile_choices)

==================

如果compile_choices 采用其他参数，例如选项列表或默认值，您需要在解析之前包含一些定义这些值的原因。

接受二进制字符串表示的示例：

parser.add_argument('--binary', type=lambda x: int(x, base=2),
    help='integer in binary format', default='1010')

或

parser.add_argument('--binary', type=functools.partial(int, base=2), default='1010')