详解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 相关文章推荐
Python3.x中自定义比较函数
Apr 24 Python
教你用Python脚本快速为iOS10生成图标和截屏
Sep 22 Python
Python爬虫代理IP池实现方法
Jan 05 Python
Python编程求解二叉树中和为某一值的路径代码示例
Jan 04 Python
Python使用matplotlib的pie函数绘制饼状图功能示例
Jan 08 Python
python文件转为exe文件的方法及用法详解
Jul 08 Python
python 使用plt画图,去除图片四周的白边方法
Jul 09 Python
用Pytorch训练CNN(数据集MNIST,使用GPU的方法)
Aug 19 Python
将matplotlib绘图嵌入pyqt的方法示例
Jan 08 Python
python 检测图片是否有马赛克
Dec 01 Python
详解pandas apply 并行处理的几种方法
Feb 24 Python
人工智能深度学习OpenAI baselines的使用方法
May 20 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 采集程序 常用函数
2008/12/18 PHP
PHP源代码数组统计count分析
2011/08/02 PHP
php中fgetcsv()函数用法实例
2014/11/28 PHP
Symfony2联合查询实现方法
2016/03/18 PHP
PHP小偷程序的设计与实现方法详解
2016/10/15 PHP
Laravel实现通过blade模板引擎渲染视图
2019/10/25 PHP
关于实现代码语法标亮 dp.SyntaxHighlighter
2007/02/02 Javascript
几个有趣的Javascript Hack
2010/07/24 Javascript
子窗口、父窗口和Silverlight之间的相互调用
2010/08/16 Javascript
php对mongodb的扩展(小试牛刀)
2012/11/11 Javascript
详解JavaScript中的forEach()方法的使用
2015/06/08 Javascript
基于jQuery实现的扇形定时器附源码下载
2015/10/20 Javascript
js实现不重复导入的方法
2016/03/02 Javascript
使用BootStrap实现标签切换原理解析
2017/03/14 Javascript
vue2.0实战之使用vue-cli搭建项目(2)
2017/03/27 Javascript
JS实现禁止用户使用Ctrl+鼠标滚轮缩放网页的方法
2017/04/28 Javascript
JS实现元素上下左右移动效果
2017/10/18 Javascript
vue 实现 ios 原生picker 效果及实现思路解析
2017/12/06 Javascript
教你如何用node连接redis的示例代码
2018/07/12 Javascript
AngularJS与后端php的数据交互方法
2018/08/13 Javascript
Vue项目引进ElementUI组件的方法
2018/11/11 Javascript
使用pm2自动化部署node项目的方法步骤
2019/01/28 Javascript
原生JS实现随机点名项目的实例代码
2019/04/30 Javascript
JavaScript回调函数callback用法解析
2020/01/14 Javascript
Nuxt.js nuxt-link与router-link的区别说明
2020/11/06 Javascript
Windows系统配置python脚本开机启动的3种方法分享
2015/03/10 Python
Python模糊查询本地文件夹去除文件后缀的实例(7行代码)
2017/11/09 Python
python for 循环获取index索引的方法
2019/02/01 Python
Python进程池Pool应用实例分析
2019/11/27 Python
python与js主要区别点总结
2020/09/13 Python
HTML5中判断用户是否正在浏览页面的方法
2014/05/03 HTML / CSS
新加坡领先的时尚生活方式零售品牌:CHARLES & KEITH
2018/01/16 全球购物
什么是Rollback Segment
2013/04/22 面试题
亿企通软件测试面试题
2012/04/10 面试题
农村党支部书记党群众路线四风问题整改措施
2014/09/26 职场文书
人事文员岗位职责
2015/02/04 职场文书