《编写高质量Python代码的59个有效方法》——第14条:尽量用异常来表示特殊情况,而不要返回None-阿里云开发者社区

开发者社区> 华章出版社> 正文
登录阅读全文

《编写高质量Python代码的59个有效方法》——第14条:尽量用异常来表示特殊情况,而不要返回None

简介:

本节书摘来自华章社区《编写高质量Python代码的59个有效方法》一书中的第14条:尽量用异常来表示特殊情况,而不要返回None,作者[美]布雷特·斯拉特金(Brett Slatkin),更多章节内容可以访问云栖社区“华章社区”公众号查看

第14条:尽量用异常来表示特殊情况,而不要返回None
编写工具函数(utility function)时,Python程序员喜欢给None这个返回值赋予特殊意义。这么做有时是合理的。例如,要编写辅助函数,计算两数相除的商。在除数为0的情况下,计算结果是没有明确含义的(undef?ined,未定义的),所以似乎应该返回None。

此函数的调用者,可以对这种特殊的返回值做相应的解读。

分子若是0,会怎么样呢?在那种情况下,如果分母非零,那么计算结果就是0。当在if等条件语句中拿这个计算结果做判断时,会出现问题。我们可能不会专门去判断函数的返回值是否为None,而是会假定:只要返回了与False等效的运算结果,就说明函数出错了(类似的用法,请参见本书第4条)。

如果None这个返回值,对函数有特殊意义,那么在编写Python代码来调用该函数时,就很容易犯上面这种错误。由此可见,令函数返回None,可能会使调用它的人写出错误的代码。有两种办法可以减少这种错误。
第一种办法,是把返回值拆成两部分,并放到二元组(two-tuple)里面。二元组的首个元素,表示操作是否成功,接下来的那个元素,才是真正的运算结果。

调用该函数的人需要解析这个元组。这就迫使他们必须根据元组中表示运算状态的那个元素来做判断,而不能像从前那样,直接根据相除的结果做判断。

问题在于,调用者可以通过以下划线为名称的变量,轻易跳过元组的第一部分(Python程序员习惯用这种写法来表示用不到的变量)。这样写出来的代码,看上去似乎没错,但实际上,却和直接返回None的那种情况有着相同的错误。

第二种办法更好一些,那就是根本不返回None,而是把异常抛给上一级,使得调用者必须应对它。本例中,把ZeroDivisionError转化成ValueError,用以表示调用者所给的输入值是无效的:

现在,调用者就需要处理因输入值无效而引发的异常了(这种抛出异常的行为,应该写入开发文档,参见本书第49条)。调用者无需用条件语句来判断函数的返回值,因为如果函数没有抛出异常,返回值自然就是正确的。这样写出来的异常处理代码,也比较清晰。

要点
用None这个返回值来表示特殊意义的函数,很容易使调用者犯错,因为None和0及空字符串之类的值,在条件表达式里都会评估为False。
函数在遇到特殊情况时,应该抛出异常,而不要返回None。调用者看到该函数的文档中所描述的异常之后,应该就会编写相应的代码来处理它们了。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:

华章出版社

官方博客
最新文章
相关文章
官网链接