How do I manually throw/raise an exception in Python?
Use the most specific Exception constructor that semantically fits your issue .
在您的信息中具体说明,例如:
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
语句
Instead, use the most specific Exception constructor that semantically fits your issue .
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
以鼓励用户将异常子类化并停止使用 args
,但是the introduction of message
and the original deprecation of args has been retracted .
最佳实践: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
我们在修改参数时保留了整个回溯。请注意,这不是最佳实践,而且它在 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])
再次:避免手动操作回溯。它是 less efficient并且更容易出错。如果你使用线程和 sys.exc_info
你甚至可能得到错误的回溯(特别是如果你使用异常处理控制流——我个人倾向于避免。)
Python 3,异常链接
在 Python 3 中,您可以链接异常,从而保留回溯:
raise RuntimeError('specific message') from error
注意:
- 这确实允许更改引发的错误类型,并且
- 这不与 Python 2 兼容。
不推荐使用的方法:
这些可以很容易地隐藏甚至进入生产代码。您想引发异常,但这样做会引发异常,但不是预期的!
Valid in Python 2, but not in Python 3如下:
raise ValueError, 'message' # Don't do this, it's deprecated!
仅限 valid in much older versions of Python (2.4 及更低版本),您可能仍会看到有人在提高字符串:
raise 'message' # really really wrong. don't do this.
在所有现代版本中,这实际上会引发 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)))
适时创建自己的错误类型
"I want to make an error on purpose, so that it would go into the except"
您可以创建自己的错误类型,如果您想指出您的应用程序存在特定问题,只需将异常层次结构中的相应点子类化即可:
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.')
我是一名优秀的程序员,十分优秀!