mongotemplate中save抛出异常_异常处理的三个好习惯 | Python 工匠

487313986533bdae21a11a67c6ed24e9.png

  文 | piglei  编辑 | EarlGrey

推荐 | 编程派(微信ID:codingpy)

前言

如果你用 Python 编程,那么你就无法避开异常,因为异常在这门语言里无处不在。打个比方,当你在脚本执行时按 ctrl+c 退出,解释器就会产生一个 KeyboardInterrupt 异常。而 KeyErrorValueErrorTypeError 等更是日常编程里随处可见的老朋友。

异常处理工作由“捕获”和“抛出”两部分组成。“捕获”指的是使用 try...except 包裹特定语句,妥当的完成错误流程处理。而恰当的使用 raise 主动“抛出”异常,更是优雅代码里必不可少的组成部分。

在这篇文章里,我会分享与异常处理相关的 3 个好习惯。继续阅读前,我希望你已经了解了下面这些知识点:

  • 异常的基本语法与用法(建议阅读官方文档 “Errors and Exceptions”)

  • 为什么要使用异常代替错误返回(建议阅读《让函数返回结果的技巧》)

  • 为什么在写 Python 时鼓励使用异常 (建议阅读 “Write Cleaner Python: Use Exceptions”)

40269888a82ba1adb9b5baab0d34a34c.png

三个好习惯

1. 只做最精确的异常捕获

假如你不够了解异常机制,就难免会对它有一种天然恐惧感。你可能会觉得:异常是一种不好的东西,好的程序就应该捕获所有的异常,让一切都平平稳稳的运行。而抱着这种想法写出的代码,里面通常会出现大段含糊的异常捕获逻辑。

让我们用一段可执行脚本作为样例:

# -*- coding: utf-8 -*-

import requests

import re

def save_website_title(url, filename):

"""获取某个地址的网页标题,然后将其写入到文件中

:returns: 如果成功保存,返回 True,否则打印错误,返回 False

"""

try:

resp = requests.get(url)

obj = re.search(r'(.*)', resp.text)

if not obj:

print('save failed: title tag not found in page content')

return False

title = obj.grop(1)

with open(filename, 'w') as fp:

fp.write(title)

return True

except Exception:

print(f'save failed: unable to save title of {url} to {filename}')

return False

def main():

save_website_title('https://www.qq.com', 'qq_title.txt')

if __name__ == '__main__':

main()

脚本里的 save_website_title 函数做了好几件事情。它首先通过网络获取网页内容,然后利用正则匹配出标题,最后将标题写在本地文件里。而这里有两个步骤很容易出错:网络请求本地文件操作。所以在代码里,我们用一个大大的 try...except 语句块,将这几个步骤都包裹了起来。安全第一 ⛑。

那么,这段看上去简洁易懂的代码,里面藏着什么问题呢?

如果你旁边刚好有一台安装了 Python 的电脑,那么你可以试着跑一遍上面的脚本。你会发现,上面的代码是不能成功执行的。而且你还会发现,无论你如何修改网址和目标文件的值,程序仍然会报错 “save failed: unable to...”。为什么呢?

问题就藏在这个硕大无比的 try...except 语句块里。假如你把眼睛贴近屏幕,非常仔细的检查这段代码。你会发现在编写函数时,我犯了一个小错误,我把获取正则匹配串的方法错打成了 obj.grop(1),少了一个 'u'( obj.group(1))。

但正是因为那个过于庞大、含糊的异常捕获,这个由打错方法名导致的原本该被抛出的 AttibuteError 却被吞噬了。从而给我们的 debug 过程增加了不必要的麻烦。

异常捕获的目的,不是去捕获尽可能多的异常。假如我们从一开始就坚持:只做最精准的异常捕获。那么这样的问题就根本不会发生,精准捕获包括:

  • 永远只捕获那些可能会抛出异常的语句块

  • 尽量只捕获精确的异常类型,而不是模糊的 Exception

依照这个原则,我们的样例应该被改成这样:

from requests.exceptions import RequestException

def save_website_title(url, filename):

try:

resp = requests.get(url)

except RequestException as e:

print(f'save failed: unable to get page content: {e}')

return False

# 这段正则操作本身就是不应该抛出异常的,所以我们没必要使用 try 语句块

# 假如 group 被误打成了 grop 也没关系,程序马上就会通过 AttributeError 来

# 告诉我们。

obj = re.search(r'(.*)', resp.text)

if not obj:

print('save failed: title tag not found in page content')

return False

title = obj.group(1)

try:

with open(filename, 'w') as fp:

fp.write(title)

except IOError as e:

