/usr/share/doc/python-pymongo-doc/html/examples/custom_type.html is in python-pymongo-doc 2.6.3-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | <!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>Custom Type Example — PyMongo 2.6.3 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.3',
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>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="top" title="PyMongo 2.6.3 documentation" href="../index.html" />
<link rel="up" title="Examples" href="index.html" />
<link rel="next" title="Geospatial Indexing Example" href="geo.html" />
<link rel="prev" title="Authentication Examples" href="authentication.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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="geo.html" title="Geospatial Indexing Example"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="authentication.html" title="Authentication Examples"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">PyMongo 2.6.3 documentation</a> »</li>
<li><a href="index.html" accesskey="U">Examples</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="custom-type-example">
<h1>Custom Type Example<a class="headerlink" href="#custom-type-example" title="Permalink to this headline">¶</a></h1>
<p>This is an example of using a custom type with PyMongo. The example
here is a bit contrived, but shows how to use a
<a class="reference internal" href="../api/pymongo/son_manipulator.html#pymongo.son_manipulator.SONManipulator" title="pymongo.son_manipulator.SONManipulator"><tt class="xref py py-class docutils literal"><span class="pre">SONManipulator</span></tt></a> to manipulate
documents as they are saved or retrieved from MongoDB. More
specifically, it shows a couple different mechanisms for working with
custom datatypes in PyMongo.</p>
<div class="section" id="setup">
<h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2>
<p>We’ll start by getting a clean database to use for the example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pymongo.mongo_client</span> <span class="kn">import</span> <span class="n">MongoClient</span>
<span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">MongoClient</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">drop_database</span><span class="p">(</span><span class="s">"custom_type_example"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">db</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">custom_type_example</span>
</pre></div>
</div>
<p>Since the purpose of the example is to demonstrate working with custom
types, we’ll need a custom datatype to use. Here we define the aptly
named <tt class="xref py py-class docutils literal"><span class="pre">Custom</span></tt> class, which has a single method, <tt class="xref py py-meth docutils literal"><span class="pre">x()</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">Custom</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
<span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">__x</span> <span class="o">=</span> <span class="n">x</span>
<span class="gp">...</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">x</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__x</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">foo</span> <span class="o">=</span> <span class="n">Custom</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">foo</span><span class="o">.</span><span class="n">x</span><span class="p">()</span>
<span class="go">10</span>
</pre></div>
</div>
<p>When we try to save an instance of <tt class="xref py py-class docutils literal"><span class="pre">Custom</span></tt> with PyMongo, we’ll
get an <a class="reference internal" href="../api/bson/errors.html#bson.errors.InvalidDocument" title="bson.errors.InvalidDocument"><tt class="xref py py-class docutils literal"><span class="pre">InvalidDocument</span></tt></a> exception:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">insert</span><span class="p">({</span><span class="s">"custom"</span><span class="p">:</span> <span class="n">Custom</span><span class="p">(</span><span class="mi">5</span><span class="p">)})</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="gr">InvalidDocument</span>: <span class="n">cannot convert value of type <class 'Custom'> to bson</span>
</pre></div>
</div>
</div>
<div class="section" id="manual-encoding">
<h2>Manual Encoding<a class="headerlink" href="#manual-encoding" title="Permalink to this headline">¶</a></h2>
<p>One way to work around this is to manipulate our data into something
we <em>can</em> save with PyMongo. To do so we define two methods,
<tt class="xref py py-meth docutils literal"><span class="pre">encode_custom()</span></tt> and <tt class="xref py py-meth docutils literal"><span class="pre">decode_custom()</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">encode_custom</span><span class="p">(</span><span class="n">custom</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="p">{</span><span class="s">"_type"</span><span class="p">:</span> <span class="s">"custom"</span><span class="p">,</span> <span class="s">"x"</span><span class="p">:</span> <span class="n">custom</span><span class="o">.</span><span class="n">x</span><span class="p">()}</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">decode_custom</span><span class="p">(</span><span class="n">document</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">assert</span> <span class="n">document</span><span class="p">[</span><span class="s">"_type"</span><span class="p">]</span> <span class="o">==</span> <span class="s">"custom"</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">Custom</span><span class="p">(</span><span class="n">document</span><span class="p">[</span><span class="s">"x"</span><span class="p">])</span>
<span class="gp">...</span>
</pre></div>
</div>
<p>We can now manually encode and decode <tt class="xref py py-class docutils literal"><span class="pre">Custom</span></tt> instances and
use them with PyMongo:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">insert</span><span class="p">({</span><span class="s">"custom"</span><span class="p">:</span> <span class="n">encode_custom</span><span class="p">(</span><span class="n">Custom</span><span class="p">(</span><span class="mi">5</span><span class="p">))})</span>
<span class="go">ObjectId('...')</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()</span>
<span class="go">{u'_id': ObjectId('...'), u'custom': {u'x': 5, u'_type': u'custom'}}</span>
<span class="gp">>>> </span><span class="n">decode_custom</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()[</span><span class="s">"custom"</span><span class="p">])</span>
<span class="go"><Custom object at ...></span>
<span class="gp">>>> </span><span class="n">decode_custom</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()[</span><span class="s">"custom"</span><span class="p">])</span><span class="o">.</span><span class="n">x</span><span class="p">()</span>
<span class="go">5</span>
</pre></div>
</div>
</div>
<div class="section" id="automatic-encoding-and-decoding">
<h2>Automatic Encoding and Decoding<a class="headerlink" href="#automatic-encoding-and-decoding" title="Permalink to this headline">¶</a></h2>
<p>Needless to say, that was a little unwieldy. Let’s make this a bit
more seamless by creating a new
<a class="reference internal" href="../api/pymongo/son_manipulator.html#pymongo.son_manipulator.SONManipulator" title="pymongo.son_manipulator.SONManipulator"><tt class="xref py py-class docutils literal"><span class="pre">SONManipulator</span></tt></a>.
<a class="reference internal" href="../api/pymongo/son_manipulator.html#pymongo.son_manipulator.SONManipulator" title="pymongo.son_manipulator.SONManipulator"><tt class="xref py py-class docutils literal"><span class="pre">SONManipulator</span></tt></a> instances allow you
to specify transformations to be applied automatically by PyMongo:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pymongo.son_manipulator</span> <span class="kn">import</span> <span class="n">SONManipulator</span>
<span class="gp">>>> </span><span class="k">class</span> <span class="nc">Transform</span><span class="p">(</span><span class="n">SONManipulator</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">transform_incoming</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">son</span><span class="p">,</span> <span class="n">collection</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">for</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">son</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Custom</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">encode_custom</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span> <span class="c"># Make sure we recurse into sub-docs</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform_incoming</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">collection</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">son</span>
<span class="gp">...</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">transform_outgoing</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">son</span><span class="p">,</span> <span class="n">collection</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">for</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">son</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">if</span> <span class="s">"_type"</span> <span class="ow">in</span> <span class="n">value</span> <span class="ow">and</span> <span class="n">value</span><span class="p">[</span><span class="s">"_type"</span><span class="p">]</span> <span class="o">==</span> <span class="s">"custom"</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">decode_custom</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">else</span><span class="p">:</span> <span class="c"># Again, make sure to recurse into sub-docs</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform_outgoing</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">collection</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">son</span>
<span class="gp">...</span>
</pre></div>
</div>
<p>Now we add our manipulator to the <a class="reference internal" href="../api/pymongo/database.html#pymongo.database.Database" title="pymongo.database.Database"><tt class="xref py py-class docutils literal"><span class="pre">Database</span></tt></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">add_son_manipulator</span><span class="p">(</span><span class="n">Transform</span><span class="p">())</span>
</pre></div>
</div>
<p>After doing so we can save and restore <tt class="xref py py-class docutils literal"><span class="pre">Custom</span></tt> instances seamlessly:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">remove</span><span class="p">()</span> <span class="c"># remove whatever has already been saved</span>
<span class="go">{...}</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">insert</span><span class="p">({</span><span class="s">"custom"</span><span class="p">:</span> <span class="n">Custom</span><span class="p">(</span><span class="mi">5</span><span class="p">)})</span>
<span class="go">ObjectId('...')</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()</span>
<span class="go">{u'_id': ObjectId('...'), u'custom': <Custom object at ...>}</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()[</span><span class="s">"custom"</span><span class="p">]</span><span class="o">.</span><span class="n">x</span><span class="p">()</span>
<span class="go">5</span>
</pre></div>
</div>
<p>If we get a new <a class="reference internal" href="../api/pymongo/database.html#pymongo.database.Database" title="pymongo.database.Database"><tt class="xref py py-class docutils literal"><span class="pre">Database</span></tt></a> instance we’ll
clear out the <a class="reference internal" href="../api/pymongo/son_manipulator.html#pymongo.son_manipulator.SONManipulator" title="pymongo.son_manipulator.SONManipulator"><tt class="xref py py-class docutils literal"><span class="pre">SONManipulator</span></tt></a>
instance we added:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">custom_type_example</span>
</pre></div>
</div>
<p>This allows us to see what was actually saved to the database:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()</span>
<span class="go">{u'_id': ObjectId('...'), u'custom': {u'x': 5, u'_type': u'custom'}}</span>
</pre></div>
</div>
<p>which is the same format that we encode to with our
<tt class="xref py py-meth docutils literal"><span class="pre">encode_custom()</span></tt> method!</p>
</div>
<div class="section" id="binary-encoding">
<h2>Binary Encoding<a class="headerlink" href="#binary-encoding" title="Permalink to this headline">¶</a></h2>
<p>We can take this one step further by encoding to binary, using a user
defined subtype. This allows us to identify what to decode without
resorting to tricks like the <tt class="docutils literal"><span class="pre">_type</span></tt> field used above.</p>
<p>We’ll start by defining the methods <tt class="xref py py-meth docutils literal"><span class="pre">to_binary()</span></tt> and
<tt class="xref py py-meth docutils literal"><span class="pre">from_binary()</span></tt>, which convert <tt class="xref py py-class docutils literal"><span class="pre">Custom</span></tt> instances to and
from <a class="reference internal" href="../api/bson/binary.html#bson.binary.Binary" title="bson.binary.Binary"><tt class="xref py py-class docutils literal"><span class="pre">Binary</span></tt></a> instances:</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You could just pickle the instance and save that. What we do
here is a little more lightweight.</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">bson.binary</span> <span class="kn">import</span> <span class="n">Binary</span>
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">to_binary</span><span class="p">(</span><span class="n">custom</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">Binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">custom</span><span class="o">.</span><span class="n">x</span><span class="p">()),</span> <span class="mi">128</span><span class="p">)</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">from_binary</span><span class="p">(</span><span class="n">binary</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">Custom</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">binary</span><span class="p">))</span>
<span class="gp">...</span>
</pre></div>
</div>
<p>Next we’ll create another
<a class="reference internal" href="../api/pymongo/son_manipulator.html#pymongo.son_manipulator.SONManipulator" title="pymongo.son_manipulator.SONManipulator"><tt class="xref py py-class docutils literal"><span class="pre">SONManipulator</span></tt></a>, this time using the
methods we just defined:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">TransformToBinary</span><span class="p">(</span><span class="n">SONManipulator</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">transform_incoming</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">son</span><span class="p">,</span> <span class="n">collection</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">for</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">son</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Custom</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">to_binary</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform_incoming</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">collection</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">son</span>
<span class="gp">...</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">transform_outgoing</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">son</span><span class="p">,</span> <span class="n">collection</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">for</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">son</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="gp">... </span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">Binary</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">subtype</span> <span class="o">==</span> <span class="mi">128</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">from_binary</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">son</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transform_outgoing</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">collection</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">son</span>
<span class="gp">...</span>
</pre></div>
</div>
<p>Now we’ll empty the <a class="reference internal" href="../api/pymongo/database.html#pymongo.database.Database" title="pymongo.database.Database"><tt class="xref py py-class docutils literal"><span class="pre">Database</span></tt></a> and add the
new manipulator:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">remove</span><span class="p">()</span>
<span class="go">{...}</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">add_son_manipulator</span><span class="p">(</span><span class="n">TransformToBinary</span><span class="p">())</span>
</pre></div>
</div>
<p>After doing so we can save and restore <tt class="xref py py-class docutils literal"><span class="pre">Custom</span></tt> instances
seamlessly:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">insert</span><span class="p">({</span><span class="s">"custom"</span><span class="p">:</span> <span class="n">Custom</span><span class="p">(</span><span class="mi">5</span><span class="p">)})</span>
<span class="go">ObjectId('...')</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()</span>
<span class="go">{u'_id': ObjectId('...'), u'custom': <Custom object at ...>}</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()[</span><span class="s">"custom"</span><span class="p">]</span><span class="o">.</span><span class="n">x</span><span class="p">()</span>
<span class="go">5</span>
</pre></div>
</div>
<p>We can see what’s actually being saved to the database (and verify
that it is using a <a class="reference internal" href="../api/bson/binary.html#bson.binary.Binary" title="bson.binary.Binary"><tt class="xref py py-class docutils literal"><span class="pre">Binary</span></tt></a> instance) by
clearing out the manipulators and repeating our
<a class="reference internal" href="../api/pymongo/collection.html#pymongo.collection.Collection.find_one" title="pymongo.collection.Collection.find_one"><tt class="xref py py-meth docutils literal"><span class="pre">find_one()</span></tt></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">custom_type_example</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">find_one</span><span class="p">()</span>
<span class="go">{u'_id': ObjectId('...'), u'custom': Binary('5', 128)}</span>
</pre></div>
</div>
</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="#">Custom Type Example</a><ul>
<li><a class="reference internal" href="#setup">Setup</a></li>
<li><a class="reference internal" href="#manual-encoding">Manual Encoding</a></li>
<li><a class="reference internal" href="#automatic-encoding-and-decoding">Automatic Encoding and Decoding</a></li>
<li><a class="reference internal" href="#binary-encoding">Binary Encoding</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="authentication.html"
title="previous chapter">Authentication Examples</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="geo.html"
title="next chapter">Geospatial Indexing Example</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/examples/custom_type.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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="geo.html" title="Geospatial Indexing Example"
>next</a> |</li>
<li class="right" >
<a href="authentication.html" title="Authentication Examples"
>previous</a> |</li>
<li><a href="../index.html">PyMongo 2.6.3 documentation</a> »</li>
<li><a href="index.html" >Examples</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008 - 2012, 10gen, Inc..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
</div>
</body>
</html>
|