copy_frame handles default values now (fix #430)

Author: ebroecker

src/canmatrix/copy.py

@@ -170,13 +170,16 @@ def copy_frame(frame_id, source_db, target_db):
                     copy_ecu(source_ecu, source_db, target_db)
 
         # copy all frame-defines
-        attributes = frame.attributes
-        for attribute in attributes:
+        for attribute in source_db.frame_defines:
             if attribute not in target_db.frame_defines:
                 target_db.add_frame_defines(
                     copy.deepcopy(attribute), copy.deepcopy(source_db.frame_defines[attribute].definition))
                 target_db.add_define_default(
                     copy.deepcopy(attribute), copy.deepcopy(source_db.frame_defines[attribute].defaultValue))
+            # only default value exists in source but is different to default value in target
+            if attribute not in frame.attributes and \
+                    frame.attribute(attribute, source_db) != frame.attribute(attribute, target_db):
+                target_db.frame_by_id(frame.arbitration_id).add_attribute(attribute, frame.attribute(attribute, source_db))
             # update enum data types if needed:
             if source_db.frame_defines[attribute].type == 'ENUM':
                 temp_attr = frame.attribute(attribute, db=source_db)
@@ -187,7 +190,7 @@ def copy_frame(frame_id, source_db, target_db):
         # trigger all signals of Frame
         for sig in frame.signals:
             # delete all 'unknown' attributes
-            for attribute in sig.attributes:
+            for attribute in source_db.signal_defines:
                 target_db.add_signal_defines(
                     copy.deepcopy(attribute), copy.deepcopy(source_db.signal_defines[attribute].definition))
                 target_db.add_define_default(
@@ -198,5 +201,9 @@ def copy_frame(frame_id, source_db, target_db):
                     if temp_attr not in target_db.signal_defines[attribute].values:
                         target_db.signal_defines[attribute].values.append(copy.deepcopy(temp_attr))
                         target_db.signal_defines[attribute].update()
+            # only default value exists in source but is different to default value in target
+            if attribute not in sig.attributes and \
+                    sig.attribute(attribute, source_db) != sig.attribute(attribute, target_db):
+                target_db.frame_by_id(frame.arbitration_id).signal_by_name(sig.name).add_attribute(attribute, sig.attribute(attribute, source_db))
 
     return True

src/canmatrix/formats/dbc.py

@@ -509,7 +509,7 @@ def add_frame_by_id(new_frame):  # type: (canmatrix.Frame) -> None
                     comment += "\n" + l.decode(dbc_comment_encoding).replace('\\"', '"')
                 except:
                     logger.error("Error decoding line: %d (%s)" % (i, line))
-                if re.match('.*" *;\Z',l.decode(dbc_import_encoding).strip()) is not None:
+                if re.match(r'.*" *;\Z',l.decode(dbc_import_encoding).strip()) is not None:
                     follow_up = _FollowUps.NOTHING
                     if signal is not None:
                         signal.add_comment(comment[:-1].strip()[:-1])
@@ -519,7 +519,7 @@ def add_frame_by_id(new_frame):  # type: (canmatrix.Frame) -> None
                     comment += "\n" + l.decode(dbc_comment_encoding).replace('\\"', '"')
                 except:
                     logger.error("Error decoding line: %d (%s)" % (i, line))
-                if re.match('.*" *;\Z',l.decode(dbc_import_encoding).strip()) is not None:
+                if re.match(r'.*" *;\Z',l.decode(dbc_import_encoding).strip()) is not None:
                     follow_up = _FollowUps.NOTHING
                     if frame is not None:
                         frame.add_comment(comment[:-1].strip()[:-1])
@@ -530,7 +530,7 @@ def add_frame_by_id(new_frame):  # type: (canmatrix.Frame) -> None
                         l.decode(dbc_comment_encoding).replace('\\"', '"')
                 except:
                     logger.error("Error decoding line: %d (%s)" % (i, line))
-                if re.match('.*" *;\Z',l.decode(dbc_import_encoding).strip()) is not None:
+                if re.match(r'.*" *;\Z',l.decode(dbc_import_encoding).strip()) is not None:
                     follow_up = _FollowUps.NOTHING
                     if board_unit is not None:
                         board_unit.add_comment(comment[:-1].strip()[:-1])

src/canmatrix/tests/test_copy.py

@@ -75,3 +75,31 @@ def test_copy_ecu_with_attributes():
     assert len(matrix1.ecus) == 1
     assert matrix1.ecu_by_name("ECU") is not None
     assert matrix1.ecu_by_name("ECU").attribute("Node Address") == 42
+
+def test_copy_frame_default_attributes():
+    source = canmatrix.canmatrix.CanMatrix()
+    frame1 = canmatrix.canmatrix.Frame("Frame1", arbitration_id=1)
+    signal = canmatrix.canmatrix.Signal("Signal1")
+    frame1.add_signal(canmatrix.canmatrix.Signal("SomeSignal"))
+    frame1.add_signal(signal)
+    source.add_frame(frame1)
+    source.add_frame_defines("some_attribute", "STRING")
+    source.add_define_default("some_attribute", "source_frame_default")
+    source.add_signal_defines("some_signal_attribute", "STRING")
+    source.add_define_default("some_signal_attribute", "source_sig_default")
+
+    #test if default value only defined in source and copied to target
+    target = canmatrix.canmatrix.CanMatrix()
+    canmatrix.copy.copy_frame(frame1.arbitration_id, source, target)
+    assert target.frames[0].attribute("some_attribute", target) == "source_frame_default"
+    assert target.frames[0].signals[0].attribute("some_signal_attribute", target) == "source_sig_default"
+
+    # test if define already exists, but has another default value:
+    target2 = canmatrix.canmatrix.CanMatrix()
+    target2.add_frame_defines("some_attribute", "STRING")
+    target2.add_define_default("some_attribute", "target_frame_default")
+    target2.add_signal_defines("some_signal_attribute", "STRING")
+    target2.add_define_default("some_signal_attribute", "target_sig_default")
+    canmatrix.copy.copy_frame(frame1.arbitration_id, source, target2)
+    assert target2.frames[0].attribute("some_attribute", target2) == "source_frame_default"
+    assert target2.frames[0].signals[0].attribute("some_signal_attribute", target2) == "source_sig_default"