在Python中手动提高(抛出)exception

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

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

使用语义上适合您的问题的最具体的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') 

也可以轻松地将任意数量的parameter passing给构造函数:

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

最佳做法: except条款

在except子句中,例如,可能需要logging特定types的错误发生,然后重新提升。 在保留堆栈跟踪的同时,最好的办法就是使用裸语句。 例如:

 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()返回types,值和回溯。

 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你甚至可能会得到错误的回溯(特别是如果你使用控制stream的exception处理 – 我个人倾向于避免这种情况)。

Python 3,exception链接

在Python 3中,您可以链接exception,从而保留回溯:

  raise RuntimeError('specific message') from error 

意识到:

  • 确实允许改变提出的错误types,
  • 这与Python 2 兼容。

弃用的方法:

这些可以很容易地隐藏甚至进入生产代码。 你想提出一个例外,做他们会引发一个例外, 但不是一个意图!

在Python 2中有效,但在Python 3中不可用 :

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

只有在更老版本的Python (2.4及更低版本)中才有效 ,您仍然可以看到人们正在提升string:

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

在所有现代版本中,这实际上会引发一个TypeError,因为你没有引发一个BaseExceptiontypes。 如果您没有检查正确的例外,并且没有意识到问题的审阅者,则可能会投入生产。

用法示例

我提出exception来警告我的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时,创build自己的错误types

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

你可以创build你自己的错误types,如果你想指出你的应用程序有特定的错误,只需要在exception层次结构中对适当的点进行子类化:

 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语句文档 。

对于常见的情况,你需要抛出一个exception,以应对一些意外的情况,而你从来没有打算捕捉到,而只是为了快速失败,让你从那里debugging,如果它发生 – 最合乎逻辑的似乎是AssertionError

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

在Python3中有四种不同的语法来处理exception:

 1. raise exception 2. raise exception (args) 3. raise 4. raise exception (args) from original_exception 

1.引发exception与2.引发exception(args)

如果使用raise exception (args)引发exception,则在打印exception对象时将显示args – 如下例所示。

  #raise exception (args) try: raise ValueError("I have raised an Exception") except ValueError as exp: print ("Error", exp) # Output -> Error I have raised an Exception #raise execption try: raise ValueError except ValueError as exp: print ("Error", exp) # Output -> Error 

3.raise

raise没有任何论据的情况下raise陈述会重新提出最后的例外。 如果您需要在捕获exception之后执行一些操作,然后重新提升它,这非常有用。 但是如果之前没有exception,则会引发TypeErrorexception。

 def somefunction(): print("some cleaning") a=10 b=0 result=None try: result=a/b print(result) except Exception: #Output -> somefunction() #some cleaning raise #Traceback (most recent call last): #File "python", line 8, in <module> #ZeroDivisionError: division by zero 

4.从original_exception中引发exception(args)

这个语句用于创buildexception链接,其中响应另一个exception而引发的exception可以包含原始exception的详细信息,如下例所示。

 class MyCustomException(Exception): pass a=10 b=0 reuslt=None try: try: result=a/b except ZeroDivisionError as exp: print("ZeroDivisionError -- ",exp) raise MyCustomException("Zero Division ") from exp except MyCustomException as exp: print("MyException",exp) print(exp.__cause__) 

输出:

 ZeroDivisionError -- division by zero MyException Zero Division division by zero 

先阅读现有的答案,这只是一个附录。

请注意,您可以使用或不使用参数来引发exception。

例:

 raise SystemExit 

退出程序,但你可能想知道发生了什么,所以你可以使用这个。

 raise SystemExit("program exited") 

这将在closures程序之前打印“程序退出”。