深入理解Django-Signals信号量


Posted in Python onFebruary 19, 2019

定义Signals

Django自身提供了一些常见的signal,用户本身也可以定义自己需要的signal

定义signal很简单,只需要实例化一个Signal实例即可

实例化Signal时,可以传入关键词参数providing_args, providing_args是一个列表,列表中定义了当前signal调用send方法时可以传入的参数。

# django.core.signals.py

from django.dispatch import Signal

request_started = Signal(providing_args=["environ"])
request_finished = Signal()
got_request_exception = Signal(providing_args=["request"])
setting_changed = Signal(providing_args=["setting", "value", "enter"])

其中Signal的初始化也比较简单,就是为实例化的signal定义一个线程锁

class Signal(object):
  def __init__(self, providing_args=None, use_caching=False):
    self.receivers = []
    if providing_args is None:
      providing_args = []
    self.providing_args = set(providing_args)
    self.lock = threading.Lock()
    self.use_caching = use_caching
    # For convenience we create empty caches even if they are not used.
    # A note about caching: if use_caching is defined, then for each
    # distinct sender we cache the receivers that sender has in
    # 'sender_receivers_cache'. The cache is cleaned when .connect() or
    # .disconnect() is called and populated on send().
    self.sender_receivers_cache = weakref.WeakKeyDictionary() if use_caching else {}
    self._dead_receivers = False

定义Signal处理函数

Signal处理函数是一个函数或者是一个实例的方法,并且必须满足下面条件:

  1. hashable
  2. 可以接收关键词参数

其中处理函数必须包含的关键词参数有两个:

  • signal,要接收的Signal实例
  • sender,要接收的Signal触发者
# django.db.__init__.py

from django.core import signals
from django.db.utils import ConnectionHandler

connections = ConnectionHandler()


def reset_queries(**kwargs):
  for conn in connections.all():
    conn.queries_log.clear()
signals.request_started.connect(reset_queries)


def close_old_connections(**kwargs):
  for conn in connections.all():
    conn.close_if_unusable_or_obsolete()
signals.request_started.connect(close_old_connections)
signals.request_finished.connect(close_old_connections)

处理函数绑定Signal

django提供了两种方法可以将Signal的处理函数和Signal实例进行绑定:

  • 手动调用connect方法
  • 使用装饰器receiver

其实装饰器receiver最终还是调用了connect方法将处理函数和Signal实例进行绑定

Signal类的connect方法定义如下:

class Signal(object):

  ...
  
  def connect(self, receiver, sender=None, weak=True, dispatch_uid=None):
    from django.conf import settings

    # If DEBUG is on, check that we got a good receiver
    if settings.configured and settings.DEBUG:
      assert callable(receiver), "Signal receivers must be callable."

      # Check for **kwargs
      if not func_accepts_kwargs(receiver):
        raise ValueError("Signal receivers must accept keyword arguments (**kwargs).")

    if dispatch_uid:
      lookup_key = (dispatch_uid, _make_id(sender))
    else:
      lookup_key = (_make_id(receiver), _make_id(sender))

    if weak:
      ref = weakref.ref
      receiver_object = receiver
      # Check for bound methods
      if hasattr(receiver, '__self__') and hasattr(receiver, '__func__'):
        ref = WeakMethod
        receiver_object = receiver.__self__
      if six.PY3:
        receiver = ref(receiver)
        weakref.finalize(receiver_object, self._remove_receiver)
      else:
        receiver = ref(receiver, self._remove_receiver)

    with self.lock:
      self._clear_dead_receivers()
      for r_key, _ in self.receivers:
        if r_key == lookup_key:
          break
      else:
        self.receivers.append((lookup_key, receiver))
      self.sender_receivers_cache.clear()

每个信号量根据receiver和sender都可以获取一个lookup_key可以唯一的标志一个Signal和其处理方法, 当调用Signal实例的connect方法时,会判断绑定的处理函数是否已经在自身receivers中,如果存在则不会重复注册

发送Singal

有了前面定义的Signal实例,以及定义的Signal实例处理方法,经过处理函数绑定Signal实例后就可以在必要的地方发送信号, 然后让绑定的处理函数处理了。

# django.core.handlers.wsgi.py

from threading import Lock

from django.core import signals
from django.core.handlers import base

 

class WSGIHandler(base.BaseHandler):

  ...

  def __call__(self, environ, start_response):

    ...
    
    signals.request_started.send(sender=self.__class__, environ=environ)
    
    ...

信号量最为Django的一个核心知识点,在项目中很少有使用到,所以很多人都不了解或者没听过过(包括我)。简单来说就是在进行一些操作的前后我们可以发出一个信号来获得特定的操作,这些操作包括

django.db.models.signals.pre_save&django.db.models.signals.post_save
在模型 save()方法调用之前或之后发送。

django.db.models.signals.pre_delete&django.db.models.signals.post_delete
在模型delete()方法或查询集的delete() 方法调用之前或之后发送。

django.db.models.signals.m2m_changed
模型上的 ManyToManyField 修改时发送。

django.core.signals.request_started&django.core.signals.request_finished
Django开始或完成HTTP请求时发送。

