forked from hakimel/reveal.js
-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathadvanced_features.html
554 lines (487 loc) · 21.1 KB
/
advanced_features.html
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Advanced Features of the API</title>
<meta name="description" content="Tips for advanced development">
<meta name="author" content="Raphael Collet">
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
<link rel="stylesheet" href="css/reveal.css">
<link rel="stylesheet" href="css/theme/odoo.css" id="theme">
<!-- Code syntax highlighting -->
<link rel="stylesheet" href="lib/css/zenburn.css">
<!-- Printing and PDF exports -->
<script>
var link = document.createElement( 'link' );
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = window.location.search.match( /print-pdf/gi ) ? 'css/print/pdf.css' : 'css/print/paper.css';
document.getElementsByTagName( 'head' )[0].appendChild( link );
</script>
<!--[if lt IE 9]>
<script src="lib/js/html5shiv.js"></script>
<![endif]-->
</head>
<body>
<div class="reveal">
<!-- Any section element inside of this container is displayed as a slide -->
<div class="slides">
<section class="title">
<h1>Advanced Features of the API</h1>
<h3>Raphael Collet ([email protected])</h3>
</section>
<section data-background="honey-bees.jpg">
<h2 style="color: white;">Topics</h2>
<p>Less known/misunderstood API features:
<ul>
<li>recordset operations</li>
<li>environment</li>
<li>record cache</li>
</ul>
</p>
</section>
<section class="nested">
<section>
<h2>Odoo 8.0: the Model API</h2>
<p>Reminder of the API essentials...</p>
<pre><code class="python" data-trim>
from openerp import models, fields, api
class Employee(models.Model):
_name = 'employee'
name = fields.Char(string="Name", required=True)
manager_id = fields.Many2one('employee', string="Manager")
active = fields.Boolean()
@api.multi
def fire(self):
self.write({'active': False})
</code></pre>
</section>
<section>
<h2>Recordsets</h2>
<p>
A recordset is a <em>collection</em> of records of a given model.<br/>
It is an instance of the model's class.
</p>
<pre><code class="python" data-trim>
size = len(records)
recs1 = records[:10]
recs2 = records[20:]
recs = recs1 + recs2
recs.write({'name': 'Joe'})
</code></pre>
<p>A single record is represented as a recordset of size 1.</p>
<pre><code class="python" data-trim>
for record in records:
assert type(record) == type(records)
print record.name
print len(record)
</code></pre>
</section>
<section>
<h2>Environments</h2>
<p>Recordsets are attached to an <em>environment</em>
and a sequence of record ids.</p>
<pre><code class="python" data-trim>
# list of record ids
records.ids
# environment with cr, uid, context
records._cr == records.env.cr
records._uid == records.env.uid
records._context == records.env.context
# access recordsets of another model
employees = records.env['employee'].search([])
</code></pre>
</section>
</section>
<section class="nested">
<section>
<h2>Old and new API</h2>
<p>A model's class has two kinds of instances: old-API
and new-API ones (recordsets).</p>
<pre><code class="python" data-trim>
# registry contains old API model instances
old_model = registry['employee']
# browse() returns a recordset (new API model instance)
employees = old_model.browse(cr, uid, ids, context)
assert employees == employees.browse(ids)
# attribute _model returns the old API model instance
assert old_model == employees._model
</code></pre>
</section>
</section>
<section class="nested">
<section>
<h2>Method decorators</h2>
<p>A wrapper to adapt the API of a <em>method call</em>
to the API of the <em>method's definition</em>.</p>
<pre><code class="python" data-trim>
from openerp import models, fields, api
# method definitions
@api.model @api.multi
def create(self, vals): def write(self, vals):
... ...
# calling methods with the old API
id = old_model.create(cr, uid, vals, context=context)
old_model.write(cr, uid, ids, vals, context=context)
# calling methods with the new API
employee = employees.create(vals)
employees.write(vals)
</code></pre>
</section>
<section>
<h2>Method decorators</h2>
<p>Specify return model:</p>
<pre><code class="python" data-trim>
@api.model
@api.returns('res.partner')
def get_default_partner(self):
return self.env.ref('base.main_partner')
# new API call returns a recordset
partner = records.get_default_partner()
# old API call returns a list of ids
partner_ids = old_model.get_default_partner(cr, uid, context)
</code></pre>
</section>
<section>
<h2>Method decorators</h2>
<p>Declare constraint methods:</p>
<pre><code class="python" data-trim>
@api.constrains('name')
def check_name(self):
for record in self:
if len(record.name) > 80:
raise ValueError("Name is too long: %r" % record.name)
</code></pre>
<p>The method is expected to raise an exception when the
constraint is not satisfied.</p>
</section>
<section>
<h2>Method decorators</h2>
<p>Declare onchange methods:</p>
<pre><code class="python" data-trim>
@api.onchange('name')
def onchange_name(self):
if self.name:
self.other_name = self.name.upper()
if len(self.name or "") > 40:
return {'warning': {
'title': _("Warning"),
'message': _("Name migh be a bit long"),
}}
</code></pre>
<p>"self" is a pseudo-record that only lives in cache.</p>
</section>
</section>
<section class="nested">
<section>
<h2>Computed Fields</h2>
<p>Those fields are determined by a method that assigns
their value on the given records.</p>
<pre><code class="python" data-trim>
from openerp import models, fields, api
class Employee(models.Model):
_inherit = 'employee'
title_id = fields.Many2one('employee.title', required=True)
fullname = fields.Char(compute='_compute_fullname')
@api.depends('title_id.name', 'name')
def _compute_fullname(self):
for emp in self:
emp.fullname = "%s %s" % (emp.title_id.name, emp.name)
</code></pre>
</section>
<section>
<h2>Computed Fields</h2>
<p>The inverse method modifies other fields based on the
computed field's value</p>
<pre><code class="python" data-trim>
fullname = fields.Char(compute='_compute_fullname',
inverse='_inverse_fullname')
@api.depends('title_id.name', 'name')
def _compute_fullname(self):
for emp in self:
emp.fullname = "%s %s" % (emp.title_id.name, emp.name)
def _inverse_fullname(self):
for emp in self:
emp.name = ... emp.fullname ...
</code></pre>
</section>
<section>
<h2>Computed Fields</h2>
<p>The search method transforms the domain condition
('fullname', operator, value) into another domain.</p>
<pre><code class="python" data-trim>
fullname = fields.Char(compute='_compute_fullname',
search='_search_fullname')
@api.depends('title_id.name', 'name')
def _compute_fullname(self):
for emp in self:
emp.fullname = "%s %s" % (emp.title_id.name, emp.name)
def _search_fullname(self, operator, value):
return ['|', ('title_id.name', operator, value),
('name', operator, value)]
</code></pre>
</section>
</section>
<section class="nested">
<section>
<h2>Recordset operations</h2>
<p>Combine and compare recordsets:</p>
<pre><code class="python" data-trim>
records[42] # indexing or slicing (ordered)
records1 + records2 # concatenation (ordered)
records1 - records2 # difference (ordered)
records1 & records2 # set intersection (unordered)
records1 | records2 # set union (unordered)
record in records # test membership
records1 < records2 # set inclusion (unordered)
records1 == records2 # set equivalence (unordered)
</code></pre>
</section>
<section>
<h2>Recordset operations</h2>
<p>Mapping, filtering, sorting:</p>
<pre><code class="python" data-trim>
# return a list of strings, like map() would do
records.mapped(lambda rec: rec.name)
records.mapped('name')
# return a recordset of res.partner
records.mapped(lambda rec: rec.partner_id)
records.mapped('partner_id')
# always return recordsets
records.filtered(lambda rec: rec.active)
records.sorted(key=lambda rec: rec.sequence)
</code></pre>
</section>
<section>
<h2>Binding to Environment</h2>
<p>Attach a recordset to another environment:</p>
<pre><code class="python" data-trim>
others = records.with_env(env)
assert others.ids == records.ids
assert others.env is env
# switch user
records.sudo(uid) # integer
records.sudo(user) # user record
records.sudo() # defaults to SUPERUSER_ID
# switch or extend records' context
records.with_context(context)
records.with_context(extra="stuff")
</code></pre>
<p>Beware: avoid them in loops.</p>
</section>
</section>
<section class="nested">
<section>
<h2>The record cache</h2>
<ul>
<li>Stores field values for records.
<pre><code class="python" data-trim>
record.name
record._cache['name']
record.env.cache[field][record.id]
</code></pre>
</li>
<li>Every environment has its <em>own</em> cache.
<ul>
<li>Cache contents depends on environment.</li>
</ul>
</li>
<li>Cache <em>prefetching</em> when accessing a field for
the first time:
<ul>
<li>prefetches records browsed in the same environment;</li>
<li>prefetches fields from the same table.</li>
</ul>
</li>
</ul>
</section>
<section>
<h2>How prefetching works</h2>
<pre><code class="python" data-trim>
# no database access # (env.cache)
orders = env['sale.order'].browse(ids) # ids
# no database access
order = orders[0] # ids
# prefetch order ids
partner = order.partner_id # data(ids), pids
# prefetch partner pids
name = partner.name # data(ids), data(pids)
# no database access
orders[-1].partner_id.name # data(ids), data(pids)
</code></pre>
</section>
<section>
<h2>Issue <a href="https://github.com/odoo/odoo/issues/6276">#6276</a></h2>
<p>Overridden computed field method:</p>
<pre><code class="python" data-trim>
# Module 1
stuff = fields.Integer(compute='_get_stuff')
@api.one
def _get_stuff(self):
self.stuff = self._context.get('stuff', 0)
</code></pre>
<pre><code class="python" data-trim>
# Module 2
@api.one
def _get_stuff(self):
other = self.with_context(stuff=42)
super(Class, other)._get_stuff()
</code></pre>
<p>This raises a KeyError when getting the value...</p>
</section>
<section>
<h2>Issue <a href="https://github.com/odoo/odoo/issues/6276">#6276</a>: Solution</h2>
<p>The record "other" uses another cache than "self".</p>
<p>Simply copy result to the expected cache:</p>
<pre><code class="python" data-trim>
# Module 2
@api.one
def _get_stuff(self):
other = self.with_context(stuff=42)
# determine other.stuff in other's cache
super(Class, other)._get_stuff()
# copy result from other's cache to self's cache
self.stuff = other.stuff
</code></pre>
</section>
<section>
<h2>Bad prefetching</h2>
<p>"Prefetch records browsed in the same environment."</p>
<pre><code class="python" data-trim>
# retrieve a list of (name, id)
action_ids = []
for ... in ...:
# some query... -> name, id
action_ids.append((name, id))
# process action_ids id by id
for name, id in action_ids:
record = self.env[model].browse(id)
if record.partner_id ...:
...
</code></pre>
<p>The second loop issues O(n) queries.</p>
</section>
<section>
<h2>Good prefetching</h2>
<p>Browse all records <em>before</em> accessing their fields.</p>
<pre><code class="python" data-trim>
# retrieve a list of (name, record)
action_records = []
for ... in ...:
# some query... -> name, id
record = self.env[model].browse(id)
action_records.append((name, record))
# process action_records id by id
for name, record in action_records:
if record.partner_id ...:
...
</code></pre>
<p>The second loop issues O(1) queries.</p>
</section>
</section>
<section class="nested">
<section>
<h2>The "ormcache"</h2>
<ul>
<li>Memoize results for a given method.</li>
<li>Attached to the registry (database-specific).</li>
<li>Explicitly invalidated (multi-worker invalidation).</li>
</ul>
<pre><code class="python" data-trim>
from openerp.tools import ormcache
class decimal_precision(models.Model):
@ormcache(skiparg=3)
def precision_get(self, cr, uid, application):
...
def create(self, cr, uid, vals, context=None):
res = ...
self.clear_caches()
return res
</code></pre>
</section>
<section>
<h2>What to ormcache?</h2>
<ul>
<li>For stuff that rarely changes between requests:
<ul>
<li>user permissions on models</li>
<li>XML views after inheritance</li>
</ul>
</li>
<li>Beware of what the cached value depends on:
<ul>
<li>uid, context</li>
<li>other parameters</li>
</ul>
</li>
<li>Cached value cannot refer to transaction-specific data:
<ul>
<li>records</li>
<li>environments</li>
</ul>
</li>
</ul>
</section>
<section>
<h2>Ormcache API</h2>
<p>V8: skiparg (kind of positional dependencies)</p>
<pre><code class="python" data-trim>
@ormcache(skiparg=3)
def precision_get(self, cr, uid, application):
...
</code></pre>
<p>V9: name functional dependencies (expressions)</p>
<pre><code class="python" data-trim>
@ormcache('application')
def precision_get(self, cr, uid, application):
...
</code></pre>
</section>
</section>
<section class="title">
<h1><span>Thank you</span></h1>
<h3>Raphael Collet ([email protected])</h3>
<div style="width: 32%; display: inline-block; vertical-align: text-top; font-size: 60%">
<b>Odoo</b><br/>
[email protected]<br/>
www.odoo.com
</div>
<div style="width: 32%; display: inline-block; vertical-align: text-top; font-size: 60%">
<b>R&D and Services office</b><br/>
Chaussée de Namur 40</br>
B-1367 Grand-Rosière
</div>
<div style="width: 32%; display: inline-block; vertical-align: text-top; font-size: 60%">
<b>Sales office</b><br/>
Avenue Van Nieuwenhuyse 5</br>
B-1160 Brussels
</div>
</section>
</div>
</div>
<script src="lib/js/head.min.js"></script>
<script src="js/reveal.js"></script>
<script>
// Full list of configuration options available at:
// https://github.com/hakimel/reveal.js#configuration
Reveal.initialize({
controls: true,
progress: true,
history: true,
center: false,
transition: 'slide', // none/fade/slide/convex/concave/zoom
// Optional reveal.js plugins
dependencies: [
{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },
{ src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
{ src: 'plugin/highlight/highlight.js', async: true, condition: function() { return !!document.querySelector( 'pre code' ); }, callback: function() { hljs.initHighlightingOnLoad(); } },
{ src: 'plugin/zoom-js/zoom.js', async: true },
{ src: 'plugin/notes/notes.js', async: true }
]
});
</script>
</body>
</html>