print(f'save failed: unable to write to file {filename}: {e}')

return False

else:

return True

2. 别让异常破坏抽象一致性

大约四五年前,当时的我正在开发某移动应用的后端 API 项目。如果你也有过开发后端 API 的经验,那么你一定知道,这样的系统都需要制定一套“API 错误码规范”,来为客户端处理调用错误时提供方便。

一个错误码返回大概长这个样子:

// HTTP Status Code: 400

// Content-Type: application/json

{

"code": "UNABLE_TO_UPVOTE_YOUR_OWN_REPLY",

"detail": "你不能推荐自己的回复"

}

在制定好错误码规范后,接下来的任务就是如何实现它。当时的项目使用了 Django 框架,而 Django 的错误页面正是使用了异常机制实现的。打个比方,如果你想让一个请求返回 404 状态码,那么只要在该请求处理过程中执行 raiseHttp404 即可。

所以,我们很自然的从 Django 获得了灵感。首先,我们在项目内定义了错误码异常类: APIErrorCode。然后依据“错误码规范”,写了很多继承该类的错误码。当需要返回错误信息给用户时,只需要做一次 raise 就能搞定。

raise error_codes.UNABLE_TO_UPVOTE

raise error_codes.USER_HAS_BEEN_BANNED

... ...

毫无意外,所有人都很喜欢用这种方式来返回错误码。因为它用起来非常方便,无论调用栈多深,只要你想给用户返回错误码,调用 raiseerror_codes.ANY_THING 就好。

随着时间推移,项目也变得越来越庞大,抛出 APIErrorCode 的地方也越来越多。有一天,我正准备复用一个底层图片处理函数时,突然碰到了一个问题。

我看到了一段让我非常纠结的代码:

# 在某个处理图像的模块内部

# /util/image/processor.py

def process_image(...):

try:

image = Image.open(fp)

except Exception:

# 说明(非项目原注释):该异常将会被 Django 的中间件捕获,往前端返回

# "上传的图片格式有误" 信息

raise error_codes.INVALID_IMAGE_UPLOADED

... ...

process_image 函数会尝试解析一个文件对象,如果该对象不能被作为图片正常打开,就抛出 error_codes.INVALID_IMAGE_UPLOADED(APIErrorCode子类) 异常,从而给调用方返回错误代码 JSON。

让我给你从头理理这段代码。最初编写 process_image 时,我虽然把它放在了 util.image 模块里,但当时调这个函数的地方就只有 “处理用户上传图片的 POST 请求” 而已。为了偷懒,我让函数直接抛出 APIErrorCode 异常来完成了错误处理工作。

再来说当时的问题。那时我需要写一个在后台运行的批处理图片脚本,而它刚好可以复用 process_image 函数所实现的功能。但这时不对劲的事情出现了,如果我想复用该函数,那么:

  • 我必须去捕获一个名为 INVALID_IMAGE_UPLOADED 的异常

    • 哪怕我的图片根本就不是来自于用户上传

  • 我必须引入 APIErrorCode 异常类作为依赖来捕获异常

    • 哪怕我的脚本和 Django API 根本没有任何关系

这就是异常类抽象层级不一致导致的结果。APIErrorCode 异常类的意义,在于表达一种能够直接被终端用户(人)识别并消费的“错误代码”。它在整个项目里,属于最高层的抽象之一。但是出于方便,我们却在底层模块里引入并抛出了它。这打破了 image.processor 模块的抽象一致性,影响了它的可复用性和可维护性。

这类情况属于“模块抛出了高于所属抽象层级的异常”。避免这类错误需要注意以下几点:

  • 让模块只抛出与当前抽象层级一致的异常

    • 比如 image.processer 模块应该抛出自己封装的 ImageOpenError 异常

  • 在必要的地方进行异常包装与转换

    • 比如,应该在贴近高层抽象(视图 View 函数)的地方,将图像处理模块的 ImageOpenError 低级异常包装转换为 APIErrorCode 高级异常

修改后的代码:

# /util/image/processor.py

class ImageOpenError(Exception):

pass

def process_image(...):

try:

image = Image.open(fp)

except Exception as e:

raise ImageOpenError(exc=e)

... ...

# /app/views.py

def foo_view_function(request):

try:

process_image(fp)

except ImageOpenError:

raise error_codes.INVALID_IMAGE_UPLOADED

除了应该避免抛出高于当前抽象级别的异常外,我们同样应该避免泄露低于当前抽象级别的异常。

如果你用过 requests 模块,你可能已经发现它请求页面出错时所抛出的异常,并不是它在底层所使用的 urllib3 模块的原始异常,而是通过 requests.exceptions 包装过一次的异常。

