一尘不染

在 Python 中手动引发(抛出)异常

javascript

如何在 Python 中引发异常,以便以后可以通过except块捕获它?


阅读 273

收藏
2022-01-26

共1个答案

一尘不染

如何在 Python 中手动抛出/引发异常?

使用语义上适合您问题的最具体的 Exception 构造函数

在您的信息中具体说明,例如:

raise ValueError('A very specific bad thing happened.')

不要引发一般异常

避免提出泛型Exception. 要捕获它,您必须捕获所有其他将其子类化的更具体的异常。

问题 1:隐藏错误

raise Exception('I know Python!') # Don't! If you catch, likely to hide bugs.

例如:

def demo_bad_catch():
    try:
        raise ValueError('Represents a hidden bug, do not catch this')
        raise Exception('This is the exception you expect to handle')
    except Exception as error:
        print('Caught this error: ' + repr(error))

>>> demo_bad_catch()
Caught this error: ValueError('Represents a hidden bug, do not catch this',)

问题2:抓不到

更具体的捕获不会捕获一般异常:

def demo_no_catch():
    try:
        raise Exception('general exceptions not caught by specific handling')
    except ValueError as e:
        print('we will not catch exception: Exception')


>>> demo_no_catch()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in demo_no_catch
Exception: general exceptions not caught by specific handling

最佳实践:raise声明

相反,请使用语义上适合您问题的最具体的 Exception 构造函数

raise ValueError('A very specific bad thing happened')

这也方便地允许将任意数量的参数传递给构造函数:

raise ValueError('A very specific bad thing happened', 'foo', 'bar', 'baz') 

这些参数由对象的args属性访问Exception。例如:

try:
    some_code_that_may_raise_our_value_error()
except ValueError as err:
    print(err.args)

印刷

('message', 'foo', 'bar', 'baz')    

在 Python 2.5 中,添加了一个实际message属性,以BaseException鼓励用户将 Exceptions 子类化并停止使用args,但args的引入message和最初的弃用已被撤回

最佳实践:except条款

例如,当在 except 子句中时,您可能希望记录发生了特定类型的错误,然后重新引发。在保留堆栈跟踪的同时执行此操作的最佳方法是使用裸 raise 语句。例如:

logger = logging.getLogger(__name__)

try:
    do_something_in_app_that_breaks_easily()
except AppError as error:
    logger.error(error)
    raise                 # just this!
    # raise AppError      # Don't do this, you'll lose the stack trace!

不要修改你的错误......但如果你坚持。

您可以使用 保留堆栈跟踪(和错误值)sys.exc_info(),但这更容易出错并且在 Python 2 和 3 之间存在兼容性问题,更喜欢使用裸raise重新引发。

解释一下 -sys.exc_info()返回类型、值和回溯。

type, value, traceback = sys.exc_info()

这是 Python 2 中的语法 - 请注意,这与 Python 3 不兼容:

raise AppError, error, sys.exc_info()[2] # avoid this.
# Equivalently, as error *is* the second object:
raise sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2]

如果你愿意,你可以修改你的新加薪会发生什么 - 例如args为实例设置新的:

def error():
    raise ValueError('oops!')

def catch_error_modify_message():
    try:
        error()
    except ValueError:
        error_type, error_instance, traceback = sys.exc_info()
        error_instance.args = (error_instance.args[0] + ' <modification>',)
        raise error_type, error_instance, traceback

我们在修改 args 时保留了整个回溯。请注意,这不是最佳实践,并且在 Python 3 中是无效的语法(使得保持兼容性变得更加困难)。

>>> catch_error_modify_message()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in catch_error_modify_message
  File "<stdin>", line 2, in error
ValueError: oops! <modification>

Python 3中:

raise error.with_traceback(sys.exc_info()[2])

再次:避免手动操作回溯。它的效率较低且更容易出错。如果你使用线程,sys.exc_info你甚至可能得到错误的回溯(特别是如果你对控制流使用异常处理——我个人倾向于避免这种情况。)

Python 3,异常链接

在 Python 3 中,您可以链接异常,以保留回溯:

raise RuntimeError('specific message') from error

意识到:

  • 确实允许更改引发的错误类型,并且
  • 这与 Python 2兼容。

不推荐使用的方法:

这些可以很容易地隐藏甚至进入生产代码。您想引发异常,并且这样做会引发异常,但不是预期的!

在 Python 2 中有效,但在 Python 3中无效的如下:

raise ValueError, 'message' # Don't do this, it's deprecated!

在更旧版本的 Python(2.4 及更低版本)中有效,您可能仍会看到人们提出字符串:

raise 'message' # really really wrong. don't do this.

在所有现代版本中,这实际上会引发 a TypeError,因为您没有引发BaseException类型。如果您没有检查正确的异常并且没有意识到该问题的审阅者,它可能会投入生产。

示例用法

如果他们使用不正确,我会引发异常来警告消费者我的 API:

def api_func(foo):
    '''foo should be either 'baz' or 'bar'. returns something very useful.'''
    if foo not in _ALLOWED_ARGS:
        raise ValueError('{foo} wrong, use "baz" or "bar"'.format(foo=repr(foo)))

适当时创建自己的错误类型

“我想故意犯错误,这样它就会进入例外”

您可以创建自己的错误类型,如果您想指出您的应用程序有特定的错误,只需子类化异常层次结构中的适当点:

class MyAppLookupError(LookupError):
    '''raise this when there's a lookup error for my app'''

和用法:

if important_key not in resource_dict and not ok_to_be_missing:
    raise MyAppLookupError('resource is missing, and that is not ok.')
2022-01-26