其他细致的知识点,大家可以点链接查看,直接通过一个例子解释:

在自定义用户模型类的时候,在后台添加用户数据因为使用了自定义模型类的create所以密码会以明文保存,接下来使用信号量方式在保存后马上修改密码解决。(网上一个项目的例子)

users/signals.py

from django.db.models.signals import post_save
from django.dispatch import receiver
from django.contrib.auth import get_user_model
User = get_user_model()


# post_save:上面七大方法之一:在模型保存之后的操作
# sender: 发出信号的model
@receiver(post_save, sender=User)
def create_user(sender, instance=None, created=False, **kwargs):
  """
  sender:模型类。
  instance:保存的实际实例。
  created:如果创建了新记录True。
  update_fields:Model.save()要更新的字段集,如果没有传递则为None
  """
  if created:
    password = instance.password
    # instance相当于user
    instance.set_password(password)
    instance.save()

users/apps.py

from django.apps import AppConfig


class UsersConfig(AppConfig):
  name = 'users'
  verbose_name = '用户管理'

  def ready(self):
  """使用ready加载,否则不生效"""
    import users.signals

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python每次处理固定个数的字符的方法总结
Jan 29 Python
Python使用matplotlib实现在坐标系中画一个矩形的方法
May 20 Python
Python批量提取PDF文件中文本的脚本
Mar 14 Python
python3处理含有中文的url方法
May 10 Python
使用python opencv对目录下图片进行去重的方法
Jan 12 Python
python批量爬取下载抖音视频
Jun 17 Python
django自定义模板标签过程解析
Dec 14 Python
Python 文件数据读写的具体实现
Jan 24 Python
浅析pip安装第三方库及pycharm中导入第三方库的问题
Mar 10 Python
pycharm的python_stubs问题
Apr 08 Python
使用Keras实现简单线性回归模型操作
Jun 12 Python
Python scrapy爬取小说代码案例详解
Jul 09 Python
python利用跳板机ssh远程连接redis的方法
Feb 19 #Python
Python获取Redis所有Key以及内容的方法
Feb 19 #Python
Python元组常见操作示例
Feb 19 #Python
python redis 删除key脚本的实例
Feb 19 #Python
Python列表切片操作实例总结
Feb 19 #Python
Python常用的json标准库
Feb 19 #Python
Python List cmp()知识点总结
Feb 18 #Python
You might like
php中关于普通表单多文件上传的处理方法
2011/03/25 PHP
IIS7.X配置PHP运行环境小结
2011/06/09 PHP
php使用百度天气接口示例
2014/04/22 PHP
正确的PHP匹配UTF-8中文的正则表达式
2015/05/13 PHP
PHP培训要多少钱
2017/06/06 PHP
JavaScript 编程引入命名空间的方法
2007/06/29 Javascript
jQuery UI AutoComplete 使用说明
2011/06/20 Javascript
用jQuery与JSONP轻松解决跨域访问的问题
2014/02/04 Javascript
node.js中的querystring.stringify方法使用说明
2014/12/10 Javascript
Angular.js与Bootstrap相结合实现表格分页代码
2016/04/12 Javascript
jQuery Ajax和getJSON获取后台普通json数据和层级json数据用法分析
2016/06/08 Javascript
BootStrap组件之进度条的基本用法
2017/01/19 Javascript
javascript与PHP动态往类中添加方法对比
2018/03/21 Javascript
vue-router 源码实现前端路由的两种方式
2018/07/02 Javascript
详解vue 项目白屏解决方案
2018/10/31 Javascript
微信小程序实现弹出层效果
2020/05/26 Javascript
微信小程序云开发之新手环境配置
2019/05/16 Javascript
jquery实现动态创建form并提交的方法示例
2019/05/27 jQuery
javascript实现的时间格式加8小时功能示例
2019/06/13 Javascript
JavaScript闭包相关知识解析
2019/10/19 Javascript
微信小程序实现侧边栏分类
2019/10/21 Javascript
[01:03:51]2018DOTA2亚洲邀请赛 4.7 淘汰赛 VP vs LGD 第三场
2018/04/09 DOTA
django2 快速安装指南分享
2018/01/05 Python
python实现简单tftp(基于udp协议)
2018/07/30 Python
Python 窗体(tkinter)按钮 位置实例
2019/06/13 Python
PyQT5 QTableView显示绑定数据的实例详解
2019/06/25 Python
三个python爬虫项目实例代码
2019/12/28 Python
Linux安装Python3如何和系统自带的Python2并存
2020/07/23 Python
匈牙利最大的健身制造商和销售商:inSPORTline
2018/10/30 全球购物
LG西班牙网上商店:Tienda LG Online Es
2019/07/30 全球购物
公司财务工作总结的自我评价
2013/11/23 职场文书
火车的故事教学反思
2014/02/11 职场文书
红旗方阵解说词
2014/02/12 职场文书
教师个人自我剖析材料
2014/09/29 职场文书
新学期主题班会
2015/08/17 职场文书
教你怎么用Python实现GIF动图的提取及合成
2021/06/15 Python