odxtools 10.0.0__py3-none-any.whl → 10.1.1__py3-none-any.whl

odxtools/additionalaudience.py

@@ -4,21 +4,21 @@ from typing import Any
 from xml.etree import ElementTree
 
 from .element import IdentifiableElement
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxdoccontext import OdxDocContext
+from .odxlink import OdxLinkDatabase, OdxLinkId
 from .snrefcontext import SnRefContext
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class AdditionalAudience(IdentifiableElement):
     """
     Corresponds to ADDITIONAL-AUDIENCE.
     """
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element,
-                doc_frags: list[OdxDocFragment]) -> "AdditionalAudience":
-        kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, doc_frags))
+    def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "AdditionalAudience":
+        kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, context))
 
         return AdditionalAudience(**kwargs)
 

odxtools/admindata.py

@@ -1,23 +1,24 @@
 # SPDX-License-Identifier: MIT
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Any, Optional
 from xml.etree import ElementTree
 
 from .companydocinfo import CompanyDocInfo
 from .docrevision import DocRevision
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxdoccontext import OdxDocContext
+from .odxlink import OdxLinkDatabase, OdxLinkId
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class AdminData:
-    language: str | None
-    company_doc_infos: list[CompanyDocInfo]
-    doc_revisions: list[DocRevision]
+    language: str | None = None
+    company_doc_infos: list[CompanyDocInfo] = field(default_factory=list)
+    doc_revisions: list[DocRevision] = field(default_factory=list)
 
     @staticmethod
     def from_et(et_element: ElementTree.Element | None,
-                doc_frags: list[OdxDocFragment]) -> Optional["AdminData"]:
+                context: OdxDocContext) -> Optional["AdminData"]:
 
         if et_element is None:
             return None
@@ -25,12 +26,12 @@ class AdminData:
         language = et_element.findtext("LANGUAGE")
 
         company_doc_infos = [
-            CompanyDocInfo.from_et(cdi_elem, doc_frags)
+            CompanyDocInfo.from_et(cdi_elem, context)
             for cdi_elem in et_element.iterfind("COMPANY-DOC-INFOS/COMPANY-DOC-INFO")
         ]
 
         doc_revisions = [
-            DocRevision.from_et(dr_elem, doc_frags)
+            DocRevision.from_et(dr_elem, context)
             for dr_elem in et_element.iterfind("DOC-REVISIONS/DOC-REVISION")
         ]
 

odxtools/audience.py

@@ -1,25 +1,26 @@
 # SPDX-License-Identifier: MIT
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Any
 from xml.etree import ElementTree
 
 from .additionalaudience import AdditionalAudience
 from .nameditemlist import NamedItemList
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef
+from .odxdoccontext import OdxDocContext
+from .odxlink import OdxLinkDatabase, OdxLinkId, OdxLinkRef
 from .odxtypes import odxstr_to_bool
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Audience:
-    enabled_audience_refs: list[OdxLinkRef]
-    disabled_audience_refs: list[OdxLinkRef]
+    enabled_audience_refs: list[OdxLinkRef] = field(default_factory=list)
+    disabled_audience_refs: list[OdxLinkRef] = field(default_factory=list)
 
-    is_supplier_raw: bool | None
-    is_development_raw: bool | None
-    is_manufacturing_raw: bool | None
-    is_aftersales_raw: bool | None
-    is_aftermarket_raw: bool | None
+    is_supplier_raw: bool | None = None
+    is_development_raw: bool | None = None
+    is_manufacturing_raw: bool | None = None
+    is_aftersales_raw: bool | None = None
+    is_aftermarket_raw: bool | None = None
 
     @property
     def is_supplier(self) -> bool:
@@ -50,15 +51,14 @@ class Audience:
         return self._disabled_audiences
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element, doc_frags: list[OdxDocFragment]) -> "Audience":
+    def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "Audience":
 
         enabled_audience_refs = [
-            OdxLinkRef.from_et(ref, doc_frags)
-            for ref in et_element.iterfind("ENABLED-AUDIENCE-REFS/"
-                                           "ENABLED-AUDIENCE-REF")
+            OdxLinkRef.from_et(ref, context) for ref in et_element.iterfind("ENABLED-AUDIENCE-REFS/"
+                                                                            "ENABLED-AUDIENCE-REF")
         ]
         disabled_audience_refs = [
-            OdxLinkRef.from_et(ref, doc_frags)
+            OdxLinkRef.from_et(ref, context)
             for ref in et_element.iterfind("DISABLED-AUDIENCE-REFS/"
                                            "DISABLED-AUDIENCE-REF")
         ]

odxtools/basecomparam.py

@@ -5,23 +5,24 @@ from xml.etree import ElementTree
 
 from .element import IdentifiableElement
 from .exceptions import odxraise, odxrequire
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxdoccontext import OdxDocContext
+from .odxlink import OdxLinkDatabase, OdxLinkId
 from .snrefcontext import SnRefContext
 from .standardizationlevel import StandardizationLevel
 from .usage import Usage
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class BaseComparam(IdentifiableElement):
     param_class: str
     cptype: StandardizationLevel
