Support for unknown enum items

Author: CZDanol

docs_src/nfc_data_format.md

@@ -77,6 +77,7 @@
    1. All data sections SHALL be at most 512 bytes long.
    1. All fields MUST follow this specification. Using custom or vendor-specific keys is not permitted (with the exception described in the Aux Region section).
    1. New keys can be added to the specification at any time, implementations SHALL be able to skip unknown keys, of any type. Unknown fields SHALL NOT be removed when updating a known field (or in any update proces in general) unless explicitly intended.
+      1. This applies to unknown items of `enum` and `enum_array` as well, provided that they are represented as integer values in the range of <0, 65535>.
    1. Keys can be deprecated at any time. Deprecated keys will never be reused.
    1. The keys MAY be arbitrarily ordered within the CBOR map. Implementations SHALL support unsorted (non-canonical) CBOR maps.
 1. CBOR maps and arrays SHOULD be encoded as indefinite containers.

tests/encode_decode/05_data.bin

@@ -8,7 +8,7 @@ regions:
     payload_offset: 4
     absolute_offset: 46
     size: 230
-    used_size: 23
+    used_size: 31
   aux:
     payload_offset: 234
     absolute_offset: 276
@@ -18,21 +18,24 @@ root:
   data_size: 312
   payload_size: 269
   overhead: 43
-  payload_used_size: 28
-  total_used_size: 71
+  payload_used_size: 36
+  total_used_size: 79
 data:
   meta:
     aux_region_offset: 234
   main:
     material_class: FFF
     transmission_distance: 5.1
+    tags:
+    - glitter
+    - 9429
   aux: {}
 unknown_fields:
   main:
     19ffff: '6474657374'
 raw_data:
   meta: a10218ea
-  main: bf0800181bfb401466666666666619ffff6474657374ff000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+  main: bf0800181bfb4014666666666666181c9f171924d5ff19ffff6474657374ff00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
   aux: a000000000000000000000000000000000000000000000000000000000000000000000
 uri: null
 validate:
@@ -47,7 +50,6 @@ validate:
   - Missing recommended field 'actual_netto_full_weight'
   - Missing recommended field 'empty_container_weight'
   - Missing recommended field 'primary_color'
-  - Missing recommended field 'tags'
   - Missing recommended field 'density'
   - Missing recommended field 'min_print_temperature'
   - Missing recommended field 'max_print_temperature'

tests/encode_decode/05_info.yaml

@@ -3,6 +3,12 @@ test_config:
 data:
   main:
     material_class: FFF
+
+    # Test unknown enum items
+    tags:
+      - glitter
+      - 9429
+
 unknown_fields:
   main:
     # 27 (= transmission distance): 5.1

tests/encode_decode/05_input.yaml

@@ -129,17 +129,28 @@ def __init__(self, config, config_dir):
             self.items_by_key[key] = name
             self.items_by_name[name] = key
 
+    def decode(self, data):
+        if not isinstance(data, int):
+            raise ValueError("Enum item not integer")
+
+        return self.items_by_key.get(data, data)
+
+    def encode(self, data):
+        if isinstance(data, str):
+            return self.items_by_name[data]
+
+        elif isinstance(data, int):
+            # Pass unkown items verbatim
+            return data
+
+        else:
+            raise ValueError("Enum values must be either")
+
 
 class EnumField(EnumFieldBase):
     def __init__(self, config, config_dir):
         super().__init__(config, config_dir)
 
-    def decode(self, data):
-        return self.items_by_key[data]
-
-    def encode(self, data):
-        return self.items_by_name[data]
-
 
 class EnumArrayField(EnumFieldBase):
     max_len: int
@@ -151,18 +162,12 @@ def __init__(self, config, config_dir):
     def decode(self, data):
         assert type(data) is list
 
-        result = []
-        for item in data:
-            result.append(self.items_by_key[item])
-
-        return result
+        return [EnumFieldBase.decode(self, item) for item in data]
 
     def encode(self, data):
         assert type(data) is list
 
-        result = []
-        for item in data:
-            result.append(self.items_by_name[item])
+        result = [EnumFieldBase.encode(self, item) for item in data]
 
         assert len(result) <= self.max_len
         return result