协慌网

登录 贡献 社区

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

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

答案

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

使用最具特异性的 Exception 构造函数,该构造函数在语义上适合您的问题

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

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

不要引发一般异常

避免引发通用异常。为了捕获它,您将必须捕获所有其他更具体的异常子类。

问题 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')

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

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 ,但是message的引入和 args 的原始弃用已被撤消

最佳实践: except条款

例如,在 except 子句中,您可能希望记录发生特定类型的错误,然后重新引发。在保留堆栈跟踪的同时执行此操作的最佳方法是使用 bare 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 中,您可以链接 Exceptions,它可以保留回溯:

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.

在所有现代版本中,这实际上会引发 TypeError,因为您没有引发 BaseException 类型。如果您没有检查正确的例外情况,并且没有知道该问题的审阅者,则可能会投入生产。

示例用法

如果他们错误地使用了我的 API,我会引发 Exceptions 警告消费者:

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)))

在 apropos 时创建自己的错误类型

“我想故意犯错误,以便它会进入除外”

您可以创建自己的错误类型,如果要指示应用程序的特定错误,只需将异常层次结构中的相应点子类化:

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.')

不要这样做 。提出一个裸露的Exception绝对不是正确的做法; 相反,请参阅Aaron Hall 的优秀答案

不能得到比这更多的 pythonic:

raise Exception("I know python!")

如果您想了解更多信息,请参阅 python 的 raise 语句文档

对于常见的情况,您需要抛出异常以响应某些意外情况,并且您永远不打算捕获,而只是快速失败以使您能够从那里进行调试(如果它发生的话) - 最合乎逻辑的似乎是AssertionError

if 0 < distance <= RADIUS:
    #Do something.
elif RADIUS < distance:
    #Do something.
else:
    raise AssertionError("Unexpected value of 'distance'!", distance)