在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中,以支持鼓励用户子类化异常并停止使用args ,但是message的引入和args的原始弃用已被撤消。

最佳做法: except条款

例如,在except子句中,您可能想要记录发生特定类型的错误,然后重新提升。 在保留堆栈跟踪的同时做到这一点的最好方法是使用裸加语句。 例如:

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和Python 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]

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

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

再次:避免手动操作回溯。 效率更低,更容易出错。 如果你使用线程和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.
    

    在所有的现代版本中,这实际上会引发一个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)))
    

    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)
    
    链接地址: http://www.djcxy.com/p/4393.html

    上一篇: Manually raising (throwing) an exception in Python

    下一篇: How to properly ignore Exceptions?