详解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抓取网页中的图片示例
Feb 28 Python
寻找网站后台地址的python脚本
Sep 01 Python
python中input()与raw_input()的区别分析
Feb 27 Python
Python中Iterator迭代器的使用杂谈
Jun 20 Python
Python用模块pytz来转换时区
Aug 19 Python
python 判断网络连通的实现方法
Apr 22 Python
Python使用matplotlib 画矩形的三种方式分析
Oct 31 Python
解决pycharm每次打开项目都需要配置解释器和安装库问题
Feb 26 Python
Python延迟绑定问题原理及解决方案
Aug 04 Python
Django如何实现防止XSS攻击
Oct 13 Python
python 实现图片批量压缩的示例
Dec 18 Python
浅谈Selenium+Webdriver 常用的元素定位方式
Jan 13 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
PHP XML error parsing SOAP payload on line 1
2010/06/17 PHP
基于php常用函数总结(数组,字符串,时间,文件操作)
2013/06/27 PHP
php object转数组示例
2014/01/15 PHP
PHP return语句的另一个作用
2014/07/30 PHP
PHP7.1方括号数组符号多值复制及指定键值赋值用法分析
2016/09/26 PHP
Laravel推荐使用的十个辅助函数
2019/05/10 PHP
jquery插件validate验证的小例子
2013/05/08 Javascript
JS实现简单的键盘打字的效果
2015/04/24 Javascript
javascript实现仿IE顶部的可关闭警告条
2015/05/05 Javascript
JavaScript实现跑马灯抽奖活动实例代码解析与优化(二)
2016/02/16 Javascript
基于bootstrap的文件上传控件bootstrap fileinput
2016/12/23 Javascript
JS实现的样式切换功能tableCSS实例
2016/12/30 Javascript
js正则表达式验证表单【完整版】
2017/03/06 Javascript
详解使用PM2管理nodejs进程
2017/10/24 NodeJs
vue2里面ref的具体使用方法
2017/10/27 Javascript
JavaScript 中的12种循环遍历方法【总结】
2018/05/31 Javascript
Vue数据驱动表单渲染,轻松搞定form表单
2019/07/19 Javascript
使用Karma做vue组件单元测试的实现
2020/01/16 Javascript
javascript设计模式 ? 装饰模式原理与应用实例分析
2020/04/14 Javascript
[05:28]刀塔密之一:团结则存
2014/07/03 DOTA
Python获取服务器信息的最简单实现方法
2015/03/05 Python
研究Python的ORM框架中的SQLAlchemy库的映射关系
2015/04/25 Python
Python列表和元组的定义与使用操作示例
2017/07/26 Python
Python时间的精准正则匹配方法分析
2017/08/17 Python
Django基础三之视图函数的使用方法
2019/07/18 Python
python集合的创建、添加及删除操作示例
2019/10/08 Python
python将字符串转变成dict格式的实现
2019/11/18 Python
Python vtk读取并显示dicom文件示例
2020/01/13 Python
TensorFlow设置日志级别的几种方式小结
2020/02/04 Python
Django前后端分离csrf token获取方式
2020/12/25 Python
处理HTML5新标签的浏览器兼容版问题
2017/03/13 HTML / CSS
可能这些是你想要的H5软键盘兼容方案(小结)
2019/04/23 HTML / CSS
Html5 canvas画图白板踩坑
2020/06/01 HTML / CSS
Lenox官网:精美的瓷器&独特的礼品
2017/02/12 全球购物
机关干部四风问题自我剖析及整改措施
2014/10/26 职场文书
矛盾论读书笔记
2015/06/29 职场文书