详解Python的Flask框架中的signals信号机制


Posted in Python onJune 13, 2016

Flask 提供了信号(Signals)功能,是一种消息分发机制。类似于钩子(Hooks)。使用信号功能可以降低程序的耦合,分解复杂的业务模型。例如在更新了产品数据后,可以发送一个信号。当有需要对产品数据进行处理的功能时,就可以捕获信号进行处理。比如要建立产品缓存,或是更新搜索索引等。

定义信号

Flask 信号功能使用了 Blinker 模块,所以需要先安装 Blinker 模块

pip install blinker

定义一个信号:

from blinker import Namespace
product_saved = Namespace()

也可以使用 Flask 包装的 singles 对象:

from flask.singles import Namespace

发送信号

发送信号需要带上 app 实例方法,示例如下:

product_saved.send(app, product=product)

app 后面可以添加要传递的参数,但必须以 name=value 的格式,不支持使用单个变量名的方式。

收接信号

接收信号可以使用 connect_via 装饰器函数:

@product_saved.connect_via(app)
def updateCache(app, product):
  print(product)

Flask 中有以下核心信号:

1.flask.template_rendered

这个信号发送于一个模板被渲染成功后。信号传递的template是模板的实例,context是环境对象是一个字典。

订阅示例:

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)

2.flask.request_started

这个信号发送于请求开始之前,且请求环境设置完成之后。因为请求环境已经绑定, 所以订阅者可以用标准的全局代理,如 request 来操作请求。

订阅示例:

def log_request(sender, **extra):
  sender.logger.debug('Request context is set up')
from flask import request_started
request_started.connect(log_request, app)
flask.request_finished

这个信号发送于向客户端发送响应之前。信号传递的response为将要发送的响应。

订阅示例:

def log_response(sender, response, **extra):
  sender.logger.debug('Request context is about to close down. '
            'Response: %s', response)
from flask import request_finished
request_finished.connect(log_response, app)
flask.got_request_exception

这个信号发送于请求进行中发生异常的时候。它的发送 早于 标准异常处理介于。 在调试模式下,虽然没有异常处理,但发生异常时也发送这个信号。信号传递的exception是异常对象。

订阅示例:

def log_exception(sender, exception, **extra):
  sender.logger.debug('Got exception during processing: %s', exception)
from flask import got_request_exception
got_request_exception.connect(log_exception, app)
flask.request_tearing_down

这个信号发送于请求崩溃的时候,不管是否引发异常。目前,侦听此信号的函数在一般 崩溃处理器后调用,但是没有什么东西可用。

订阅示例:

def close_db_connection(sender, **extra):
  session.close()from flask import appcontext_tearing_down
request_tearing_down.connect(close_db_connection, app)

在 Flask 版本 0.9 中,这还会传递一个exc关键字参数,如果这个参数存在的话。 这个参数是引发崩溃的异常的引用。

3.flask.appcontext_tearing_down

当应用环境崩溃时发送这个信号。这个信号总是会发送,甚至是因为一个异常引发的 崩溃。侦听这个信号的函数会在常规崩溃处理器后被调用,但是你无法回馈这个信号。

订阅示例:

def close_db_connection(sender, **extra):
  session.close()from flask import request_tearing_down
appcontext_tearing_down.connect(close_db_connection, app)

这还会传递一个exc关键字参数,如果这个参数存在的话。这个参数是引发崩溃的 异常的引用。

4.flask.appcontext_pushed

当一个应用的环境被压入时,应用会发送这个信号。这个信号通常用于在单元测试中 临时钩接信息。例如可以用于改变g对象中现存的资源。

用法示例:

from contextlib import contextmanagerfrom
flask import appcontext_pushed
@contextmanagerdef user_set(app, user):
  def handler(sender, **kwargs):
    g.user = user
  with appcontext_pushed.connected_to(handler, app):
    yield

在测试代码中这样写:

def test_user_me(self):
  with user_set(app, 'john'):
    c = app.test_client()
    resp = c.get('/users/me')
    assert resp.data == 'username=john'
New in version 0.10.

5.appcontext_popped

当一个应用的环境被弹出时,应用会发送这个信号。这个信号通常写成appcontext_tearing_down 信号。

6.flask.message_flashed

当应用闪现一个消息时会发出这个信号。message`参数是消息内容, `category参数是消息类别。

