在烧瓶应用程序中重用样板代码

Question

我的许多烧瓶应用程序都有一些错误处理调用。例如，我的 404 响应是使用 @app.errorhandler 装饰器定义的：

@app.errorhandler(404)
def page_not_found(e):
    return jsonify({'status': 'error',
                    'reason': '''There's no API call for %s''' % request.base_url,
                    'code': 404}), 404

由于我有大量样板代码，我想将其放在一个公共文件中，并从一个地方继承或导入我的烧瓶应用程序。

是否可以从不同的模块继承或导入烧瓶样板代码？

Answer 1

当然有，但您需要对注册进行参数化。

不使用装饰器，而是将注册移动到函数中：

def page_not_found(e):
    return jsonify({'status': 'error',
                    'reason': '''There's no API call for %s''' % request.base_url,
                    'code': 404}), 404


def register_all(app):
    app.register_error_handler(404, page_not_found)

然后导入 register_all 并使用您的 Flask() 对象调用它。

这使用Flask.register_error_handler() 函数而不是装饰器。

为了也支持蓝图，你需要等待 Flask 的下一个版本（包括this commit），或者直接使用装饰器功能：

app_or_blueprint.errorhandler(404)(page_not_found)

对于许多此类任务，您也可以使用蓝图，前提是您使用Blueprint.app_errorhandler()：

common_errors = Blueprint('common_errors')


@common_errors.errorhandler(404)    
def page_not_found(e):
    return jsonify({'status': 'error',
                    'reason': '''There's no API call for %s''' % request.base_url,
                    'code': 404}), 404

不是所有的事情都可以由蓝图处理，但如果您注册的只是错误处理程序，那么蓝图是一个不错的方法。

照常导入蓝图并将其注册到您的应用：

from yourmodule import common_errors
app.register_blueprint(common_errors)