MongoEngine - 信号


信号是由发送者对象调度的事件,任意数量的接收者对象可以订阅此类事件。信号接收器可以订阅特定发送器,也可以接收来自多个发送器的信号。

在 MongoEngine 中,blinker 库支持信号处理,这意味着您需要使用 pip 实用程序安装它。mongoengine.signals 模块具有以下信号的定义 -

预初始化 在创建新 Document 或 EmbeddedDocument 实例期间调用,并在收集构造函数参数之后但在对它们进行任何其他处理之前执行。
初始化后 在新 Document 或 EmbeddedDocument 实例的所有处理完成后调用。
预保存 在执行任何操作之前在 save() 中调用。
保存前验证后 在验证发生后但保存之前在 save() 内调用。
保存后 大多数操作(验证、插入/更新)成功完成后在 save() 中调用。传递一个附加的布尔关键字参数来指示保存是插入还是更新。
预删除 在尝试删除操作之前在 delete() 内调用。
删除后 成功删除记录后在 delete() 内调用。
预批量插入 在验证要插入的文档之后、写入任何数据之前调用。
后批量插入 成功批量插入操作后调用。加载的附加布尔参数将文档内容标识为 True 时的 Document 实例,或 False 时的插入记录的主键值列表。

然后将事件处理函数附加到 Document 类。请注意,EmbeddedDocument仅支持 pre/post_init 信号。pre/post_save 等应仅附加到 Document 的类。

您还可以使用装饰器快速创建多个信号并将它们作为类装饰器附加到 Document 或 EmbeddedDocument 子类。

在下面的示例中,作为信号处理程序的演示,我们还使用Python的标准库模块——日志记录并将日志记录级别设置为调试。

from mongoengine import *
from mongoengine import signals
import logging
logging.basicConfig(level=logging.DEBUG)

然后我们编写一个文档类,以便在 newdb 数据库中创建相应的集合。在该类内部,定义了两个类方法 pre_save() 和 post_save() 方法,它们旨在在文档保存到 Author 集合之前和之后调用。

class Author(Document):
   name = StringField()
   
   def __unicode__(self):
      return self.name

   @classmethod
   def pre_save(cls, sender, document, **kwargs):
      logging.debug("Pre Save: %s" % document.name)

   @classmethod
   def post_save(cls, sender, document, **kwargs):
      logging.debug("Post Save: %s" % document.name)
      if 'created' in kwargs:
         if kwargs['created']:
            logging.debug("Created")
         else:
            logging.debug("Updated")

这两个类方法都是使用类名、发送者对象和文档的参数以及可选的关键字参数列表来定义的。

最后,我们注册信号处理程序。

signals.pre_save.connect(Author.pre_save, sender=Author)
signals.post_save.connect(Author.post_save, sender=Author)

当我们创建 Document 子类的实例时,控制台日志将显示相应事件处理程序正在处理的保存前和保存后信号。

Author(name="Lathkar").save()

Python 控制台报告日志,如下所示 -

DEBUG:root:Pre Save: Lathkar
DEBUG:root:Post Save: Lathkar
DEBUG:root:Created