Merge pull request #411 from andlaus/defaulted_optional_fields

Specify defaults for all optional dataclass fields

Author: andlaus

odxtools/admindata.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: MIT
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Any, Optional
 from xml.etree import ElementTree
 
@@ -12,9 +12,9 @@
 
 @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,

odxtools/audience.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
 
@@ -13,14 +13,14 @@
 
 @dataclass(kw_only=True)
 class Audience:
-    enabled_audience_refs: list[OdxLinkRef]
-    disabled_audience_refs: list[OdxLinkRef]
-
-    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
+    enabled_audience_refs: list[OdxLinkRef] = field(default_factory=list)
+    disabled_audience_refs: list[OdxLinkRef] = field(default_factory=list)
+
+    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:

odxtools/basecomparam.py

@@ -17,8 +17,8 @@
 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, context: OdxDocContext) -> "BaseComparam":

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
@@ -16,7 +16,8 @@ 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, context: OdxDocContext) -> "BaseVariantPattern":

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
 
@@ -31,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]:

odxtools/commrelation.py

@@ -17,15 +17,15 @@
 
 @dataclass(kw_only=True)
 class CommRelation:
-    description: Description | None
+    description: Description | None = None
     relation_type: str
-    diag_comm_ref: OdxLinkRef | None
-    diag_comm_snref: str | None
-    in_param_if_snref: str | None
-    #in_param_if_snpathref: Optional[str] # TODO
-    out_param_if_snref: str | None
-    #out_param_if_snpathref: Optional[str] # TODO
-    value_type_raw: CommRelationValueType | None
+    diag_comm_ref: OdxLinkRef | None = None
+    diag_comm_snref: str | None = None
+    in_param_if_snref: str | None = None
+    #in_param_if_snpathref: Optional[str] = None # TODO
+    out_param_if_snref: str | None = None
+    #out_param_if_snpathref: Optional[str] = None # TODO
+    value_type_raw: CommRelationValueType | None = None
 
     @property
     def diag_comm(self) -> DiagComm:

odxtools/companydata.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
 
@@ -16,9 +16,9 @@
 
 @dataclass(kw_only=True)
 class CompanyData(IdentifiableElement):
-    roles: list[str]
-    team_members: NamedItemList[TeamMember]
-    company_specific_info: CompanySpecificInfo | None
+    roles: list[str] = field(default_factory=list)
+    team_members: NamedItemList[TeamMember] = field(default_factory=NamedItemList)
+    company_specific_info: CompanySpecificInfo | None = None
 
     @staticmethod
     def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "CompanyData":

odxtools/companydocinfo.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
 
@@ -15,9 +15,9 @@
 @dataclass(kw_only=True)
 class CompanyDocInfo:
     company_data_ref: OdxLinkRef
-    team_member_ref: OdxLinkRef | None
-    doc_label: str | None
-    sdgs: list[SpecialDataGroup]
+    team_member_ref: OdxLinkRef | None = None
+    doc_label: str | None = None
+    sdgs: list[SpecialDataGroup] = field(default_factory=list)
 
     @property
     def company_data(self) -> CompanyData:

odxtools/companyrevisioninfo.py

@@ -13,8 +13,8 @@
 @dataclass(kw_only=True)
 class CompanyRevisionInfo:
     company_data_ref: OdxLinkRef
-    revision_label: str | None
-    state: str | None
+    revision_label: str | None = None
+    state: str | None = None
 
     @property
     def company_data(self) -> CompanyData:

odxtools/companyspecificinfo.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
 
@@ -12,8 +12,8 @@
 
 @dataclass(kw_only=True)
 class CompanySpecificInfo:
-    related_docs: list[RelatedDoc]
-    sdgs: list[SpecialDataGroup]
+    related_docs: list[RelatedDoc] = field(default_factory=list)
+    sdgs: list[SpecialDataGroup] = field(default_factory=list)
 
     @staticmethod
     def from_et(et_element: ElementTree.Element, context: OdxDocContext) -> "CompanySpecificInfo":