如何在Python中引发异常,并通过except块将其捕获?
如何在Python中手动引发/引发异常?
使用在语义上适合您的问题的最特定的Exception构造函数。
在您的消息中要具体,例如:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">raise</span> ValueError(<span style="color:var(--highlight-variable)">'A very specific bad thing happened.'</span>)
</code></span>
不要引发通用异常
避免提出泛型Exception
。要捕获它,您必须捕获将其子类化的所有其他更具体的异常。
问题1:隐藏错误
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">raise</span> Exception(<span style="color:var(--highlight-variable)">'I know Python!'</span>) <span style="color:var(--highlight-comment)"># Don't! If you catch, likely to hide bugs.</span>
</code></span>
例如:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">def</span> <span style="color:var(--highlight-literal)">demo_bad_catch</span>():
<span style="color:var(--highlight-keyword)">try</span>:
<span style="color:var(--highlight-keyword)">raise</span> ValueError(<span style="color:var(--highlight-variable)">'Represents a hidden bug, do not catch this'</span>)
<span style="color:var(--highlight-keyword)">raise</span> Exception(<span style="color:var(--highlight-variable)">'This is the exception you expect to handle'</span>)
<span style="color:var(--highlight-keyword)">except</span> Exception <span style="color:var(--highlight-keyword)">as</span> error:
print(<span style="color:var(--highlight-variable)">'Caught this error: '</span> + <span style="color:var(--highlight-literal)">repr</span>(error))
<span style="color:var(--highlight-keyword)">>>> </span>demo_bad_catch()
Caught this error: ValueError(<span style="color:var(--highlight-variable)">'Represents a hidden bug, do not catch this'</span>,)
</code></span>
问题2:无法捕获
而且更具体的捕获不会捕获一般异常:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">def</span> <span style="color:var(--highlight-literal)">demo_no_catch</span>():
<span style="color:var(--highlight-keyword)">try</span>:
<span style="color:var(--highlight-keyword)">raise</span> Exception(<span style="color:var(--highlight-variable)">'general exceptions not caught by specific handling'</span>)
<span style="color:var(--highlight-keyword)">except</span> ValueError <span style="color:var(--highlight-keyword)">as</span> e:
print(<span style="color:var(--highlight-variable)">'we will not catch exception: Exception'</span>)
<span style="color:var(--highlight-keyword)">>>> </span>demo_no_catch()
Traceback (most recent call last):
File <span style="color:var(--highlight-variable)">"<stdin>"</span>, line <span style="color:var(--highlight-namespace)">1</span>, <span style="color:var(--highlight-keyword)">in</span> <module>
File <span style="color:var(--highlight-variable)">"<stdin>"</span>, line <span style="color:var(--highlight-namespace)">3</span>, <span style="color:var(--highlight-keyword)">in</span> demo_no_catch
Exception: general exceptions <span style="color:var(--highlight-keyword)">not</span> caught by specific handling
</code></span>
最佳做法:raise
声明
而是使用在语义上适合您的issue的最特定的Exception构造函数。
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">raise</span> ValueError(<span style="color:var(--highlight-variable)">'A very specific bad thing happened'</span>)
</code></span>
这也方便地允许将任意数量的参数传递给构造函数:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">raise</span> ValueError(<span style="color:var(--highlight-variable)">'A very specific bad thing happened'</span>, <span style="color:var(--highlight-variable)">'foo'</span>, <span style="color:var(--highlight-variable)">'bar'</span>, <span style="color:var(--highlight-variable)">'baz'</span>)
</code></span>
这些参数由对象args
上的属性访问Exception
。例如:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">try</span>:
some_code_that_may_raise_our_value_error()
<span style="color:var(--highlight-keyword)">except</span> ValueError <span style="color:var(--highlight-keyword)">as</span> err:
print(err.args)
</code></span>
代码:
<span style="color:var(--highlight-color)"><code>(<span style="color:var(--highlight-variable)">'message'</span>, <span style="color:var(--highlight-variable)">'foo'</span>, <span style="color:var(--highlight-variable)">'bar'</span>, <span style="color:var(--highlight-variable)">'baz'</span>)
</code></span>
在Python 2.5中,message
添加了一个实际属性,以BaseException
鼓励用户继承Exceptions的子类并停止使用args
,但args的引入message
和最初的弃用已被收回。
最佳做法:except条件
例如,在except子句中时,您可能想要记录发生了特定类型的错误,然后重新引发。保留堆栈跟踪的同时执行此操作的最佳方法是使用原始命令语句。例如:
<span style="color:var(--highlight-color)"><code>logger = logging.getLogger(__name__)
<span style="color:var(--highlight-keyword)">try</span>:
do_something_in_app_that_breaks_easily()
<span style="color:var(--highlight-keyword)">except</span> AppError <span style="color:var(--highlight-keyword)">as</span> error:
logger.error(error)
<span style="color:var(--highlight-keyword)">raise</span> <span style="color:var(--highlight-comment)"># just this!</span>
<span style="color:var(--highlight-comment)"># raise AppError # Don't do this, you'll lose the stack trace!</span>
</code></span>
不要修改您的错误...但是如果您坚持的话。
您可以使用保留stacktrace(和错误值)sys.exc_info()
,但是这样更容易出错,并且在Python 2和3之间存在兼容性问题,建议使用原始命令raise
重新引发。
解释-sys.exc_info()
返回类型,值和回溯。
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-literal)">type</span>, value, traceback = sys.exc_info()
</code></span>
这是Python 2中的语法,与Python 3不兼容:
<span style="color:var(--highlight-color)"><code> <span style="color:var(--highlight-keyword)">raise</span> AppError, error, sys.exc_info()[<span style="color:var(--highlight-namespace)">2</span>] <span style="color:var(--highlight-comment)"># avoid this.</span>
<span style="color:var(--highlight-comment)"># Equivalently, as error *is* the second object:</span>
<span style="color:var(--highlight-keyword)">raise</span> sys.exc_info()[<span style="color:var(--highlight-namespace)">0</span>], sys.exc_info()[<span style="color:var(--highlight-namespace)">1</span>], sys.exc_info()[<span style="color:var(--highlight-namespace)">2</span>]
</code></span>
如果愿意,您可以修改新加薪时发生的情况-例如args
,为实例设置新值:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">def</span> <span style="color:var(--highlight-literal)">error</span>():
<span style="color:var(--highlight-keyword)">raise</span> ValueError(<span style="color:var(--highlight-variable)">'oops!'</span>)
<span style="color:var(--highlight-keyword)">def</span> <span style="color:var(--highlight-literal)">catch_error_modify_message</span>():
<span style="color:var(--highlight-keyword)">try</span>:
error()
<span style="color:var(--highlight-keyword)">except</span> ValueError:
error_type, error_instance, traceback = sys.exc_info()
error_instance.args = (error_instance.args[<span style="color:var(--highlight-namespace)">0</span>] + <span style="color:var(--highlight-variable)">' <modification>'</span>,)
<span style="color:var(--highlight-keyword)">raise</span> error_type, error_instance, traceback
</code></span>
并且我们在修改args时保留了整个回溯。请注意,这不是最佳做法,并且在Python 3中是无效的语法(使保持兼容性变得更加困难)。
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">>>> </span>catch_error_modify_message()
Traceback (most recent call last):
File <span style="color:var(--highlight-variable)">"<stdin>"</span>, line <span style="color:var(--highlight-namespace)">1</span>, <span style="color:var(--highlight-keyword)">in</span> <module>
File <span style="color:var(--highlight-variable)">"<stdin>"</span>, line <span style="color:var(--highlight-namespace)">3</span>, <span style="color:var(--highlight-keyword)">in</span> catch_error_modify_message
File <span style="color:var(--highlight-variable)">"<stdin>"</span>, line <span style="color:var(--highlight-namespace)">2</span>, <span style="color:var(--highlight-keyword)">in</span> error
ValueError: oops! <modification>
</code></span>
<span style="color:var(--highlight-color)"><code> <span style="color:var(--highlight-keyword)">raise</span> error.with_traceback(sys.exc_info()[<span style="color:var(--highlight-namespace)">2</span>])
</code></span>
再次:避免手动操作回溯。它效率较低,更容易出错。而且,如果您正在使用线程,sys.exc_info
甚至可能会得到错误的回溯(特别是如果您对控制流使用异常处理,我个人倾向于避免这种情况。)
Python 3,异常链接
在Python 3中,您可以链接异常,以保留回溯:
<span style="color:var(--highlight-color)"><code> <span style="color:var(--highlight-keyword)">raise</span> RuntimeError(<span style="color:var(--highlight-variable)">'specific message'</span>) <span style="color:var(--highlight-keyword)">from</span> error
</code></span>
意识到:
- 这确实允许更改引发的错误类型,并且
- 这与Python 2不兼容。
不推荐使用的方法:
这些可以很容易地隐藏甚至进入生产代码。您想提出一个例外,而这样做会引发一个例外,但不是一个预期的例外!
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">raise</span> ValueError, <span style="color:var(--highlight-variable)">'message'</span> <span style="color:var(--highlight-comment)"># Don't do this, it's deprecated!</span>
</code></span>
仅在更旧的Python版本(2.4及更低版本)中有效,您仍然可以看到有人在引发字符串:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">raise</span> <span style="color:var(--highlight-variable)">'message'</span> <span style="color:var(--highlight-comment)"># really really wrong. don't do this.</span>
</code></span>
在所有现代版本中,这实际上会引发一个TypeError
,因为您没有引发一个BaseException
类型。如果您没有检查正确的例外情况,并且没有知道该问题的审阅者,那么它可能会投入生产。
用法示例
我提出异常,以警告使用者如果我的API使用不正确:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">def</span> <span style="color:var(--highlight-literal)">api_func</span>(foo):
<span style="color:var(--highlight-variable)">'''foo should be either 'baz' or 'bar'. returns something very useful.'''</span>
<span style="color:var(--highlight-keyword)">if</span> foo <span style="color:var(--highlight-keyword)">not</span> <span style="color:var(--highlight-keyword)">in</span> _ALLOWED_ARGS:
<span style="color:var(--highlight-keyword)">raise</span> ValueError(<span style="color:var(--highlight-variable)">'{foo} wrong, use "baz" or "bar"'</span>.<span style="color:var(--highlight-literal)">format</span>(foo=<span style="color:var(--highlight-literal)">repr</span>(foo)))
</code></span>
适当时创建自己的错误类型
“我要故意犯一个错误,以便将其排除在外”
您可以创建自己的错误类型,如果要指示应用程序存在某些特定的错误,只需在异常层次结构中将适当的点子类化:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">class</span> <span style="color:var(--highlight-literal)">MyAppLookupError</span>(LookupError):
<span style="color:var(--highlight-variable)">'''raise this when there's a lookup error for my app'''</span>
</code></span>
用法:
<span style="color:var(--highlight-color)"><code><span style="color:var(--highlight-keyword)">if</span> important_key <span style="color:var(--highlight-keyword)">not</span> <span style="color:var(--highlight-keyword)">in</span> resource_dict <span style="color:var(--highlight-keyword)">and</span> <span style="color:var(--highlight-keyword)">not</span> ok_to_be_missing:
<span style="color:var(--highlight-keyword)">raise</span> MyAppLookupError(<span style="color:var(--highlight-variable)">'resource is missing, and that is not ok.'</span>)</code></span>