Merge pull request #384 from andlaus/more_enums

More enums

Author: andlaus

examples/somersaultecu.py

@@ -43,7 +43,7 @@
 from odxtools.functionalclass import FunctionalClass
 from odxtools.modification import Modification
 from odxtools.nameditemlist import NamedItemList
-from odxtools.odxlink import OdxDocFragment, OdxLinkId, OdxLinkRef
+from odxtools.odxlink import DocType, OdxDocFragment, OdxLinkId, OdxLinkRef
 from odxtools.odxtypes import DataType
 from odxtools.parameters.codedconstparameter import CodedConstParameter
 from odxtools.parameters.matchingrequestparameter import MatchingRequestParameter
@@ -90,12 +90,12 @@ class SomersaultSID(IntEnum):
 dlc_short_name = "somersault"
 
 # document fragment for everything except the communication parameters
-doc_frags = [OdxDocFragment(dlc_short_name, "CONTAINER")]
+doc_frags = [OdxDocFragment(dlc_short_name, DocType.CONTAINER)]
 
 # document fragments for communication parameters
-cp_dwcan_doc_frags = [OdxDocFragment("ISO_11898_2_DWCAN", "COMPARAM-SUBSET")]
-cp_iso15765_2_doc_frags = [OdxDocFragment("ISO_15765_2", "COMPARAM-SUBSET")]
-cp_iso15765_3_doc_frags = [OdxDocFragment("ISO_15765_3", "COMPARAM-SUBSET")]
+cp_dwcan_doc_frags = [OdxDocFragment("ISO_11898_2_DWCAN", DocType.COMPARAM_SUBSET)]
+cp_iso15765_2_doc_frags = [OdxDocFragment("ISO_15765_2", DocType.COMPARAM_SUBSET)]
+cp_iso15765_3_doc_frags = [OdxDocFragment("ISO_15765_3", DocType.COMPARAM_SUBSET)]
 
 ##################
 # Base variant of Somersault ECU
@@ -2358,8 +2358,9 @@ class SomersaultSID(IntEnum):
     additional_audiences=NamedItemList(),
     sdgs=[],
     parent_refs=[],
-    comparam_spec_ref=OdxLinkRef("CPS_ISO_15765_3_on_ISO_15765_2",
-                                 [OdxDocFragment("ISO_15765_3_on_ISO_15765_2", "COMPARAM-SPEC")]),
+    comparam_spec_ref=OdxLinkRef("CPS_ISO_15765_3_on_ISO_15765_2", [
+        OdxDocFragment("ISO_15765_3_on_ISO_15765_2", DocType.COMPARAM_SPEC)
+    ]),
     comparam_refs=somersault_comparam_refs,
     libraries=NamedItemList(),
     prot_stack_snref=None,

odxtools/comparamspec.py

@@ -5,7 +5,7 @@
 
 from .nameditemlist import NamedItemList
 from .odxcategory import OdxCategory
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxlink import DocType, OdxDocFragment, OdxLinkDatabase, OdxLinkId
 from .protstack import ProtStack
 from .snrefcontext import SnRefContext
 from .utils import dataclass_fields_asdict
@@ -16,12 +16,13 @@
 
 @dataclass
 class ComparamSpec(OdxCategory):
+
     prot_stacks: NamedItemList[ProtStack]
 
     @staticmethod
     def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) -> "ComparamSpec":
 
-        cat = OdxCategory.category_from_et(et_element, doc_frags, doc_type="COMPARAM-SPEC")
+        cat = OdxCategory.category_from_et(et_element, doc_frags, doc_type=DocType.COMPARAM_SPEC)
         doc_frags = cat.odx_id.doc_fragments
         kwargs = dataclass_fields_asdict(cat)
 

odxtools/comparamsubset.py

@@ -8,7 +8,7 @@
 from .dataobjectproperty import DataObjectProperty
 from .nameditemlist import NamedItemList
 from .odxcategory import OdxCategory
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxlink import DocType, OdxDocFragment, OdxLinkDatabase, OdxLinkId
 from .snrefcontext import SnRefContext
 from .unitspec import UnitSpec
 from .utils import dataclass_fields_asdict
@@ -19,19 +19,17 @@
 
 @dataclass
 class ComparamSubset(OdxCategory):
-    # mandatory in ODX 2.2, but non-existent in ODX 2.0
-    category: Optional[str]
-
     comparams: NamedItemList[Comparam]
     complex_comparams: NamedItemList[ComplexComparam]
     data_object_props: NamedItemList[DataObjectProperty]
     unit_spec: Optional[UnitSpec]
