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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
# -*- coding: utf-8 -*-
##############################################################################
#
# Author: Guewen Baconnier
# Copyright 2013 Camptocamp SA
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
"""
Mappers
=======
Mappers are the ConnectorUnit classes responsible to transform
external records into OpenERP records and conversely.
"""
import logging
from collections import namedtuple
from contextlib import contextmanager
from openerp import models
from ..connector import ConnectorUnit, MetaConnectorUnit, ConnectorEnvironment
from ..exception import MappingError, NoConnectorUnitError
_logger = logging.getLogger(__name__)
def mapping(func):
""" Declare that a method is a mapping method.
It is then used by the :py:class:`Mapper` to convert the records.
Usage::
@mapping
def any(self, record):
return {'output_field': record['input_field']}
"""
func.is_mapping = True
return func
def changed_by(*args):
""" Decorator for the mapping methods (:py:func:`mapping`)
When fields are modified in OpenERP, we want to export only the
modified fields. Using this decorator, we can specify which fields
updates should trigger which mapping method.
If ``changed_by`` is empty, the mapping is always active.
As far as possible, this decorator should be used for the exports,
thus, when we do an update on only a small number of fields on a
record, the size of the output record will be limited to only the
fields really having to be exported.
Usage::
@changed_by('input_field')
@mapping
def any(self, record):
return {'output_field': record['input_field']}
:param *args: field names which trigger the mapping when modified
"""
def register_mapping(func):
func.changed_by = args
return func
return register_mapping
def only_create(func):
""" Decorator for the mapping methods (:py:func:`mapping`)
A mapping decorated with ``only_create`` means that it has to be
used only for the creation of the records.
Usage::
@only_create
@mapping
def any(self, record):
return {'output_field': record['input_field']}
"""
func.only_create = True
return func
def none(field):
""" A modifier intended to be used on the ``direct`` mappings.
Replace the False-ish values by None.
It can be used in a pipeline of modifiers when .
Example::
direct = [(none('source'), 'target'),
(none(m2o_to_backend('rel_id'), 'rel_id')]
:param field: name of the source field in the record
:param binding: True if the relation is a binding record
"""
def modifier(self, record, to_attr):
if callable(field):
result = field(self, record, to_attr)
else:
result = record[field]
if not result:
return None
return result
return modifier
def convert(field, conv_type):
""" A modifier intended to be used on the ``direct`` mappings.
Convert a field's value to a given type.
Example::
direct = [(convert('source', str), 'target')]
:param field: name of the source field in the record
:param binding: True if the relation is a binding record
"""
def modifier(self, record, to_attr):
value = record[field]
if not value:
return False
return conv_type(value)
return modifier
def m2o_to_backend(field, binding=None):
""" A modifier intended to be used on the ``direct`` mappings.
For a many2one, get the ID on the backend and returns it.
When the field's relation is not a binding (i.e. it does not point to
something like ``magento.*``), the binding model needs to be provided
in the ``binding`` keyword argument.
Example::
direct = [(m2o_to_backend('country_id', binding='magento.res.country'),
'country'),
(m2o_to_backend('magento_country_id'), 'country')]
:param field: name of the source field in the record
:param binding: name of the binding model is the relation is not a binding
"""
def modifier(self, record, to_attr):
if not record[field]:
return False
column = self.model._fields[field]
if column.type != 'many2one':
raise ValueError('The column %s should be a Many2one, got %s' %
(field, type(column)))
rel_id = record[field].id
if binding is None:
binding_model = column.comodel_name
else:
binding_model = binding
binder = self.binder_for(binding_model)
# if a relation is not a binding, we wrap the record in the
# binding, we'll return the id of the binding
wrap = bool(binding)
value = binder.to_backend(rel_id, wrap=wrap)
if not value:
raise MappingError("Can not find an external id for record "
"%s in model %s %s wrapping" %
(rel_id, binding_model,
'with' if wrap else 'without'))
return value
return modifier
def backend_to_m2o(field, binding=None):
""" A modifier intended to be used on the ``direct`` mappings.
For a field from a backend which is an ID, search the corresponding
binding in OpenERP and returns its ID.
When the field's relation is not a binding (i.e. it does not point to
something like ``magento.*``), the binding model needs to be provided
in the ``binding`` keyword argument.
Example::
direct = [(backend_to_m2o('country', binding='magento.res.country'),
'country_id'),
(backend_to_m2o('country'), 'magento_country_id')]
:param field: name of the source field in the record
:param binding: name of the binding model is the relation is not a binding
"""
def modifier(self, record, to_attr):
if not record[field]:
return False
column = self.model._fields[to_attr]
if column.type != 'many2one':
raise ValueError('The column %s should be a Many2one, got %s' %
(to_attr, type(column)))
rel_id = record[field]
if binding is None:
binding_model = column.comodel_name
else:
binding_model = binding
binder = self.binder_for(binding_model)
# if we want the normal record, not a binding,
# we ask to the binder to unwrap the binding
unwrap = bool(binding)
with self.session.change_context(active_test=False):
record = binder.to_openerp(rel_id, unwrap=unwrap)
if not record:
raise MappingError("Can not find an existing %s for external "
"record %s %s unwrapping" %
(binding_model, rel_id,
'with' if unwrap else 'without'))
if isinstance(record, models.BaseModel):
return record.id
else:
_logger.debug(
'Binder for %s returned an id, '
'returning a record should be preferred.', binding_model
)
return record
return modifier
def follow_m2o_relations(field):
"""A modifier intended to be used on ``direct`` mappings.
'Follows' Many2one relations and return the final field value.
Examples:
Assuming model is ``product.product``::
direct = [
(follow_m2o_relations('product_tmpl_id.categ_id.name'), 'cat')]
:param field: field "path", using dots for relations as usual in Odoo
"""
def modifier(self, record, to_attr):
attrs = field.split('.')
value = record
for attr in attrs:
value = getattr(value, attr)
return value
return modifier
MappingDefinition = namedtuple('MappingDefinition',
['changed_by',
'only_create'])
class MetaMapper(MetaConnectorUnit):
""" Metaclass for Mapper
Build a ``_map_methods`` dict of mappings methods.
The keys of the dict are the method names.
The values of the dict are a namedtuple containing:
"""
def __new__(meta, name, bases, attrs):
if attrs.get('_map_methods') is None:
attrs['_map_methods'] = {}
cls = super(MetaMapper, meta).__new__(meta, name, bases, attrs)
# When a class has several bases: ``class Mapper(Base1, Base2):``
for base in bases:
# Merge the _map_methods of the bases
base_map_methods = getattr(base, '_map_methods', {})
for attr_name, definition in base_map_methods.iteritems():
if cls._map_methods.get(attr_name) is None:
cls._map_methods[attr_name] = definition
else:
# Update the existing @changed_by with the content
# of each base (it is mutated in place).
# @only_create keeps the value defined in the first
# base.
mapping_changed_by = cls._map_methods[attr_name].changed_by
mapping_changed_by.update(definition.changed_by)
# Update the _map_methods from the @mapping methods in attrs,
# respecting the class tree.
for attr_name, attr in attrs.iteritems():
is_mapping = getattr(attr, 'is_mapping', None)
if is_mapping:
has_only_create = getattr(attr, 'only_create', False)
mapping_changed_by = set(getattr(attr, 'changed_by', ()))
# If already existing, it has been defined in a super
# class, extend the @changed_by set
if cls._map_methods.get(attr_name) is not None:
definition = cls._map_methods[attr_name]
mapping_changed_by.update(definition.changed_by)
# keep the last choice for only_create
definition = MappingDefinition(mapping_changed_by,
has_only_create)
cls._map_methods[attr_name] = definition
return cls
def __init__(cls, name, bases, attrs):
"""
Build a ``_changed_by_fields`` list of synchronized fields with mapper.
It takes in account the ``direct`` fields and the fields declared in
the decorator : ``changed_by``.
"""
changed_by_fields = set()
if attrs.get('direct'):
for from_attr, __ in attrs['direct']:
attr_name = cls._direct_source_field_name(from_attr)
changed_by_fields.add(attr_name)
for method_name, method_def in attrs['_map_methods'].iteritems():
changed_by_fields |= method_def[0]
for base in bases:
if hasattr(base, '_changed_by_fields') and base._changed_by_fields:
changed_by_fields |= base._changed_by_fields
cls._changed_by_fields = changed_by_fields
super(MetaMapper, cls).__init__(name, bases, attrs)
@staticmethod
def _direct_source_field_name(mapping_attr):
""" Get the mapping field name. Goes through the function modifiers.
Ex: [(none(convert(field_name, str)), out_field_name)]
It assumes that the modifier has ``field`` as first argument like:
def modifier(field, args):
"""
attr_name = mapping_attr
if callable(mapping_attr):
# Map the closure entries with variable names
cells = dict(zip(
mapping_attr.func_code.co_freevars,
(c.cell_contents for c in mapping_attr.func_closure)))
assert 'field' in cells, "Modifier without 'field' argument."
if callable(cells['field']):
attr_name = MetaMapper._direct_source_field_name(
cells['field'])
else:
attr_name = cells['field']
return attr_name
class MapChild(ConnectorUnit):
""" MapChild is responsible to convert items.
Items are sub-records of a main record.
In this example, the items are the records in ``lines``::
sales = {'name': 'SO10',
'lines': [{'product_id': 1, 'quantity': 2},
{'product_id': 2, 'quantity': 2}]}
A MapChild is always called from another :py:class:`Mapper` which
provides a ``children`` configuration.
Considering the example above, the "main" :py:class:`Mapper` would
returns something as follows::
{'name': 'SO10',
'lines': [(0, 0, {'product_id': 11, 'quantity': 2}),
(0, 0, {'product_id': 12, 'quantity': 2})]}
A MapChild is responsible to:
* Find the :py:class:`Mapper` to convert the items
* Possibly filter out some lines (can be done by inheriting
:py:meth:`skip_item`)
* Convert the items' records using the found :py:class:`Mapper`
* Format the output values to the format expected by OpenERP or the
backend (as seen above with ``(0, 0, {values})``
A MapChild can be extended like any other
:py:class:`~connector.connector.ConnectorUnit`.
However, it is not mandatory to explicitly create a MapChild for
each children mapping, the default one will be used
(:py:class:`ImportMapChild` or :py:class:`ExportMapChild`).
The implementation by default does not take care of the updates: if
I import a sales order 2 times, the lines will be duplicated. This
is not a problem as long as an importation should only support the
creation (typical for sales orders). It can be implemented on a
case-by-case basis by inheriting :py:meth:`get_item_values` and
:py:meth:`format_items`.
"""
_model_name = None
def _child_mapper(self):
raise NotImplementedError
def skip_item(self, map_record):
""" Hook to implement in sub-classes when some child
records should be skipped.
The parent record is accessible in ``map_record``.
If it returns True, the current child record is skipped.
:param map_record: record that we are converting
:type map_record: :py:class:`MapRecord`
"""
return False
def get_items(self, items, parent, to_attr, options):
""" Returns the formatted output values of items from a main record
:param items: list of item records
:type items: list
:param parent: parent record
:param to_attr: destination field (can be used for introspecting
the relation)
:type to_attr: str
:param options: dict of options, herited from the main mapper
:return: formatted output values for the item
"""
mapper = self._child_mapper()
mapped = []
for item in items:
map_record = mapper.map_record(item, parent=parent)
if self.skip_item(map_record):
continue
mapped.append(self.get_item_values(map_record, to_attr, options))
return self.format_items(mapped)
def get_item_values(self, map_record, to_attr, options):
""" Get the raw values from the child Mappers for the items.
It can be overridden for instance to:
* Change options
* Use a :py:class:`~connector.connector.Binder` to know if an
item already exists to modify an existing item, rather than to
add it
:param map_record: record that we are converting
:type map_record: :py:class:`MapRecord`
:param to_attr: destination field (can be used for introspecting
the relation)
:type to_attr: str
:param options: dict of options, herited from the main mapper
"""
return map_record.values(**options)
def format_items(self, items_values):
""" Format the values of the items mapped from the child Mappers.
It can be overridden for instance to add the OpenERP
relationships commands ``(6, 0, [IDs])``, ...
As instance, it can be modified to handle update of existing
items: check if an 'id' has been defined by
:py:meth:`get_item_values` then use the ``(1, ID, {values}``)
command
:param items_values: mapped values for the items
:type items_values: list
"""
return items_values
class ImportMapChild(MapChild):
""" :py:class:`MapChild` for the Imports """
def _child_mapper(self):
return self.unit_for(ImportMapper)
def format_items(self, items_values):
""" Format the values of the items mapped from the child Mappers.
It can be overridden for instance to add the OpenERP
relationships commands ``(6, 0, [IDs])``, ...
As instance, it can be modified to handle update of existing
items: check if an 'id' has been defined by
:py:meth:`get_item_values` then use the ``(1, ID, {values}``)
command
:param items_values: list of values for the items to create
:type items_values: list
"""
return [(0, 0, values) for values in items_values]
class ExportMapChild(MapChild):
""" :py:class:`MapChild` for the Exports """
def _child_mapper(self):
return self.unit_for(ExportMapper)
class Mapper(ConnectorUnit):
""" A Mapper translates an external record to an OpenERP record and
conversely. The output of a Mapper is a ``dict``.
3 types of mappings are supported:
Direct Mappings
Example::
direct = [('source', 'target')]
Here, the ``source`` field will be copied in the ``target`` field.
A modifier can be used in the source item.
The modifier will be applied to the source field before being
copied in the target field.
It should be a closure function respecting this idiom::
def a_function(field):
''' ``field`` is the name of the source field.
Naming the arg: ``field`` is required for the conversion'''
def modifier(self, record, to_attr):
''' self is the current Mapper,
record is the current record to map,
to_attr is the target field'''
return record[field]
return modifier
And used like that::
direct = [
(a_function('source'), 'target'),
]
A more concrete example of modifier::
def convert(field, conv_type):
''' Convert the source field to a defined ``conv_type``
(ex. str) before returning it'''
def modifier(self, record, to_attr):
value = record[field]
if not value:
return None
return conv_type(value)
return modifier
And used like that::
direct = [
(convert('myfield', float), 'target_field'),
]
More examples of modifiers:
* :py:func:`convert`
* :py:func:`m2o_to_backend`
* :py:func:`backend_to_m2o`
Method Mappings
A mapping method allows to execute arbitrary code and return one
or many fields::
@mapping
def compute_state(self, record):
# compute some state, using the ``record`` or not
state = 'pending'
return {'state': state}
We can also specify that a mapping methods should be applied
only when an object is created, and never applied on further
updates::
@only_create
@mapping
def default_warehouse(self, record):
# get default warehouse
warehouse_id = ...
return {'warehouse_id': warehouse_id}
Submappings
When a record contains sub-items, like the lines of a sales order,
we can convert the children using another Mapper::
children = [('items', 'line_ids', 'model.name')]
It allows to create the sales order and all its lines with the
same call to :py:meth:`openerp.models.BaseModel.create()`.
When using ``children`` for items of a record, we need to create
a :py:class:`Mapper` for the model of the items, and optionally a
:py:class:`MapChild`.
Usage of a Mapper::
mapper = Mapper(env)
map_record = mapper.map_record(record)
values = map_record.values()
values = map_record.values(only_create=True)
values = map_record.values(fields=['name', 'street'])
"""
__metaclass__ = MetaMapper
# name of the OpenERP model, to be defined in concrete classes
_model_name = None
direct = [] # direct conversion of a field to another (from_attr, to_attr)
children = [] # conversion of sub-records (from_attr, to_attr, model)
_map_methods = None
_map_child_class = None
def __init__(self, connector_env):
"""
:param connector_env: current environment (backend, session, ...)
:type connector_env: :py:class:`connector.connector.Environment`
"""
super(Mapper, self).__init__(connector_env)
self._options = None
def _map_direct(self, record, from_attr, to_attr):
""" Apply the ``direct`` mappings.
:param record: record to convert from a source to a target
:param from_attr: name of the source attribute or a callable
:type from_attr: callable | str
:param to_attr: name of the target attribute
:type to_attr: str
"""
raise NotImplementedError
def _map_children(self, record, attr, model):
raise NotImplementedError
@property
def map_methods(self):
""" Yield all the methods decorated with ``@mapping`` """
for meth, definition in self._map_methods.iteritems():
yield getattr(self, meth), definition
def _get_map_child_unit(self, model_name):
try:
mapper_child = self.unit_for(self._map_child_class,
model=model_name)
except NoConnectorUnitError:
# does not force developers to use a MapChild ->
# will use the default one if not explicitely defined
env = ConnectorEnvironment(self.backend_record,
self.session,
model_name)
mapper_child = self._map_child_class(env)
return mapper_child
def _map_child(self, map_record, from_attr, to_attr, model_name):
""" Convert items of the record as defined by children """
assert self._map_child_class is not None, "_map_child_class required"
child_records = map_record.source[from_attr]
mapper_child = self._get_map_child_unit(model_name)
items = mapper_child.get_items(child_records, map_record,
to_attr, options=self.options)
return items
@contextmanager
def _mapping_options(self, options):
""" Change the mapping options for the Mapper.
Context Manager to use in order to alter the behavior
of the mapping, when using ``_apply`` or ``finalize``.
"""
current = self._options
self._options = options
yield
self._options = current
@property
def options(self):
""" Options can be accessed in the mapping methods with
``self.options``. """
return self._options
def map_record(self, record, parent=None):
""" Get a :py:class:`MapRecord` with record, ready to be
converted using the current Mapper.
:param record: record to transform
:param parent: optional parent record, for items
"""
return MapRecord(self, record, parent=parent)
def _apply(self, map_record, options=None):
""" Apply the mappings on a :py:class:`MapRecord`
:param map_record: source record to convert
:type map_record: :py:class:`MapRecord`
"""
if options is None:
options = {}
with self._mapping_options(options):
return self._apply_with_options(map_record)
def _apply_with_options(self, map_record):
""" Apply the mappings on a :py:class:`MapRecord` with
contextual options (the ``options`` given in
:py:meth:`MapRecord.values()` are accessible in
``self.options``)
:param map_record: source record to convert
:type map_record: :py:class:`MapRecord`
"""
assert self.options is not None, (
"options should be defined with '_mapping_options'")
_logger.debug('converting record %s to model %s',
map_record.source, self.model)
fields = self.options.fields
for_create = self.options.for_create
result = {}
for from_attr, to_attr in self.direct:
if callable(from_attr):
attr_name = MetaMapper._direct_source_field_name(from_attr)
else:
attr_name = from_attr
if (not fields or attr_name in fields):
value = self._map_direct(map_record.source,
from_attr,
to_attr)
result[to_attr] = value
for meth, definition in self.map_methods:
mapping_changed_by = definition.changed_by
if (not fields or not mapping_changed_by or
mapping_changed_by.intersection(fields)):
if definition.only_create and not for_create:
continue
values = meth(map_record.source)
if not values:
continue
if not isinstance(values, dict):
raise ValueError('%s: invalid return value for the '
'mapping method %s' % (values, meth))
result.update(values)
for from_attr, to_attr, model_name in self.children:
if (not fields or from_attr in fields):
result[to_attr] = self._map_child(map_record, from_attr,
to_attr, model_name)
return self.finalize(map_record, result)
def finalize(self, map_record, values):
""" Called at the end of the mapping.
Can be used to modify the values before returning them, as the
``on_change``.
:param map_record: source map_record
:type map_record: :py:class:`MapRecord`
:param values: mapped values
:returns: mapped values
:rtype: dict
"""
return values
class ImportMapper(Mapper):
""" :py:class:`Mapper` for imports.
Transform a record from a backend to an OpenERP record
"""
_map_child_class = ImportMapChild
def _map_direct(self, record, from_attr, to_attr):
""" Apply the ``direct`` mappings.
:param record: record to convert from a source to a target
:param from_attr: name of the source attribute or a callable
:type from_attr: callable | str
:param to_attr: name of the target attribute
:type to_attr: str
"""
if callable(from_attr):
return from_attr(self, record, to_attr)
value = record.get(from_attr)
if not value:
return False
# Backward compatibility: when a field is a relation, and a modifier is
# not used, we assume that the relation model is a binding.
# Use an explicit modifier backend_to_m2o in the 'direct' mappings to
# change that.
field = self.model._fields[to_attr]
if field.type == 'many2one':
mapping_func = backend_to_m2o(from_attr)
value = mapping_func(self, record, to_attr)
return value
class ExportMapper(Mapper):
""" :py:class:`Mapper` for exports.
Transform a record from OpenERP to a backend record
"""
_map_child_class = ExportMapChild
def _map_direct(self, record, from_attr, to_attr):
""" Apply the ``direct`` mappings.
:param record: record to convert from a source to a target
:param from_attr: name of the source attribute or a callable
:type from_attr: callable | str
:param to_attr: name of the target attribute
:type to_attr: str
"""
if callable(from_attr):
return from_attr(self, record, to_attr)
value = record[from_attr]
if not value:
return False
# Backward compatibility: when a field is a relation, and a modifier is
# not used, we assume that the relation model is a binding.
# Use an explicit modifier m2o_to_backend in the 'direct' mappings to
# change that.
field = self.model._fields[from_attr]
if field.type == 'many2one':
mapping_func = m2o_to_backend(from_attr)
value = mapping_func(self, record, to_attr)
return value
class MapRecord(object):
""" A record prepared to be converted using a :py:class:`Mapper`.
MapRecord instances are prepared by :py:meth:`Mapper.map_record`.
Usage::
mapper = SomeMapper(env)
map_record = mapper.map_record(record)
output_values = map_record.values()
See :py:meth:`values` for more information on the available arguments.
"""
def __init__(self, mapper, source, parent=None):
self._source = source
self._mapper = mapper
self._parent = parent
self._forced_values = {}
@property
def source(self):
""" Source record to be converted """
return self._source
@property
def parent(self):
""" Parent record if the current record is an item """
return self._parent
def values(self, for_create=None, fields=None, **kwargs):
""" Build and returns the mapped values according to the options.
Usage::
mapper = SomeMapper(env)
map_record = mapper.map_record(record)
output_values = map_record.values()
Creation of records
When using the option ``for_create``, only the mappings decorated
with ``@only_create`` will be mapped.
::
output_values = map_record.values(for_create=True)
Filter on fields
When using the ``fields`` argument, the mappings will be
filtered using either the source key in ``direct`` arguments,
either the ``changed_by`` arguments for the mapping methods.
::
output_values = map_record.values(fields=['name', 'street'])
Custom options
Arbitrary key and values can be defined in the ``kwargs``
arguments. They can later be used in the mapping methods
using ``self.options``.
::
output_values = map_record.values(tax_include=True)
:param for_create: specify if only the mappings for creation
(``@only_create``) should be mapped.
:type for_create: boolean
:param fields: filter on fields
:type fields: list
:param **kwargs: custom options, they can later be used in the
mapping methods
"""
options = MapOptions(for_create=for_create, fields=fields, **kwargs)
values = self._mapper._apply(self, options=options)
values.update(self._forced_values)
return values
def update(self, *args, **kwargs):
""" Force values to be applied after a mapping.
Usage::
mapper = SomeMapper(env)
map_record = mapper.map_record(record)
map_record.update(a=1)
output_values = map_record.values()
# output_values will at least contain {'a': 1}
The values assigned with ``update()`` are in any case applied,
they have a greater priority than the mapping values.
"""
self._forced_values.update(*args, **kwargs)
class MapOptions(dict):
""" Container for the options of mappings.
Options can be accessed using attributes of the instance. When an
option is accessed and does not exist, it returns None.
"""
def __getitem__(self, key):
try:
return super(MapOptions, self).__getitem__(key)
except KeyError:
return None
def __getattr__(self, key):
return self[key]
def __setattr__(self, key, value):
self[key] = value