File: history_meta.html

package info (click to toggle)
sqlalchemy 0.9.8%2Bdfsg-0.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 23,952 kB
  • ctags: 24,534
  • sloc: python: 152,282; ansic: 1,346; makefile: 257; xml: 17
file content (346 lines) | stat: -rw-r--r-- 32,785 bytes parent folder | download
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!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>
            
    
                examples.versioned_history.history_meta
             &mdash;
    SQLAlchemy 0.9 Documentation

        </title>

        
            <!-- begin iterate through SQLA + sphinx environment css_files -->
                <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
                <link rel="stylesheet" href="../../../_static/docs.css" type="text/css" />
                <link rel="stylesheet" href="../../../_static/sphinx_paramlinks.css" type="text/css" />
                <link rel="stylesheet" href="../../../_static/changelog.css" type="text/css" />
            <!-- end iterate through SQLA + sphinx environment css_files -->
        

        

    

    <!-- begin layout.mako headers -->

    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    '../../../',
          VERSION:     '0.9.8',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: '.html'
      };
    </script>

    <!-- begin iterate through sphinx environment script_files -->
        <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>
    <!-- end iterate through sphinx environment script_files -->

    <script type="text/javascript" src="../../../_static/detectmobile.js"></script>
    <script type="text/javascript" src="../../../_static/init.js"></script>
    <link rel="index" title="Index" href="../../../genindex.html" />
    <link rel="search" title="Search" href="../../../search.html" />
        <link rel="copyright" title="Copyright" href="../../../copyright.html" />
    <link rel="top" title="SQLAlchemy 0.9 Documentation" href="../../../index.html" />
        <link rel="up" title="Module code" href="../../index.html" />
    <!-- end layout.mako headers -->


    </head>
    <body>
        















<div id="docs-container">





<div id="docs-top-navigation-container" class="body-background">
<div id="docs-header">
    <div id="docs-version-header">
        Release: <span class="version-num">0.9.8</span> | Release Date: October 13, 2014
    </div>

    <h1>SQLAlchemy 0.9 Documentation</h1>

</div>
</div>

<div id="docs-body-container">

    <div id="fixed-sidebar" class="">

        <div id="index-nav">
            <form class="search" action="../../../search.html" method="get">
              <input type="text" name="q" size="12" /> <input type="submit" value="Search" />
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>

            <p>
            <a href="../../../index.html">Contents</a> |
            <a href="../../../genindex.html">Index</a>
            </p>

        </div>


    </div>

    

    <div id="docs-body" class="" >
        
<h1>Source code for examples.versioned_history.history_meta</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot;Versioned mixin class and other utilities.&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">sqlalchemy.ext.declarative</span> <span class="kn">import</span> <span class="n">declared_attr</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm</span> <span class="kn">import</span> <span class="n">mapper</span><span class="p">,</span> <span class="n">attributes</span><span class="p">,</span> <span class="n">object_mapper</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm.exc</span> <span class="kn">import</span> <span class="n">UnmappedColumnError</span>
<span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">Table</span><span class="p">,</span> <span class="n">Column</span><span class="p">,</span> <span class="n">ForeignKeyConstraint</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">DateTime</span>
<span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">event</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.orm.properties</span> <span class="kn">import</span> <span class="n">RelationshipProperty</span>

<span class="k">def</span> <span class="nf">col_references_table</span><span class="p">(</span><span class="n">col</span><span class="p">,</span> <span class="n">table</span><span class="p">):</span>
    <span class="k">for</span> <span class="n">fk</span> <span class="ow">in</span> <span class="n">col</span><span class="o">.</span><span class="n">foreign_keys</span><span class="p">:</span>
        <span class="k">if</span> <span class="n">fk</span><span class="o">.</span><span class="n">references</span><span class="p">(</span><span class="n">table</span><span class="p">):</span>
            <span class="k">return</span> <span class="bp">True</span>
    <span class="k">return</span> <span class="bp">False</span>

