如何覆盖Flask蓝图URL？

Question

我正在使用flask-mwoauthMediaWiki上的OAuth身份验证(特别是维基百科)在Flask中创建一个简单的应用程序.

flask-mwoauth 是一个蓝图,它提供了一些与Mediawiki Extensions:OAuth交互的便捷方法,并添加了以下URI:

• /login - 运行OAuth握手并将用户返回 /
  • /login?next=/someurl 将用户返回 /someurl
• /logout - 清除用户的访问权限
  • /logout?next=/someurl 将用户返回 /someurl
• /oauth-callback - 来自MW的回调以完成握手

用户的OAuth密钥和密钥存储在会话中.

我希望能够为这些自定义URI创建自定义响应.举例来说/logout,响应的定义非常简单(__init__.py#L56):

@self.bp.route('/logout')
def logout():
    session['mwo_token'] = None
    session['username'] = None
    if 'next' in request.args:
        return redirect(request.args['next'])
    return "Logged out!"

我想在我的应用程序中定义/logout带有自定义响应的路径(例如,渲染模板),但是如果我使用蓝图,那么路由将@app.route("/logout")被忽略.

我想知道是否可以"扩展"蓝图,我可以/logout在我的应用程序中定义路线,从蓝图中调用原始方法,然后提供自定义响应.

Answer 1

如果你想完全重新定义路由的行为，最好的方法是覆盖MWOAuth类。这是一个有效的示例：

import os

from flask import Flask, Blueprint
from flask_mwoauth import MWOAuth

app = Flask(__name__)
app.secret_key = os.urandom(24)


class MyMWOAuth(MWOAuth):
    def __init__(self,
                 base_url='https://www.mediawiki.org/w',
                 clean_url="Deprecated",
                 default_return_to='index',
                 consumer_key=None,
                 consumer_secret=None,
                 name="Deprecated"):
        # I skipped other rows. It's just an example
        self.bp = Blueprint('mwoauth', __name__)
        # By the way you can customize here login and oauth-callback
        @self.bp.route('/logout')
        def logout():
            # your custom logic here...
            return "My custom logout"


mwoauth = MyMWOAuth(consumer_key='test', consumer_secret='test')
app.register_blueprint(mwoauth.bp)


if __name__ == "__main__":
    app.run(debug=True, threaded=True)

我们打开吧/logout。你会看见My custom logout。正如您所看到的，BluePrint 路由的注册发生在init的方法中MWOAuth。

第二种方法是使用请求回调。下面的示例演示了注销后响应正文的变化。

from flask import g, request


def after_this_request(f):
    if not hasattr(g, 'after_request_callbacks'):
        g.after_request_callbacks = []
    g.after_request_callbacks.append(f)
    return f


@app.after_request
def call_after_request_callbacks(r):
    for callback in getattr(g, 'after_request_callbacks', ()):
        callback(r)
    return r


@app.before_request
def before_logout():
    @after_this_request
    def after_logout(response):
        # check if called route == '/logout'
        # in our case response.data == 'Logged out!'
        # see: https://github.com/valhallasw/flask-mwoauth/blob/master/flask_mwoauth/__init__.py#L48
        if request.url_rule.endpoint == 'mwoauth.logout':
            # custom logic here...
            # for example I change data in request
            response.data = 'Data from after_logout'

我们打开吧/logout。你会看见Data from after_logout。

希望这可以帮助。