>>> try:

... requests.get('https://www.invalid-host-foo.com')

... except Exception as e:

... print(type(e))

...

<class 'requests.exceptions.ConnectionError'>

这样做同样是为了保证异常类的抽象一致性。因为 urllib3 模块是 requests 模块依赖的底层实现细节,而这个细节有可能在未来版本发生变动。所以必须对它抛出的异常进行恰当的包装,避免未来的底层变更对 requests 用户端错误处理逻辑产生影响。

3. 异常处理不应该喧宾夺主

在前面我们提到异常捕获要精准、抽象级别要一致。但在现实世界中,如果你严格遵循这些流程,那么很有可能会碰上另外一个问题:异常处理逻辑太多,以至于扰乱了代码核心逻辑。具体表现就是,代码里充斥着大量的 tryexceptraise 语句,让核心逻辑变得难以辨识。

让我们看一段例子:

def upload_avatar(request):

"""用户上传新头像"""

try:

avatar_file = request.FILES['avatar']

except KeyError:

raise error_codes.AVATAR_FILE_NOT_PROVIDED

try:

resized_avatar_file = resize_avatar(avatar_file)

except FileTooLargeError as e:

raise error_codes.AVATAR_FILE_TOO_LARGE

except ResizeAvatarError as e:

raise error_codes.AVATAR_FILE_INVALID

try:

request.user.avatar = resized_avatar_file

request.user.save()

except Exception:

raise error_codes.INTERNAL_SERVER_ERROR

return HttpResponse({})

这是一个处理用户上传头像的视图函数。这个函数内做了三件事情,并且针对每件事都做了异常捕获。如果做某件事时发生了异常,就返回对用户友好的错误到前端。

这样的处理流程纵然合理,但是显然代码里的异常处理逻辑有点“喧宾夺主”了。一眼看过去全是代码缩进,很难提炼出代码的核心逻辑。

早在 2.5 版本时,Python 语言就已经提供了对付这类场景的工具:“上下文管理器(context manager)”。上下文管理器是一种配合 with 语句使用的特殊 Python 对象,通过它,可以让异常处理工作变得更方便。

那么,如何利用上下文管理器来改善我们的异常处理流程呢?让我们直接看代码吧。

class raise_api_error:

"""captures specified exception and raise ApiErrorCode instead

:raises: AttributeError if code_name is not valid

"""

def __init__(self, captures, code_name):

self.captures = captures

self.code = getattr(error_codes, code_name)

def __enter__(self):

# 该方法将在进入上下文时调用

return self

def __exit__(self, exc_type, exc_val, exc_tb):

# 该方法将在退出上下文时调用

# exc_type, exc_val, exc_tb 分别表示该上下文内抛出的

# 异常类型、异常值、错误栈

if exc_type is None:

return False

if exc_type == self.captures:

raise self.code from exc_val

return False

在上面的代码里,我们定义了一个名为 raise_api_error 的上下文管理器,它在进入上下文时什么也不做。但是在退出上下文时,会判断当前上下文中是否抛出了类型为 self.captures 的异常,如果有,就用 APIErrorCode 异常类替代它。

使用该上下文管理器后,整个函数可以变得更清晰简洁:

def upload_avatar(request):

"""用户上传新头像"""

with raise_api_error(KeyError, 'AVATAR_FILE_NOT_PROVIDED'):

avatar_file = request.FILES['avatar']

with raise_api_error(ResizeAvatarError, 'AVATAR_FILE_INVALID'),\

raise_api_error(FileTooLargeError, 'AVATAR_FILE_TOO_LARGE'):

resized_avatar_file = resize_avatar(avatar_file)

with raise_api_error(Exception, 'INTERNAL_SERVER_ERROR'):

request.user.avatar = resized_avatar_file

request.user.save()

return HttpResponse({})

Hint:建议阅读 PEP 343 -- The "with" Statement | Python.org,了解与上下文管理器有关的更多知识。

模块 contextlib 也提供了非常多与编写上下文管理器相关的工具函数与样例。

总结

在这篇文章中,我分享了与异常处理相关的三个建议。最后再总结一下要点:

  • 只捕获可能会抛出异常的语句,避免含糊的捕获逻辑

  • 保持模块异常类的抽象一致性,必要时对底层异常类进行包装

  • 使用“上下文管理器”可以简化重复的异常处理逻辑

看完文章的你,有没有什么想吐槽的?请留言或者在 项目 Github Issues 告诉我吧。

-- 完 --

本文经作者授权发布,如需转载,请联系原作者。

回复下方「关键词」,获取优质资源

