<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Signals — MongoEngine 0.7.9 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.7.9',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="MongoEngine 0.7.9 documentation" href="../index.html" />
<link rel="up" title="User Guide" href="index.html" />
<link rel="next" title="API Reference" href="../apireference.html" />
<link rel="prev" title="GridFS" href="gridfs.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../apireference.html" title="API Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gridfs.html" title="GridFS"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">MongoEngine 0.7.9 documentation</a> »</li>
<li><a href="index.html" accesskey="U">User Guide</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="signals">
<span id="id1"></span><h1>Signals<a class="headerlink" href="#signals" title="Permalink to this headline">¶</a></h1>
<p class="versionadded">
<span class="versionmodified">New in version 0.5.</span></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Signal support is provided by the excellent <a class="reference external" href="http://pypi.python.org/pypi/blinker">blinker</a> library and
will gracefully fall back if it is not available.</p>
</div>
<p>The following document signals exist in MongoEngine and are pretty self-explanatory:</p>
<blockquote>
<div><ul class="simple">
<li><cite>mongoengine.signals.pre_init</cite></li>
<li><cite>mongoengine.signals.post_init</cite></li>
<li><cite>mongoengine.signals.pre_save</cite></li>
<li><cite>mongoengine.signals.post_save</cite></li>
<li><cite>mongoengine.signals.pre_delete</cite></li>
<li><cite>mongoengine.signals.post_delete</cite></li>
<li><cite>mongoengine.signals.pre_bulk_insert</cite></li>
<li><cite>mongoengine.signals.post_bulk_insert</cite></li>
</ul>
</div></blockquote>
<p>Example usage:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">mongoengine</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">mongoengine</span> <span class="kn">import</span> <span class="n">signals</span>
<span class="k">class</span> <span class="nc">Author</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">StringField</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">pre_save</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">document</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">logging</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"Pre Save: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">document</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">post_save</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">sender</span><span class="p">,</span> <span class="n">document</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">logging</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"Post Save: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">document</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="s">'created'</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
<span class="k">if</span> <span class="n">kwargs</span><span class="p">[</span><span class="s">'created'</span><span class="p">]:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"Created"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logging</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"Updated"</span><span class="p">)</span>
<span class="n">signals</span><span class="o">.</span><span class="n">pre_save</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">Author</span><span class="o">.</span><span class="n">pre_save</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="n">Author</span><span class="p">)</span>
<span class="n">signals</span><span class="o">.</span><span class="n">post_save</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">Author</span><span class="o">.</span><span class="n">post_save</span><span class="p">,</span> <span class="n">sender</span><span class="o">=</span><span class="n">Author</span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="referencefields-and-signals">
<h2>ReferenceFields and signals<a class="headerlink" href="#referencefields-and-signals" title="Permalink to this headline">¶</a></h2>
<p>Currently <cite>reverse_delete_rules</cite> do not trigger signals on the other part of
the relationship. If this is required you must manually handled the
reverse deletion.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Signals</a><ul>
<li><a class="reference internal" href="#referencefields-and-signals">ReferenceFields and signals</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="gridfs.html"
title="previous chapter">GridFS</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../apireference.html"
title="next chapter">API Reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/guide/signals.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../apireference.html" title="API Reference"
>next</a> |</li>
<li class="right" >
<a href="gridfs.html" title="GridFS"
>previous</a> |</li>
<li><a href="../index.html">MongoEngine 0.7.9 documentation</a> »</li>
<li><a href="index.html" >User Guide</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2012, MongoEngine Authors.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
fed11210b13cd26c680f56feb1a98a41
>
files
>
109