+    category: Optional[str]  # mandatory in ODX 2.2, but non-existent in ODX 2.0
 
     @staticmethod
     def from_et(et_element: ElementTree.Element,
                 doc_frags: List[OdxDocFragment]) -> "ComparamSubset":
 
-        cat = OdxCategory.category_from_et(et_element, doc_frags, doc_type="COMPARAM-SUBSET")
+        cat = OdxCategory.category_from_et(et_element, doc_frags, doc_type=DocType.COMPARAM_SUBSET)
         doc_frags = cat.odx_id.doc_fragments
         kwargs = dataclass_fields_asdict(cat)
 

odxtools/diaglayercontainer.py

@@ -12,7 +12,7 @@
 from .diaglayers.protocol import Protocol
 from .nameditemlist import NamedItemList
 from .odxcategory import OdxCategory
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxlink import DocType, OdxDocFragment, OdxLinkDatabase, OdxLinkId
 from .snrefcontext import SnRefContext
 from .utils import dataclass_fields_asdict
 
@@ -48,7 +48,7 @@ def __post_init__(self) -> None:
     def from_et(et_element: ElementTree.Element,
                 doc_frags: List[OdxDocFragment]) -> "DiagLayerContainer":
 
-        cat = OdxCategory.category_from_et(et_element, doc_frags, doc_type="CONTAINER")
+        cat = OdxCategory.category_from_et(et_element, doc_frags, doc_type=DocType.CONTAINER)
         doc_frags = cat.odx_id.doc_fragments
         kwargs = dataclass_fields_asdict(cat)
 

odxtools/diaglayers/diaglayerraw.py

@@ -15,7 +15,7 @@
 from ..functionalclass import FunctionalClass
 from ..library import Library
 from ..nameditemlist import NamedItemList
-from ..odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef
+from ..odxlink import DocType, OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef
 from ..request import Request
 from ..response import Response
 from ..singleecujob import SingleEcuJob
@@ -81,7 +81,7 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
 
         # extend the applicable ODX "document fragments" for the diag layer objects
         doc_frags = copy(doc_frags)
-        doc_frags.append(OdxDocFragment(short_name, "LAYER"))
+        doc_frags.append(OdxDocFragment(short_name, DocType.LAYER))
         kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, doc_frags))
 
         admin_data = None

odxtools/minmaxlengthtype.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import List, Optional
+from enum import Enum
+from typing import List, Optional, cast
 from xml.etree import ElementTree
 
 from typing_extensions import override
@@ -15,11 +16,17 @@
 from .utils import dataclass_fields_asdict
 
 
+class Termination(Enum):
+    END_OF_PDU = "END-OF-PDU"
+    ZERO = "ZERO"
+    HEX_FF = "HEX-FF"
+
+
 @dataclass
 class MinMaxLengthType(DiagCodedType):
     min_length: int
     max_length: Optional[int]
-    termination: str
+    termination: Termination
 
     @property
     def dct_type(self) -> DctType:
@@ -35,7 +42,13 @@ def from_et(et_element: ElementTree.Element,
         max_length = None
         if et_element.find("MAX-LENGTH") is not None:
             max_length = int(odxrequire(et_element.findtext("MAX-LENGTH")))
-        termination = odxrequire(et_element.get("TERMINATION"))
+
+        termination_str = odxrequire(et_element.get("TERMINATION"))
+        try:
+            termination = Termination(termination_str)
+        except ValueError:
+            termination = cast(Termination, None)
+            odxraise(f"Encountered unknown termination type '{termination_str}'")
 
         return MinMaxLengthType(
             min_length=min_length, max_length=max_length, termination=termination, **kwargs)
@@ -49,23 +62,18 @@ def __post_init__(self) -> None:
                 DataType.A_UNICODE2STRING,
                 DataType.A_UTF8STRING,
             ], f"A min-max length type cannot have the base data type {self.base_data_type}.")
-        odxassert(self.termination in [
-            "ZERO",
-            "HEX-FF",
-            "END-OF-PDU",
-        ], f"A min-max length type cannot have the termination {self.termination}")
 
     def __termination_sequence(self) -> bytes:
         """Returns the termination byte sequence if it isn't defined."""
         # The termination sequence is actually not specified by ASAM
         # for A_BYTEFIELD but I assume it is only one byte.
         termination_sequence = b''
-        if self.termination == "ZERO":
+        if self.termination == Termination.ZERO:
             if self.base_data_type not in [DataType.A_UNICODE2STRING]:
                 termination_sequence = bytes([0x0])
             else:
                 termination_sequence = bytes([0x0, 0x0])