<span class="k">def</span> <span class="nf">_is_versioning_col</span><span class="p">(</span><span class="n">col</span><span class="p">):</span>
    <span class="k">return</span> <span class="s">&quot;version_meta&quot;</span> <span class="ow">in</span> <span class="n">col</span><span class="o">.</span><span class="n">info</span>

<span class="k">def</span> <span class="nf">_history_mapper</span><span class="p">(</span><span class="n">local_mapper</span><span class="p">):</span>
    <span class="n">cls</span> <span class="o">=</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">class_</span>

    <span class="c"># set the &quot;active_history&quot; flag</span>
    <span class="c"># on on column-mapped attributes so that the old version</span>
    <span class="c"># of the info is always loaded (currently sets it on all attributes)</span>
    <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">iterate_properties</span><span class="p">:</span>
        <span class="nb">getattr</span><span class="p">(</span><span class="n">local_mapper</span><span class="o">.</span><span class="n">class_</span><span class="p">,</span> <span class="n">prop</span><span class="o">.</span><span class="n">key</span><span class="p">)</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">active_history</span> <span class="o">=</span> <span class="bp">True</span>

    <span class="n">super_mapper</span> <span class="o">=</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">inherits</span>
    <span class="n">super_history_mapper</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="s">&#39;__history_mapper__&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>

    <span class="n">polymorphic_on</span> <span class="o">=</span> <span class="bp">None</span>
    <span class="n">super_fks</span> <span class="o">=</span> <span class="p">[]</span>

    <span class="k">def</span> <span class="nf">_col_copy</span><span class="p">(</span><span class="n">col</span><span class="p">):</span>
        <span class="n">col</span> <span class="o">=</span> <span class="n">col</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
        <span class="n">col</span><span class="o">.</span><span class="n">unique</span> <span class="o">=</span> <span class="bp">False</span>
        <span class="n">col</span><span class="o">.</span><span class="n">default</span> <span class="o">=</span> <span class="n">col</span><span class="o">.</span><span class="n">server_default</span> <span class="o">=</span> <span class="bp">None</span>
        <span class="k">return</span> <span class="n">col</span>

    <span class="k">if</span> <span class="ow">not</span> <span class="n">super_mapper</span> <span class="ow">or</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">super_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="p">:</span>
        <span class="n">cols</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">_is_versioning_col</span><span class="p">(</span><span class="n">column</span><span class="p">):</span>
                <span class="k">continue</span>

            <span class="n">col</span> <span class="o">=</span> <span class="n">_col_copy</span><span class="p">(</span><span class="n">column</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">super_mapper</span> <span class="ow">and</span> <span class="n">col_references_table</span><span class="p">(</span><span class="n">column</span><span class="p">,</span> <span class="n">super_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="p">):</span>
                <span class="n">super_fks</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">col</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="nb">list</span><span class="p">(</span><span class="n">super_history_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">primary_key</span><span class="p">)[</span><span class="mi">0</span><span class="p">]))</span>

            <span class="n">cols</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">col</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">column</span> <span class="ow">is</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">polymorphic_on</span><span class="p">:</span>
                <span class="n">polymorphic_on</span> <span class="o">=</span> <span class="n">col</span>

        <span class="k">if</span> <span class="n">super_mapper</span><span class="p">:</span>
            <span class="n">super_fks</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s">&#39;version&#39;</span><span class="p">,</span> <span class="n">super_history_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">version</span><span class="p">))</span>

        <span class="n">version_meta</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;version_meta&quot;</span><span class="p">:</span> <span class="bp">True</span><span class="p">}</span>  <span class="c"># add column.info to identify</span>
                                               <span class="c"># columns specific to versioning</span>

        <span class="c"># &quot;version&quot; stores the integer version id.  This column is</span>
        <span class="c"># required.</span>
        <span class="n">cols</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Column</span><span class="p">(</span><span class="s">&#39;version&#39;</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">primary_key</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
                            <span class="n">autoincrement</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">info</span><span class="o">=</span><span class="n">version_meta</span><span class="p">))</span>

        <span class="c"># &quot;changed&quot; column stores the UTC timestamp of when the</span>
        <span class="c"># history row was created.</span>
        <span class="c"># This column is optional and can be omitted.</span>
        <span class="n">cols</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">Column</span><span class="p">(</span><span class="s">&#39;changed&#39;</span><span class="p">,</span> <span class="n">DateTime</span><span class="p">,</span>
                            <span class="n">default</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">,</span>
                            <span class="n">info</span><span class="o">=</span><span class="n">version_meta</span><span class="p">))</span>

        <span class="k">if</span> <span class="n">super_fks</span><span class="p">:</span>
            <span class="n">cols</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ForeignKeyConstraint</span><span class="p">(</span><span class="o">*</span><span class="nb">zip</span><span class="p">(</span><span class="o">*</span><span class="n">super_fks</span><span class="p">)))</span>

        <span class="n">table</span> <span class="o">=</span> <span class="n">Table</span><span class="p">(</span><span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s">&#39;_history&#39;</span><span class="p">,</span>
                        <span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">metadata</span><span class="p">,</span>
                        <span class="o">*</span><span class="n">cols</span><span class="p">,</span>
                        <span class="n">schema</span><span class="o">=</span><span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">schema</span>
        <span class="p">)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="c"># single table inheritance.  take any additional columns that may have</span>
        <span class="c"># been added and add them to the history table.</span>
        <span class="k">for</span> <span class="n">column</span> <span class="ow">in</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">column</span><span class="o">.</span><span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">super_history_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="p">:</span>
                <span class="n">col</span> <span class="o">=</span> <span class="n">_col_copy</span><span class="p">(</span><span class="n">column</span><span class="p">)</span>
                <span class="n">super_history_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">append_column</span><span class="p">(</span><span class="n">col</span><span class="p">)</span>
        <span class="n">table</span> <span class="o">=</span> <span class="bp">None</span>

    <span class="k">if</span> <span class="n">super_history_mapper</span><span class="p">:</span>
        <span class="n">bases</span> <span class="o">=</span> <span class="p">(</span><span class="n">super_history_mapper</span><span class="o">.</span><span class="n">class_</span><span class="p">,)</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="n">bases</span> <span class="o">=</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">base_mapper</span><span class="o">.</span><span class="n">class_</span><span class="o">.</span><span class="n">__bases__</span>
    <span class="n">versioned_cls</span> <span class="o">=</span> <span class="nb">type</span><span class="o">.</span><span class="n">__new__</span><span class="p">(</span><span class="nb">type</span><span class="p">,</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">History&quot;</span> <span class="o">%</span> <span class="n">cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="p">{})</span>

    <span class="n">m</span> <span class="o">=</span> <span class="n">mapper</span><span class="p">(</span>
            <span class="n">versioned_cls</span><span class="p">,</span>
            <span class="n">table</span><span class="p">,</span>
            <span class="n">inherits</span><span class="o">=</span><span class="n">super_history_mapper</span><span class="p">,</span>
            <span class="n">polymorphic_on</span><span class="o">=</span><span class="n">polymorphic_on</span><span class="p">,</span>
            <span class="n">polymorphic_identity</span><span class="o">=</span><span class="n">local_mapper</span><span class="o">.</span><span class="n">polymorphic_identity</span>
            <span class="p">)</span>
    <span class="n">cls</span><span class="o">.</span><span class="n">__history_mapper__</span> <span class="o">=</span> <span class="n">m</span>

    <span class="k">if</span> <span class="ow">not</span> <span class="n">super_history_mapper</span><span class="p">:</span>
        <span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">append_column</span><span class="p">(</span>
            <span class="n">Column</span><span class="p">(</span><span class="s">&#39;version&#39;</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">nullable</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
        <span class="p">)</span>
        <span class="n">local_mapper</span><span class="o">.</span><span class="n">add_property</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">,</span> <span class="n">local_mapper</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>


<span class="k">class</span> <span class="nc">Versioned</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="nd">@declared_attr</span>
    <span class="k">def</span> <span class="nf">__mapper_cls__</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
        <span class="k">def</span> <span class="nf">map</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">arg</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
            <span class="n">mp</span> <span class="o">=</span> <span class="n">mapper</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="o">*</span><span class="n">arg</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
            <span class="n">_history_mapper</span><span class="p">(</span><span class="n">mp</span><span class="p">)</span>
            <span class="k">return</span> <span class="n">mp</span>
        <span class="k">return</span> <span class="nb">map</span>


<span class="k">def</span> <span class="nf">versioned_objects</span><span class="p">(</span><span class="nb">iter</span><span class="p">):</span>
    <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="nb">iter</span><span class="p">:</span>
        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s">&#39;__history_mapper__&#39;</span><span class="p">):</span>
            <span class="k">yield</span> <span class="n">obj</span>

<span class="k">def</span> <span class="nf">create_version</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">deleted</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
    <span class="n">obj_mapper</span> <span class="o">=</span> <span class="n">object_mapper</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
    <span class="n">history_mapper</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">__history_mapper__</span>
    <span class="n">history_cls</span> <span class="o">=</span> <span class="n">history_mapper</span><span class="o">.</span><span class="n">class_</span>

    <span class="n">obj_state</span> <span class="o">=</span> <span class="n">attributes</span><span class="o">.</span><span class="n">instance_state</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>

    <span class="n">attr</span> <span class="o">=</span> <span class="p">{}</span>

    <span class="n">obj_changed</span> <span class="o">=</span> <span class="bp">False</span>

    <span class="k">for</span> <span class="n">om</span><span class="p">,</span> <span class="n">hm</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">obj_mapper</span><span class="o">.</span><span class="n">iterate_to_root</span><span class="p">(),</span> <span class="n">history_mapper</span><span class="o">.</span><span class="n">iterate_to_root</span><span class="p">()):</span>
        <span class="k">if</span> <span class="n">hm</span><span class="o">.</span><span class="n">single</span><span class="p">:</span>
            <span class="k">continue</span>

        <span class="k">for</span> <span class="n">hist_col</span> <span class="ow">in</span> <span class="n">hm</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">_is_versioning_col</span><span class="p">(</span><span class="n">hist_col</span><span class="p">):</span>
                <span class="k">continue</span>

            <span class="n">obj_col</span> <span class="o">=</span> <span class="n">om</span><span class="o">.</span><span class="n">local_table</span><span class="o">.</span><span class="n">c</span><span class="p">[</span><span class="n">hist_col</span><span class="o">.</span><span class="n">key</span><span class="p">]</span>

            <span class="c"># get the value of the</span>
            <span class="c"># attribute based on the MapperProperty related to the</span>
            <span class="c"># mapped column.  this will allow usage of MapperProperties</span>
            <span class="c"># that have a different keyname than that of the mapped column.</span>
            <span class="k">try</span><span class="p">:</span>
                <span class="n">prop</span> <span class="o">=</span> <span class="n">obj_mapper</span><span class="o">.</span><span class="n">get_property_by_column</span><span class="p">(</span><span class="n">obj_col</span><span class="p">)</span>
            <span class="k">except</span> <span class="n">UnmappedColumnError</span><span class="p">:</span>
                <span class="c"># in the case of single table inheritance, there may be</span>
                <span class="c"># columns on the mapped table intended for the subclass only.</span>
                <span class="c"># the &quot;unmapped&quot; status of the subclass column on the</span>
                <span class="c"># base class is a feature of the declarative module as of sqla 0.5.2.</span>
                <span class="k">continue</span>

            <span class="c"># expired object attributes and also deferred cols might not be in the</span>
            <span class="c"># dict.  force it to load no matter what by using getattr().</span>
            <span class="k">if</span> <span class="n">prop</span><span class="o">.</span><span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">obj_state</span><span class="o">.</span><span class="n">dict</span><span class="p">:</span>
                <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">prop</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>

            <span class="n">a</span><span class="p">,</span> <span class="n">u</span><span class="p">,</span> <span class="n">d</span> <span class="o">=</span> <span class="n">attributes</span><span class="o">.</span><span class="n">get_history</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">prop</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">d</span><span class="p">:</span>
                <span class="n">attr</span><span class="p">[</span><span class="n">hist_col</span><span class="o">.</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">d</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
                <span class="n">obj_changed</span> <span class="o">=</span> <span class="bp">True</span>
            <span class="k">elif</span> <span class="n">u</span><span class="p">:</span>
                <span class="n">attr</span><span class="p">[</span><span class="n">hist_col</span><span class="o">.</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">u</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="c"># if the attribute had no value.</span>
                <span class="n">attr</span><span class="p">[</span><span class="n">hist_col</span><span class="o">.</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
                <span class="n">obj_changed</span> <span class="o">=</span> <span class="bp">True</span>

    <span class="k">if</span> <span class="ow">not</span> <span class="n">obj_changed</span><span class="p">:</span>
        <span class="c"># not changed, but we have relationships.  OK</span>
        <span class="c"># check those too</span>
        <span class="k">for</span> <span class="n">prop</span> <span class="ow">in</span> <span class="n">obj_mapper</span><span class="o">.</span><span class="n">iterate_properties</span><span class="p">:</span>
            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">prop</span><span class="p">,</span> <span class="n">RelationshipProperty</span><span class="p">)</span> <span class="ow">and</span> \
                <span class="n">attributes</span><span class="o">.</span><span class="n">get_history</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">prop</span><span class="o">.</span><span class="n">key</span><span class="p">,</span>
                        <span class="n">passive</span><span class="o">=</span><span class="n">attributes</span><span class="o">.</span><span class="n">PASSIVE_NO_INITIALIZE</span><span class="p">)</span><span class="o">.</span><span class="n">has_changes</span><span class="p">():</span>
                <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">prop</span><span class="o">.</span><span class="n">local_columns</span><span class="p">:</span>
                    <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">foreign_keys</span><span class="p">:</span>
                        <span class="n">obj_changed</span> <span class="o">=</span> <span class="bp">True</span>
                        <span class="k">break</span>
                <span class="k">if</span> <span class="n">obj_changed</span> <span class="ow">is</span> <span class="bp">True</span><span class="p">:</span>
                    <span class="k">break</span>

    <span class="k">if</span> <span class="ow">not</span> <span class="n">obj_changed</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">deleted</span><span class="p">:</span>
        <span class="k">return</span>

    <span class="n">attr</span><span class="p">[</span><span class="s">&#39;version&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">version</span>
    <span class="n">hist</span> <span class="o">=</span> <span class="n">history_cls</span><span class="p">()</span>
    <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">attr</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
        <span class="nb">setattr</span><span class="p">(</span><span class="n">hist</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="n">session</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">hist</span><span class="p">)</span>
    <span class="n">obj</span><span class="o">.</span><span class="n">version</span> <span class="o">+=</span> <span class="mi">1</span>

<span class="k">def</span> <span class="nf">versioned_session</span><span class="p">(</span><span class="n">session</span><span class="p">):</span>
    <span class="nd">@event.listens_for</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="s">&#39;before_flush&#39;</span><span class="p">)</span>
    <span class="k">def</span> <span class="nf">before_flush</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">flush_context</span><span class="p">,</span> <span class="n">instances</span><span class="p">):</span>
        <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">versioned_objects</span><span class="p">(</span><span class="n">session</span><span class="o">.</span><span class="n">dirty</span><span class="p">):</span>
            <span class="n">create_version</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">session</span><span class="p">)</span>
        <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">versioned_objects</span><span class="p">(</span><span class="n">session</span><span class="o">.</span><span class="n">deleted</span><span class="p">):</span>
            <span class="n">create_version</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">deleted</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span></pre></div>
    </div>

</div>

<div id="docs-bottom-navigation" class="docs-navigation-links">

    <div id="docs-copyright">
        &copy; <a href="../../../copyright.html">Copyright</a> 2007-2014, the SQLAlchemy authors and contributors.
        Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.
    </div>
</div>

</div>

        
    </body>
</html>