Implementing API exceptions in f

在我们编写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了。