-        elif self.termination == "HEX-FF":
+        elif self.termination == Termination.HEX_FF:
             if self.base_data_type not in [DataType.A_UNICODE2STRING]:
                 termination_sequence = bytes([0xFF])
             else:
@@ -121,7 +129,7 @@ def encode_into_pdu(self, internal_value: AtomicOdxType, encode_state: EncodeSta
         # encountered within the encoded value.
 
         odxassert(
-            self.termination != "END-OF-PDU" or encode_state.is_end_of_pdu,
+            self.termination != Termination.END_OF_PDU or encode_state.is_end_of_pdu,
             "Encountered a MIN-MAX-LENGTH type with END-OF-PDU termination "
             "which is not located at the end of the PDU")
         if encode_state.is_end_of_pdu or data_length == self.max_length:
@@ -153,7 +161,7 @@ def decode_from_pdu(self, decode_state: DecodeState) -> AtomicOdxType:
         if self.max_length is not None:
             max_terminator_pos = min(max_terminator_pos, orig_cursor_pos + self.max_length)
 
-        if self.termination != "END-OF-PDU":
+        if self.termination != Termination.END_OF_PDU:
             # The parameter either ends after the maximum length, at
             # the end of the PDU or if a termination sequence is
             # found.

odxtools/odxcategory.py

@@ -8,7 +8,7 @@
 from .element import IdentifiableElement
 from .exceptions import odxrequire
 from .nameditemlist import NamedItemList
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxlink import DocType, OdxDocFragment, OdxLinkDatabase, OdxLinkId
 from .snrefcontext import SnRefContext
 from .specialdatagroup import SpecialDataGroup
 from .utils import dataclass_fields_asdict
@@ -32,7 +32,7 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
 
     @staticmethod
     def category_from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment], *,
-                         doc_type: str) -> "OdxCategory":
+                         doc_type: DocType) -> "OdxCategory":
 
         short_name = odxrequire(et_element.findtext("SHORT-NAME"))
         # create the current ODX "document fragment" (description of the

odxtools/odxlink.py

@@ -1,17 +1,30 @@
 # SPDX-License-Identifier: MIT
 import warnings
 from dataclasses import dataclass
+from enum import Enum
 from typing import Any, Dict, Iterable, List, Optional, Type, TypeVar, overload
 from xml.etree import ElementTree
 
 from .exceptions import OdxWarning, odxassert, odxraise, odxrequire
 from .nameditemlist import OdxNamed, TNamed
 
 
+class DocType(Enum):
+    FLASH = "FLASH"
+    CONTAINER = "CONTAINER"
+    LAYER = "LAYER"
+    MULTIPLE_ECU_JOB_SPEC = "MULTIPLE-ECU-JOB-SPEC"
+    COMPARAM_SPEC = "COMPARAM-SPEC"
+    VEHICLE_INFO_SPEC = "VEHICLE-INFO-SPEC"
+    COMPARAM_SUBSET = "COMPARAM-SUBSET"
+    ECU_CONFIG = "ECU-CONFIG"
+    FUNCTION_DICTIONARY_SPEC = "FUNCTION-DICTIONARY-SPEC"
+
+
 @dataclass(frozen=True)
 class OdxDocFragment:
     doc_name: str
-    doc_type: str
+    doc_type: DocType
 
 
 @dataclass(frozen=True)