回复关键词「 pybook03」,立即获取主页君与小伙伴一起翻译的《Think Python 2e》电子版

回复关键词「pybooks02」,立即获取 O'Reilly 出版社推出的免费 Python 相关电子书合集

回复关键词「书单02」,立即获取主页君整理的 10 本 Python 入门书的电子版

4feff117a1f6b5db91355bbce5dcbd7f.png

印度小伙写了套深度学习教程,Github上星标已经5000+

GitHub热榜第四!这套Python机器学习课,免费获取还易吸收

《流畅的 Python》到底好在哪?

如何系统化学习 Python ?

GitHub标星2.6万!Python算法新手入门大全

使用 Vue.js 和 Flask 实现全栈单页面应用

Python 实现一个自动化翻译和替换的工具

使用 Python 制作属于自己的 PDF 电子书

12步轻松搞定Python装饰器

200 行代码实现 2048 游戏

题图:pexels,CC0 授权。

8b723bf3d25331cbdac2859297133352.png

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/534843.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

java 百度网盘上传_使用pcs api往免费的百度网盘上传下载文件的方法

百度个人云盘空间大&#xff0c;完全免费&#xff0c;而且提供了pcs api供调用操作文件&#xff0c;在平时的项目里往里面保存一些文件是很实用的。环境准备&#xff1a;开通读写网盘的权限及获取access_token:http://blog.csdn.net/langyuezhang/article/details/47206621百度…

python缩进教学_Python缩进和选择学习

缩进Python最具特色的是用缩进来标明成块的代码。我下面以if选择结构来举例。if后面跟随条件&#xff0c;如果条件成立&#xff0c;则执行归属于if的一个代码块。先看C语言的表达方式(注意&#xff0c;这是C&#xff0c;不是Python!)if ( i > 0 ){ x 1; y 2;}如果i …

php如何新建xml文件,PHP中的生成XML文件的4种方法分享

生成如下XML串Xml代码title1content12009-10-11title2content22009-11-11方法I.【直接生成字符串】使用纯粹的PHP代码生成字符串&#xff0c;并把这个字符串写入一个以XML为后缀的文件。这是最原始的生成XML的方法&#xff0c;不过有效&#xff01;$data_array array(array(ti…

组态王能直接读取仪表数据吗_液晶多功能网络电力仪表PD800H

液晶多功能网络电力仪表PD800H-H44三相三线多功用电力表面&#xff0c;一般也被称作网络电力表面&#xff0c;它是一种数字化的监控设备&#xff0c;其功用集成了电量测量&#xff0c;情况监控&#xff0c;远程通讯为一体&#xff0c;作业原理上选用了现代核算机技术和数字信号…

python程序显示自己的版权_手把手教你Pycharm皮肤主题及个性化设置,python程序员必备-Go语言中文社区...

1.设置IDE皮肤主题File -> Settings -> Appearance -> Theme -> 选择“Alloy.IDEA Theme”根据自己的喜好设置字体大小&#xff0c;以及样式。2.修改字体大小File -> Settings > Editor -> Colors & Fonts -> Font -> Size -> 设置为“14”3…

java多线程activemq,多线程JMS客户端ActiveMQ

我正在使用以下代码创建多个JMS会话&#xff0c;以供多个使用者使用消息。我的问题是代码以单线程方式运行。即使消息存在于队列中&#xff0c;第二个线程也无法接收任何内容&#xff0c;而是继续轮询。同时&#xff0c;第一个线程完成对第一批的处理&#xff0c;然后返回并使用…

python cnn 实例_基于CNN的纹理合成实践【附python实现】

Q0: Preliminary knowledge of Texture SynthesisBaseline请见此处&#xff0c;下文所有的代码修改均建立此代码基础之上。1. 纹理合成简述​纹理合成(Texture Systhesis)技术主要应用于计算机图形学等领域&#xff0c;被用于模拟几何模型的表面细节、增强绘制模型的真实感。不…

php使用jasperreport,php-报表引擎指南(Pentaho,JasperReports,BIRT)

我在各种论坛和他们的网站上花费了大约4-5个小时,研究可以帮助我发展的报告工具.我是使用这种工具的新手,可以使用一些特定的指导.我正在开发一个Web应用程序,该应用程序将托管在一台服务器上,但是多个用户可以通过登录进行访问.每个用户将拥有自己的帐户,并且只能访问仅与与其…

python中dlib库_python 基于dlib库的人脸检测的实现

本周暂时比较清闲&#xff0c;可以保持每日一更的速度。国外身份证项目新增需求&#xff0c;检测出身份证正面的人脸。最开始考虑mobilenet-ssd&#xff0c;经同事提醒&#xff0c;有现成的人脸库dlib&#xff0c;那就用传统方法尝试一下。dlib安装dlib的安装小费一波周折&…

