详解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版微信红包分配算法
May 04 Python
使用Python的Flask框架表单插件Flask-WTF实现Web登录验证
Jul 12 Python
git使用.gitignore设置不生效或不起作用问题的解决方法
Jun 01 Python
Python中音频处理库pydub的使用教程
Jun 07 Python
详解Python 序列化Serialize 和 反序列化Deserialize
Aug 20 Python
python编程羊车门问题代码示例
Oct 25 Python
Python实现字典排序、按照list中字典的某个key排序的方法示例
Dec 18 Python
python匹配两个短语之间的字符实例
Dec 25 Python
Python 中的参数传递、返回值、浅拷贝、深拷贝
Jun 25 Python
selenium2.0中常用的python函数汇总
Aug 05 Python
python爬虫增加访问量的方法
Aug 22 Python
浅析pip安装第三方库及pycharm中导入第三方库的问题
Mar 10 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 用数组降低程序的时间复杂度
2009/12/04 PHP
ThinkPHP框架任意代码执行漏洞的利用及其修复方法
2014/07/04 PHP
thinkphp备份数据库的方法分享
2015/01/04 PHP
隐性调用php程序的方法
2015/06/13 PHP
php实现Session存储到Redis
2015/11/11 PHP
详解PHP的Yii框架中日志的相关配置及使用
2015/12/08 PHP
javascript 鼠标滚轮事件
2009/04/09 Javascript
浅析JQuery中的html(),text(),val()区别
2014/09/01 Javascript
DOM事件阶段以及事件捕获与事件冒泡先后执行顺序(图文详解)
2015/08/18 Javascript
jquery计算出left和top,让一个div水平垂直居中的简单实例
2016/07/13 Javascript
Vue的轮播图组件实现方法
2018/03/03 Javascript
Angular使用动态加载组件方法实现Dialog的示例
2018/05/11 Javascript
vue watch深度监听对象实现数据联动效果
2018/08/16 Javascript
swiper在angularjs中使用循环轮播失效的解决方法
2018/09/27 Javascript
详解vue-cli 2.0配置文件(小结)
2019/01/14 Javascript
javascript自定义日期比较函数用法示例
2019/07/22 Javascript
JavaScript实现英语单词题库
2019/12/24 Javascript
Python实现压缩与解压gzip大文件的方法
2016/09/18 Python
Python文件的读写和异常代码示例
2017/10/31 Python
详解python算法之冒泡排序
2019/03/05 Python
python实现抖音点赞功能
2019/04/07 Python
深入了解Python在HDA中的应用
2019/09/05 Python
Python中SQLite如何使用
2020/05/27 Python
Python脚本调试工具安装过程
2021/01/11 Python
利用Python如何画一颗心、小人发射爱心
2021/02/21 Python
英国家喻户晓的高街品牌:River Island
2017/11/28 全球购物
介绍一下write命令
2012/09/24 面试题
测试驱动开发的主要步骤是什么
2014/12/10 面试题
关键在于落实心得体会
2014/09/03 职场文书
2014年教师节演讲稿范文
2014/09/10 职场文书
学生会干部自我鉴定2014
2014/09/18 职场文书
小学生成绩单评语
2014/12/31 职场文书
消防安全月活动总结
2015/05/08 职场文书
红色影片观后感
2015/06/18 职场文书
学生退学证明
2015/06/23 职场文书
《圆的周长》教学反思
2016/02/17 职场文书