Implementing API exceptions in flask

在我们编写Restful Api的时候,非常常见的是flask内建的exception不够用,所以我们需要扩展flask中的exception,从而满足我们的定制化需求。

下面的代码是一个简单的定制exception的例子:

from flask import Flask
from flask import jsonify
app = Flask(__name__)

class InvalidUsage(Exception):
    status_code = 400

    def __init__(self, message, status_code = None, payload = None):
        Exception.__init__(self)
        self.message = message
        if status_code is not None:
            self.status_code = status_code
        self.payload = payload

    def to_dict(self):
        rv = dict(self.payload or ())
        rv['message'] = self.message
        return rv

@app.errorhandler(InvalidUsage)
def handle_invalid_useage(error):
    response = jsonify(error.to_dict())
    response.status_code = error.status_code
    return response

@app.route('/')
def hello_world():
    return 'Hello, World!'
@app.route('/errorpage')
def error_test():
    raise InvalidUsage('Error in this page', status_code = 401)

首先我们要import jsonify这个function,因为在返回的页面中需要把error message以json的格式展示出来。之后我们需要构建我们exception class,InvalidUsage这个class继承自Exception class,在constructor中做一些error checking和参数的初始化。之后只有一个方法叫做to_dict()需要我们把message和payload转换成dict的格式,从而方便把它格式成json。

在我们完成InvalidUsage class之后,理论上我们已经用raise InvalidUsage了,但是我们还没有在flask中注册它,所以还需要注册这个error handler。在flask中还是通过decorator来实现的,用@app.errorhandler(InvalidUsage)注册InvalidUsage,之后把json化的值赋和status_code赋值给response,然后我们就可以非常方便的使用InvalidUsage了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,773评论 19 139
  • 22年12月更新:个人网站关停,如果仍旧对旧教程有兴趣参考 Github 的markdown内容[https://...
    tangyefei阅读 35,303评论 22 257
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 5,860评论 0 9
  • [TOC]一直想做源码阅读这件事,总感觉难度太高时间太少,可望不可见。最近正好时间充裕,决定试试做一下,并记录一下...
    何柯君阅读 12,015评论 3 98
  • 难道你不好奇,你身边清冷拥挤,我都在这里 不说一句 别太充满戾气,别太消极情绪。 愿你每一次抬头都是温暖的太阳,清...
    周游的野狗阅读 2,662评论 0 0