任何异常的全局错误处理程序

Question

有没有一种方法可以添加全局catch all错误处理程序，以便将响应更改为通用JSON响应？

我不能使用got_request_exception信号，因为它不允许修改响应（http://flask.pocoo.org/docs/0.10/signals/）。

In contrast all signal handlers are executed in undefined order and do not modify any data.

我不想包装app.handle_exception函数，因为这感觉像内部API。我想我想要的是：

 @app.errorhandler()
 def handle_global_error(e):
     return "Global error"

注意errorhandler不接受任何参数，这意味着它将捕获所有没有附加特定错误处理程序的异常/状态代码。我知道我可以使用errorhandler(500)或errorhandler(Exception)来捕获异常，但是如果我这样做abort(409)例如，它仍然会返回一个HTML响应。

Answer 1

这与Flask 0.12兼容，是一个很好的解决方案（它允许以JSON或任何其他格式呈现错误）

from functools import wraps
from flask import Flask, redirect, jsonify
app = Flask(__name__)

def get_http_exception_handler(app):
    """Overrides the default http exception handler to return JSON."""
    handle_http_exception = app.handle_http_exception
    @wraps(handle_http_exception)
    def ret_val(exception):
        exc = handle_http_exception(exception)    
        return jsonify({'code':exc.code, 'message':exc.description}), exc.code
    return ret_val

# Override the HTTP exception handler.
app.handle_http_exception = get_http_exception_handler(app)

https://github.com/pallets/flask/issues/671#issuecomment-12746738

Answer 2

您可以使用@app.errorhandler(Exception)：

Demo（HTTPException检查确保保留状态代码）：

from flask import Flask, abort, jsonify
from werkzeug.exceptions import HTTPException

app = Flask('test')

@app.errorhandler(Exception)
def handle_error(e):
    code = 500
    if isinstance(e, HTTPException):
        code = e.code
    return jsonify(error=str(e)), code

@app.route('/')
def index():
    abort(409)

app.run(port=1234)

输出：

$ http get http://127.0.0.1:1234/
HTTP/1.0 409 CONFLICT
Content-Length: 31
Content-Type: application/json
Date: Sun, 29 Mar 2015 17:06:54 GMT
Server: Werkzeug/0.10.1 Python/3.4.3

{
    "error": "409: Conflict"
}

$ http get http://127.0.0.1:1234/notfound
HTTP/1.0 404 NOT FOUND
Content-Length: 32
Content-Type: application/json
Date: Sun, 29 Mar 2015 17:06:58 GMT
Server: Werkzeug/0.10.1 Python/3.4.3

{
    "error": "404: Not Found"
}

如果还想覆盖Flask中的默认HTML异常（以便它们也返回JSON），请在app.run之前添加以下内容：

from werkzeug.exceptions import default_exceptions
for ex in default_exceptions:
    app.register_error_handler(ex, handle_error)

对于较旧的Flask版本（<；=0.10.1，即当前的任何非git/master版本），向应用程序中添加以下代码以显式注册HTTP错误：

from werkzeug import HTTP_STATUS_CODES
for code in HTTP_STATUS_CODES:
    app.register_error_handler(code, handle_error)

Answer 3

很不优雅，但是下面的操作可以将HTTPException的所有子类绑定到单个错误处理程序：

from flask import jsonify
from werkzeug.exceptions import HTTPException

def handle_error(error):
    code = 500
    if isinstance(error, HTTPException):
        code = error.code
    return jsonify(error='error', code=code)

for cls in HTTPException.__subclasses__():
    app.register_error_handler(cls, handle_error)