php养老院管理系统,XYCMS养老院建站系统 v3.8

XYCMS养老院建站系统是一个专为养老院而设计的养老院建筑系统。中心信息管理&#xff1a;包括基本信息管理&#xff0c;添加&#xff0c;问答中心信息管理新闻动态管理&#xff1a;管理新闻信息内容&#xff0c;管理相关分类&#xff0c;添加或者删除生活环境内容管理&#xff…

php 修改文件访问时间,PHP中获取文件创建日期、修改日期、访问时间的方法

php获取文件创建时间、修改时间常用代码filemtime ( string filename )返回文件上次被修改的时间&#xff0c;出错时返回 FALSE。时间以 Unix 时间戳的方式返回&#xff0c;可用于 date()。例如&#xff1a;$afilemtime("log.txt");echo "修改时间&#xff1a;&…

超过响应缓冲区限制_Nginx如何限制并发连接数和连接请求数?

全网最全1500份Java学习资料、500份BAT面试真题&#xff1a;关注公众号&#xff0c;输入“面试题”&#xff0c;获取提取码&#xff01;首先讲解两个算发&#xff1a;算法思想是&#xff1a;令牌以固定速率产生&#xff0c;并缓存到令牌桶中&#xff1b;令牌桶放满时&#xff0…

Php公钥加密data是空,php 生成加密公钥加密私钥实例详解

php 生成加密公钥加密私钥实例详解生成公钥私钥 win下必须要openssl.cof支持 liunx一般已自带安装$config array(//"digest_alg" > "sha512","private_key_bits" > 512, //字节数 512 1024 2048 4096 等"private_key_type" >…

python句柄无效_subprocess.Popen 运行windows命令出现“句柄无效”报错的解决方法

【代码笔记】iOS-关于UIFont的一些define一,效果图. 二,工程图. 三,代码. RootViewController.h #import interface RootViewController ...JQuery Datatables Dom 和 Language 参数详细说明http://linleizi.iteye.com/blog/2086435 *********************************** Data …

java日期函数精确到日,java日期时间函数分享

前言&#xff1a;对于新手程序员的我来说&#xff0c;写业务代码是现在的日常&#xff0c;在此过程中经常需要对日期时间进行处理&#xff0c;我挑了几个较有用的日期处理函数分享给大家。正文&#xff1a;1、将某格式的时间字符串转化成毫秒时间戳表示的字符串&#xff1a;pub…

python变量区变量保存与加载_python – Flask:使用全局变量将数据文件加载到内存中...

我有一个大的XML文件,它被打开,加载到内存中,然后由Python类关闭.简化示例如下所示&#xff1a;class Dictionary():def __init__(self,filename):f open(filename)self.contents f.readlines()f.close()def getDefinitionForWord(self,word):# returns a word,using etree p…

php 顺丰接口实例,顺丰BSP接口PHP开发注意事项

1&#xff0c;xml报文不用附加"<?xml version"1.0" encoding"UTF-8" ?>"&#xff0c;不支持&#xff0c;会报格式错误。2&#xff0c;提交服务器时要重点注意。直接使用curl方式的&#xff0c;一定要把数据做http_build_query&#xff0…

跨域产生的原因和解决方法_板式家具开料机加工过程产生崩边原因及解决方法...

家具厂数控开料机加工材料的时候会遇到材料崩边的问题&#xff0c;下面我们系统的分析下产生的原因以及解决的办法产生崩边现象的原因&#xff1f;其一是材料本身问题。目前除了实木家具&#xff0c;目前使用较多的就是 板式贴皮的材料&#xff0c;板材的优点就是标准化生产&am…

facade 门面 php,php设计模式之门面(Facade)模式

该模式属于结构型模式什么是门面模式&#xff1f;定义&#xff1a;门面模式(有时候也称为外观模式)是指提供一个统一的接口去访问多个子系统的多个不同的接口&#xff0c;它为子系统中的一组接口提供一个统一的高层接口。外部与子系统的通信是通过一个门面(Facade)对象进行。其…

架构师一般做到多少岁_《迷茫中的我们该如何突破瓶颈——成长为一名架构师》...

如何成长为一名架构师&#xff1f;架构师是一个既需要掌控整体又需要洞悉局部瓶颈并依据具体的业务场景给出解决方案的团队领导型人物。一个架构师得需要足够的想像力,能把各种目标需求进行不同维度的扩展&#xff0c;为目标客户提供更为全面的需求清单。很多程序员想成为一名架…