-    display_level: int | None
-    cpusage: Usage | None  # Required in ODX 2.2, missing in ODX 2.0
+    display_level: int | None = None
+    cpusage: Usage | None = None  # Required in ODX 2.2, missing in ODX 2.0
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element, doc_frags: list[OdxDocFragment]) -> "BaseComparam":
-        kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, doc_frags))
+    def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "BaseComparam":
+        kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, context))
 
         param_class = odxrequire(et_element.attrib.get("PARAM-CLASS"))
 

odxtools/basevariantpattern.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: MIT
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from xml.etree import ElementTree
 
 from typing_extensions import override
@@ -7,23 +7,23 @@ from typing_extensions import override
 from .exceptions import odxassert
 from .matchingbasevariantparameter import MatchingBaseVariantParameter
 from .matchingparameter import MatchingParameter
-from .odxlink import OdxDocFragment
+from .odxdoccontext import OdxDocContext
 from .variantpattern import VariantPattern
 
 
-@dataclass
+@dataclass(kw_only=True)
 class BaseVariantPattern(VariantPattern):
     """Base variant patterns are variant patterns used to identify the
     base variant of an ECU.
     """
-    matching_base_variant_parameters: list[MatchingBaseVariantParameter]
+    matching_base_variant_parameters: list[MatchingBaseVariantParameter] = field(
+        default_factory=list)
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element,
-                doc_frags: list[OdxDocFragment]) -> "BaseVariantPattern":
+    def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "BaseVariantPattern":
 
         matching_base_variant_parameters = [
-            MatchingBaseVariantParameter.from_et(mbvp_el, doc_frags)
+            MatchingBaseVariantParameter.from_et(mbvp_el, context)
             for mbvp_el in et_element.iterfind("MATCHING-BASE-VARIANT-PARAMETERS/"
                                                "MATCHING-BASE-VARIANT-PARAMETER")
         ]

odxtools/basicstructure.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: MIT
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Any
 from xml.etree import ElementTree
 
@@ -14,7 +14,8 @@ from .decodestate import DecodeState
 from .encodestate import EncodeState
 from .exceptions import DecodeError, odxraise
 from .nameditemlist import NamedItemList
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId
+from .odxdoccontext import OdxDocContext
+from .odxlink import OdxLinkDatabase, OdxLinkId
 from .odxtypes import ParameterValue
 from .parameters.createanyparameter import create_any_parameter_from_et
 from .parameters.parameter import Parameter
@@ -22,7 +23,7 @@ from .snrefcontext import SnRefContext
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class BasicStructure(ComplexDop):
     """Base class for structure-like objects
 
@@ -30,8 +31,8 @@ class BasicStructure(ComplexDop):
     data objects. All structure-like objects adhere to the
     `CompositeCodec` type protocol.
     """
-    byte_size: int | None
-    parameters: NamedItemList[Parameter]
+    byte_size: int | None = None
+    parameters: NamedItemList[Parameter] = field(default_factory=NamedItemList)
 
     @property
     def required_parameters(self) -> list[Parameter]:
@@ -42,15 +43,14 @@ class BasicStructure(ComplexDop):
         return composite_codec_get_free_parameters(self)
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element,
-                doc_frags: list[OdxDocFragment]) -> "BasicStructure":
+    def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "BasicStructure":
         """Read a BASIC-STRUCTURE."""
-        kwargs = dataclass_fields_asdict(ComplexDop.from_et(et_element, doc_frags))
+        kwargs = dataclass_fields_asdict(ComplexDop.from_et(et_element, context))
 
         byte_size_str = et_element.findtext("BYTE-SIZE")
         byte_size = int(byte_size_str) if byte_size_str is not None else None
         parameters = NamedItemList([
-            create_any_parameter_from_et(et_parameter, doc_frags)
+            create_any_parameter_from_et(et_parameter, context)
             for et_parameter in et_element.iterfind("PARAMS/PARAM")
         ])
 

odxtools/cli/_print_utils.py

@@ -214,7 +214,7 @@ def extract_parameter_tabulation_data(parameters: list[Parameter]) -> RichTable:
             value_column.append(str(param.coded_values))
             value_type_column.append('coded values')
             dop_column.append("")
-        elif isinstance(param, PhysicalConstantParameter | SystemParameter | ValueParameter):
+        elif isinstance(param, (PhysicalConstantParameter, SystemParameter, ValueParameter)):
             # this is a hack to make this routine work for parameters
             # which reference DOPs of a type that a is not yet
             # internalized. (all parameter objects of the tested types

odxtools/cli/browse.py

@@ -370,7 +370,7 @@ def browse(odxdb: Database) -> None:
 
             codec = answer.get("message_type")
             if codec is not None:
-                assert isinstance(codec, Request | Response)
+                assert isinstance(codec, (Request, Response))
                 table = extract_parameter_tabulation_data(codec.parameters)
                 print(table)