Python Web框架Flask信号机制(signals)介绍


Posted in Python onJanuary 01, 2015

信号(signals)

Flask信号(signals, or event hooking)允许特定的发送端通知订阅者发生了什么(既然知道发生了什么,那我们可以知道接下来该做什么了)。

Flask提供了一些信号(核心信号)且其它的扩展提供更多的信号。信号是用于通知订阅者,而不应该鼓励订阅者修改数据。相关信号请查阅文档。

信号依赖于Blinker库。

钩子(hooks)

Flask钩子(通常出现在蓝图或应用程序现存的方法中,比如一些内置装饰器,例如before_request)不需要Blinker库并且允许你改变请求对象(request)或者响应对象(response)。这些改变了应用程序(或者蓝图)的行为。比如before_request()装饰器。

信号看起来和钩子做同样的事情。然而在工作方式上它们存在不同。譬如核心的before_request()处理程序以特定的顺序执行,并且可以在返回响应之前放弃请求。相比之下,所有的信号处理器是无序执行的,并且不修改任何数据。

一般来说,钩子用于改变行为(比如,身份验证或错误处理),而信号用于记录事件(比如记录日志)。

创建信号

因为信号依赖于Blinker库,请确保已经安装。

如果你要在自己的应用中使用信号,你可以直接使用Blinker库。最常见的使用情况是命名一个自定义的Namespace的信号。这也是大多数时候推荐的做法:

from blinker import Namespace

my_signals = Namespace()

现在你可以像这样创建新的信号:

model_saved = my_signals.signal('model-saved')

这里使用唯一的信号名并且简化调试。可以用name属性来访问信号名。

对扩展开发者:

如果你正在编写一个Flask扩展,你想优雅地减少缺少Blinker安装的影响,你可以这样做使用flask.signals.Namespace类。

订阅信号

你可以使用信号的connect()方法来订阅信号。第一个参数是信号发出时要调用的函数,第二个参数是可选的,用于确定信号的发送者。一个信号可以拥有多个订阅者。你可以用disconnect()方法来退订信号。

对于所有的核心Flask信号,发送者都是发出信号的应用。当你订阅一个信号,请确保也提供一个发送者,除非你确实想监听全部应用的信号。这在你开发一个扩展的时候尤其正确。

比如这里有一个用于在单元测试中找出哪个模板被渲染和传入模板的变量的助手上下文管理器:

from flask import template_rendered

from contextlib import contextmanager
@contextmanager

def captured_templates(app):

    recorded = []

    def record(sender, template, context, **extra):

        recorded.append((template, context))

    template_rendered.connect(record, app)

    try:

        yield recorded

    finally:

        template_rendered.disconnect(record, app)

现在可以轻松地与测试客户端配对:

with captured_templates(app) as templates:

    rv = app.test_client().get('/')

    assert rv.status_code == 200

    assert len(templates) == 1

    template, context = templates[0]

    assert template.name == 'index.html'

    assert len(context['items']) == 10

确保订阅使用了一个额外的 **extra 参数,这样当 Flask 对信号引入新参数时你的调用不会失败。

代码中,从 with 块的应用 app 中流出的渲染的所有模板现在会被记录到templates 变量。无论何时模板被渲染,模板对象的上下文中添加上它。

此外,也有一个方便的助手方法(connected_to()) ,它允许你临时地用它自己的上下文管理器把函数订阅到信号。因为上下文管理器的返回值不能按那种方法给定,则需要把列表作为参数传入:

from flask import template_rendered
def captured_templates(app, recorded, **extra):

    def record(sender, template, context):

        recorded.append((template, context))

    return template_rendered.connected_to(record, app)

上面的例子看起来像这样:

templates = []

with captured_templates(app, templates, **extra):

    ...

    template, context = templates[0]

发送信号

如果你想要发送信号,你可以通过调用 send() 方法来达到目的。它接受一个发件者作为第一个参数和一些可选的被转发到信号用户的关键字参数:

class Model(object):

    ...
    def save(self):

        model_saved.send(self)

永远尝试选择一个合适的发送者。如果你有一个发出信号的类,把 self 作为发送者。如果你从一个随机的函数发出信号,把current_app._get_current_object()作为发送者。

基于信号订阅的装饰器

在Blinker 1.1中通过使用新的connect_via()装饰器你也能够轻易地订阅信号:

from flask import template_rendered
@template_rendered.connect_via(app)

def when_template_rendered(sender, template, context, **extra):

    print 'Template %s is rendered with %s' % (template.name, context)

举例

模板渲染

template_rendered信号是Flask核心信号。

当一个模版成功地渲染,这个信号会被发送。这个信号与模板实例 template 和上下文的词典(名为 context )一起调用。

信号发送:

def _render(template, context, app):

    """Renders the template and fires the signal"""

    rv = template.render(context)

    template_rendered.send(app, template=template, context=context)

    return rv

订阅示例:
def log_template_renders(sender, template, context, **extra):

    sender.logger.debug('Rendering template "%s" with context %s',

                        template.name or 'string template',

                        context)