@@ -109,18 +122,25 @@ def from_et(et: Optional[ElementTree.Element],
             odxraise(f"Tag {et.tag} is not a ODXLINK reference")
             return None
 
-        doc_ref = et.attrib.get("DOCREF")
-        doc_type = et.attrib.get("DOCTYPE")
+        docref = et.attrib.get("DOCREF")
+        doctype_attr = et.attrib.get("DOCTYPE")
 
-        odxassert((doc_ref is not None and doc_type is not None) or
-                  (doc_ref is None and doc_type is None),
+        odxassert((docref is not None and doctype_attr is not None) or
+                  (docref is None and doctype_attr is None),
                   "DOCREF and DOCTYPE must both either be specified or omitted")
 
+        doctype = None
+        if doctype_attr is not None:
+            try:
+                doctype = DocType(doctype_attr)
+            except ValueError:
+                odxraise(f"Encountered unknown document type '{doctype_attr}'")
+
         # if the target document fragment is specified by the
         # reference, use it, else use the document fragment containing
         # the reference.
-        if doc_ref is not None:
-            doc_frags = [OdxDocFragment(doc_ref, odxrequire(doc_type))]
+        if docref is not None:
+            doc_frags = [OdxDocFragment(docref, odxrequire(doctype))]
         else:
             doc_frags = source_doc_frags
 

odxtools/parameters/tableentryparameter.py

@@ -1,13 +1,14 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, List, Optional
+from enum import Enum
+from typing import TYPE_CHECKING, List, Optional, cast
 from xml.etree import ElementTree
 
 from typing_extensions import override
 
 from ..decodestate import DecodeState
 from ..encodestate import EncodeState
-from ..exceptions import odxrequire
+from ..exceptions import odxraise, odxrequire
 from ..odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkRef
 from ..odxtypes import ParameterValue
 from ..utils import dataclass_fields_asdict
@@ -17,9 +18,14 @@
     from ..tablerow import TableRow
 
 
+class RowFragment(Enum):
+    KEY = "KEY"
+    STRUCT = "STRUCT"
+
+
 @dataclass
 class TableEntryParameter(Parameter):
-    target: str
+    target: RowFragment
     table_row_ref: OdxLinkRef
 
     @staticmethod
@@ -29,7 +35,12 @@ def from_et(et_element: ElementTree.Element,
 
         kwargs = dataclass_fields_asdict(Parameter.from_et(et_element, doc_frags))
 
-        target = odxrequire(et_element.findtext("TARGET"))
+        target_str = odxrequire(et_element.findtext("TARGET"))
+        try:
+            target = RowFragment(target_str)
+        except ValueError:
+            odxraise(f"Encountered unknown target '{target_str}'")
+            target = cast(RowFragment, None)
         table_row_ref = odxrequire(OdxLinkRef.from_et(et_element.find("TABLE-ROW-REF"), doc_frags))
 
         return TableEntryParameter(target=target, table_row_ref=table_row_ref, **kwargs)

odxtools/templates/macros/printDOP.xml.jinja2

@@ -15,7 +15,7 @@
                  {{-make_xml_attrib("BASE-TYPE-ENCODING", dct.base_type_encoding and dct.base_type_encoding.value)}}
                  {{-make_bool_xml_attrib("IS-HIGHLOW-BYTE-ORDER", dct.is_highlow_byte_order_raw)}}
                  {%- if dct.termination is defined %}
-                 {{-make_xml_attrib("TERMINATION", dct.termination)}}
+                 {{-make_xml_attrib("TERMINATION", dct.termination.value)}}
                  {%- endif %}
                  {#- #} xsi:type="{{dct.dct_type}}">
  {%- if dct.dct_type in ("STANDARD-LENGTH-TYPE", "LEADING-LENGTH-INFO-TYPE") %}

odxtools/templates/macros/printProtocol.xml.jinja2

@@ -13,7 +13,7 @@
   {%- set dlr = protocol.protocol_raw %}
 
   {%- set cps_docfrag = dlr.comparam_spec_ref.ref_docs[-1] %}
-  <COMPARAM-SPEC-REF ID-REF="{{dlr.comparam_spec_ref.ref_id}}" DOCREF="{{cps_docfrag.doc_name}}" DOCTYPE="{{cps_docfrag.doc_type}}" />
+  <COMPARAM-SPEC-REF ID-REF="{{dlr.comparam_spec_ref.ref_id}}" DOCREF="{{cps_docfrag.doc_name}}" DOCTYPE="{{cps_docfrag.doc_type.value}}" />
 
   {%- if dlr.prot_stack_snref is not none %}
   <PROT-STACK-SNREF SHORT-NAME="{{ dlr.prot_stack_snref }}" />

tests/test_compu_methods.py

@@ -21,13 +21,13 @@
 from odxtools.compumethods.scaleratfunccompumethod import ScaleRatFuncCompuMethod
 from odxtools.compumethods.tabintpcompumethod import TabIntpCompuMethod
 from odxtools.exceptions import DecodeError, EncodeError, OdxError
-from odxtools.odxlink import OdxDocFragment
+from odxtools.odxlink import DocType, OdxDocFragment
 from odxtools.odxtypes import DataType
 from odxtools.progcode import ProgCode
 from odxtools.writepdxfile import (get_parent_container_name, jinja2_odxraise_helper,
                                    make_bool_xml_attrib, make_xml_attrib)
 
-doc_frags = [OdxDocFragment("UnitTest", "WinneThePoh")]
+doc_frags = [OdxDocFragment("UnitTest", DocType.CONTAINER)]
 
 
 class TestLinearCompuMethod(unittest.TestCase):