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

发布时间 2023-10-29 21:28:38作者: 小满独家

内容来自 DOC https://q.houxu6.top/?s=在Python中手动引发(抛出)异常

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

在Python中,可以使用raise语句来引发异常。要通过except块捕获异常,需要使用适当的异常类型并提供一个错误消息。以下是一个示例:

try:
    # 这里是可能引发异常的代码
    raise ValueError("这是一个自定义错误消息")
except ValueError as e:
    # 这里是处理异常的代码
    print("捕获到异常:", e)

在上面的示例中,我们使用raise语句引发了一个ValueError异常,并提供了一个自定义错误消息。然后,我们使用except块来捕获该异常,并将异常对象存储在变量e中。最后,我们可以打印出异常信息。

请注意,可以根据需要引发不同类型的异常,例如TypeErrorZeroDivisionError等。每个异常类型都有不同的错误消息和用途。


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


使用与问题语义最匹配的异常构造函数。

在消息中要具体,例如:

raise ValueError('一个非常具体的错误发生了')

不要引发通用的Exception。要捕获它,你必须捕获所有其他更具体的异常,这些异常会继承它。

问题1:隐藏错误

raise Exception('我知道Python!')  # 不要这样做!如果你捕获了,可能会隐藏错误。

例如:

def demo_bad_catch():
    try:
        raise ValueError('代表一个隐藏的错误,不要捕获这个')
        raise Exception('这是你期望处理的异常')
    except Exception as error:
        print('捕获到这个错误:' + repr(error))

>>> demo_bad_catch()
捕获到这个错误:ValueError('代表一个隐藏的错误,不要捕获这个',)

问题2:无法捕获

更具体的捕获不会捕获通用的异常:

def demo_no_catch():
    try:
        raise Exception('一般的异常不会被特定的处理捕获')
    except ValueError as e:
        print('我们将不会捕获这个异常:Exception')

>>> demo_no_catch()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in demo_no_catch
Exception: 一般的异常不会被特定的处理捕获

最佳实践:raise语句

相反,使用与问题语义最匹配的异常构造函数

raise ValueError('一个非常具体的错误发生了')

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

raise ValueError('一个非常具体的错误发生了', '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中,BaseException实际上添加了一个message属性,以鼓励用户继承Exceptions并停止使用args,但引入message和原始弃用args的提议已经被撤回

最佳实践:except子句

当你在except子句中时,你可能想要,例如,记录特定类型的错误发生了,然后重新引发。保留堆栈跟踪的最佳方法是使用一个裸露的raise语句。例如:

logger = logging.getLogger(__name__)

try:
    do_something_in_app_that_breaks_easily()
except AppError as error:
    logger.error(error)
    raise                 # 只有这个!
    # raise AppError # 不要这样做,你会丢失堆栈跟踪!

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

你可以使用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]  # 避免这个。
# 等效于,因为错误 \*是\* 第二个对象:
raise sys.exc_info()[0], sys.exc_info()[1], sys.exc_info()[2]

如果你想要,你可以修改raise时会发生什么 - 例如为实例设置新的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 RuntimeError('specific message') from error

请注意:

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

已弃用的方法:

这些方法很容易隐藏并甚至进入生产代码。你想要引发一个异常,这样做会引发一个异常,但并不是你想要的那个!

在Python 2中有效,但在Python 3中无效的是以下内容:

raise ValueError, 'message' # 不要这样做,它已经被弃用了!

只有在非常旧版本的Python(2.4及更低版本)中,你仍然可以看到人们引发字符串:

raise 'message' # 真的真的错了。不要这样做。

在所有现代版本中,这将实际上引发一个TypeError,因为你没有引发一个BaseException类型。如果你没有检查正确的异常并且没有审查者知道这个问题,它可能会进入生产。

示例用法:

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

def api_func(foo):
    '''foo应该是'baz'或'bar'。返回非常有用的东西。'''
    if foo not in _ALLOWED_ARGS:
        raise ValueError('{foo} wrong, use "baz" or "bar"'.format(foo=repr(foo)))

创建自己的错误类型当你需要的时候

如果你想要表示你的应用程序中有些东西是错误的,只需在异常层次结构中的适当点处子类化适当的错误即可:

class MyAppLookupError(LookupError):
    '''当资源字典中缺少我的应用程序的查找错误时引发此错误'''

使用:

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