订阅示例:

recorded = []def record(sender, message, category, **extra):
  recorded.append((message, category))
from flask import message_flashed
message_flashed.connect(record, app)

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

Python 相关文章推荐
Python列表计数及插入实例
Dec 17 Python
Python的CGIHTTPServer交互实现详解
Feb 08 Python
基于django channel实现websocket的聊天室的方法示例
Apr 11 Python
Flask配置Cors跨域的实现
Jul 12 Python
处理python中多线程与多进程中的数据共享问题
Jul 28 Python
Python图像处理库PIL的ImageGrab模块介绍详解
Feb 26 Python
Jupyter notebook快速入门教程(推荐)
May 18 Python
python初步实现word2vec操作
Jun 09 Python
python 8种必备的gui库
Aug 27 Python
python 实现一个图形界面的汇率计算器
Nov 09 Python
Python爬虫Scrapy框架CrawlSpider原理及使用案例
Nov 20 Python
Django模板报TemplateDoesNotExist异常(亲测可行)
Dec 18 Python
Python的Flask站点中集成xhEditor文本编辑器的教程
Jun 13 #Python
Flask的图形化管理界面搭建框架Flask-Admin的使用教程
Jun 13 #Python
Python的Flask框架中集成CKeditor富文本编辑器的教程
Jun 13 #Python
Linux中安装Python的交互式解释器IPython的教程
Jun 13 #Python
浅谈python中的面向对象和类的基本语法
Jun 13 #Python
深入理解python多进程编程
Jun 12 #Python
python中根据字符串调用函数的实现方法
Jun 12 #Python
You might like
JSON在PHP中的应用介绍
2012/09/08 PHP
php实现在限定区域里自动调整字体大小的类实例
2015/04/02 PHP
php实现用手机关闭计算机(电脑)的方法
2015/04/22 PHP
Yii2框架数据库简单的增删改查语法小结
2016/08/31 PHP
php实现基于pdo的事务处理方法示例
2017/07/21 PHP
PHP数据源架构模式之表入口模式实例分析
2020/01/23 PHP
JavaScript的parseInt 进制问题
2009/05/07 Javascript
js中document.getElementByid、document.all和document.layers区分介绍
2011/12/08 Javascript
js delete 用法(删除对象属性及变量)
2014/08/24 Javascript
JavaScript设计模式之抽象工厂模式介绍
2014/12/28 Javascript
JQuery中两个ul标签的li互相移动实现方法
2015/05/18 Javascript
jQuery实现表格行上移下移和置顶的方法
2015/05/22 Javascript
Jquery实现遮罩层的方法
2015/06/08 Javascript
跟我学习javascript的基本类型和引用类型
2015/11/16 Javascript
jQuery实现模仿微博下拉滚动条加载数据效果
2015/12/25 Javascript
基于JavaScript实现树形下拉框
2016/08/10 Javascript
第一次接触Bootstrap框架
2016/10/24 Javascript
JavaScript中值类型和引用类型的区别
2017/02/23 Javascript
微信小程序 action-sheet 反馈上拉菜单简单实例
2017/05/11 Javascript
vue2.0 中使用transition实现动画效果使用心得
2018/08/13 Javascript
微信小程序导航栏滑动定位功能示例(实现CSS3的positionsticky效果)
2019/01/24 Javascript
Node 搭建一个静态资源服务器的实现
2019/05/20 Javascript
python实现复制整个目录的方法
2015/05/12 Python
Python中 CSV格式清洗与转换的实例代码
2019/08/29 Python
Python vtk读取并显示dicom文件示例
2020/01/13 Python
10行Python代码实现Web自动化管控的示例代码
2020/08/14 Python
python实现磁盘日志清理的示例
2020/11/05 Python
个人简历自我评价八例
2013/10/31 职场文书
门卫人员岗位职责
2013/12/24 职场文书
致800米运动员广播稿
2014/02/16 职场文书
四风问题专项整治工作情况报告
2014/10/28 职场文书
社区灵活就业证明
2014/11/03 职场文书
幼儿园感恩节活动总结
2015/03/24 职场文书
2015大学迎新晚会策划书
2015/07/16 职场文书
《小摄影师》教学反思
2016/02/18 职场文书
「睡美人」爱洛公主粘土人开订
2022/03/22 日漫