from flask import template_rendered

template_rendered.connect(log_template_renders, app)


帐号追踪

user_logged_in是Flask-User中定义的信号,当用户成功登入之后,这个信号会被发送。

发送信号:

# Send user_logged_in signal

user_logged_in.send(current_app._get_current_object(), user=user)

下面这个例子追踪登录次数和登录IP:
# This code has not been tested
from flask import request

from flask_user.signals import user_logged_in
@user_logged_in.connect_via(app)

def _track_logins(sender, user, **extra):

    user.login_count += 1

    user.last_login_ip = request.remote_addr

    db.session.add(user)

    db.session.commit()

小结

信号可以让你在一瞬间安全地订阅它们。例如,这些临时的订阅对测试很有帮助。使用信号时,不要让信号订阅者(接收者)发生异常,因为异常会造成程序中断。

Python 相关文章推荐
爬山算法简介和Python实现实例
Apr 26 Python
Python中的作用域规则详解
Jan 30 Python
matplotlib作图添加表格实例代码
Jan 23 Python
浅谈pandas中DataFrame关于显示值省略的解决方法
Apr 08 Python
用Python下载一个网页保存为本地的HTML文件实例
May 21 Python
Python重新加载模块的实现方法
Oct 16 Python
numpy ndarray 按条件筛选数组,关联筛选的例子
Nov 26 Python
python飞机大战pygame游戏框架搭建操作详解
Dec 17 Python
PyCharm使用Docker镜像搭建Python开发环境
Dec 26 Python
Python气泡提示与标签的实现
Apr 01 Python
从python读取sql的实例方法
Jul 21 Python
python中pandas对多列进行分组统计的实现
Jun 18 Python
Python模拟登录12306的方法
Dec 30 #Python
python执行shell获取硬件参数写入mysql的方法
Dec 29 #Python
简单的抓取淘宝图片的Python爬虫
Dec 25 #Python
简单使用Python自动生成文章
Dec 25 #Python
Python 抓取动态网页内容方案详解
Dec 25 #Python
利用Psyco提升Python运行速度
Dec 24 #Python
Python解决鸡兔同笼问题的方法
Dec 20 #Python
You might like
DC宇宙的第一个英雄,堪称动漫史鼻祖,如今成为美国文化的象征
2020/04/09 欧美动漫
php一维二维数组键排序方法实例总结
2014/11/13 PHP
Thinkphp调用Image类生成缩略图的方法
2015/03/07 PHP
php将字符串转换成16进制的方法
2015/03/17 PHP
初识通用数据库操作类――前端easyui-datagrid,form(php)
2015/07/31 PHP
关于使用 jBox 对话框的提交不能弹出问题解决方法
2012/11/07 Javascript
jquery中change()用法实例分析
2015/02/06 Javascript
轻松掌握JavaScript策略模式
2016/08/25 Javascript
详解Node.js:events事件模块
2016/11/24 Javascript
Bootstrap输入框组件使用详解
2017/06/09 Javascript
浅析Vue 和微信小程序的区别、比较
2018/08/03 Javascript
Iview Table组件中各种组件扩展的使用
2018/10/20 Javascript
vue 内置过滤器的使用总结(附加自定义过滤器)
2018/12/11 Javascript
JavaScript函数IIFE使用详解
2019/10/21 Javascript
jQuery事件模型默认行为执行顺序及trigger()与 triggerHandler()比较实例分析
2020/04/30 jQuery
jQuery实现鼠标拖动图片功能
2021/03/04 jQuery
Python语言编写电脑时间自动同步小工具
2013/03/08 Python
python实现连接mongodb的方法
2015/05/08 Python
Python开发如何在ubuntu 15.10 上配置vim
2016/01/25 Python
在Python的Flask中使用WTForms表单框架的基础教程
2016/06/07 Python
详解Python中heapq模块的用法
2016/06/28 Python
深入理解python对json的操作总结
2017/01/05 Python
python搭建服务器实现两个Android客户端间收发消息
2018/04/12 Python
解决python有时候import不了当前的包问题
2019/08/28 Python
Python 图像对比度增强的几种方法(小结)
2019/09/25 Python
pytorch之inception_v3的实现案例
2020/01/06 Python
详解Python 实现 ZeroMQ 的三种基本工作模式
2020/03/24 Python
写一个函数,要求输入一个字符串和一个字符长度,对该字符串进行分隔
2015/07/30 面试题
电子信息毕业生自荐信
2013/11/16 职场文书
会计电算化个人自我评价
2013/11/17 职场文书
班主任个人工作反思
2014/04/28 职场文书
勤俭节约倡议书范文
2015/04/29 职场文书
标准版个人借条怎么写?以及什么是借条?
2019/08/28 职场文书
Angular CLI发布路径的配置项浅析
2021/03/29 Javascript
Java比较两个对象中全部属性值是否相等的方法
2021/08/07 Java/Android
Python之matplotlib绘制饼图
2022/04/13 Python