Merge pull request #407 from andlaus/kw_only

Declare (almost) all dataclasses as `kw_only`

Author: andlaus

examples/somersaultecu.py

@@ -2539,10 +2539,8 @@ class SomersaultSID(IntEnum):
             oid=None,
             short_name="annoyed_chart",
             long_name=None,
-            description=Description(
-                "<p>State chart for a day where the ECU is grumpy</p>",
-                external_docs=[],
-                text_identifier=None),
+            description=Description.from_string(
+                "<p>State chart for a day where the ECU is grumpy</p>"),
             states=NamedItemList([
                 State(
                     odx_id=OdxLinkId("charts.annoyed.states.in_bed", doc_frags),
@@ -2642,10 +2640,8 @@ class SomersaultSID(IntEnum):
             oid=None,
             short_name="angry_chart",
             long_name=None,
-            description=Description(
-                "<p>State chart for a day where the ECU has a hissy fit</p>",
-                external_docs=[],
-                text_identifier=None),
+            description=Description.from_string(
+                "<p>State chart for a day where the ECU has a hissy fit</p>"),
             states=NamedItemList([
                 State(
                     odx_id=OdxLinkId("charts.angry.states.in_bed", doc_frags),

odxtools/additionalaudience.py

@@ -10,7 +10,7 @@
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class AdditionalAudience(IdentifiableElement):
     """
     Corresponds to ADDITIONAL-AUDIENCE.

odxtools/admindata.py

@@ -10,7 +10,7 @@
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class AdminData:
     language: str | None
     company_doc_infos: list[CompanyDocInfo]

odxtools/audience.py

@@ -11,7 +11,7 @@
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Audience:
     enabled_audience_refs: list[OdxLinkRef]
     disabled_audience_refs: list[OdxLinkRef]

odxtools/basecomparam.py

@@ -13,7 +13,7 @@
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class BaseComparam(IdentifiableElement):
     param_class: str
     cptype: StandardizationLevel

odxtools/basevariantpattern.py

@@ -11,7 +11,7 @@
 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.

odxtools/basicstructure.py

@@ -23,7 +23,7 @@
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class BasicStructure(ComplexDop):
     """Base class for structure-like objects
 

odxtools/commrelation.py

@@ -15,7 +15,7 @@
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CommRelation:
     description: Description | None
     relation_type: str

odxtools/companydata.py

@@ -14,7 +14,7 @@
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompanyData(IdentifiableElement):
     roles: list[str]
     team_members: NamedItemList[TeamMember]

odxtools/companydocinfo.py

@@ -12,7 +12,7 @@
 from .teammember import TeamMember
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompanyDocInfo:
     company_data_ref: OdxLinkRef
     team_member_ref: OdxLinkRef | None

odxtools/companyrevisioninfo.py

@@ -10,7 +10,7 @@
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompanyRevisionInfo:
     company_data_ref: OdxLinkRef
     revision_label: str | None

odxtools/companyspecificinfo.py

@@ -10,7 +10,7 @@
 from .specialdatagroup import SpecialDataGroup
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompanySpecificInfo:
     related_docs: list[RelatedDoc]
     sdgs: list[SpecialDataGroup]

odxtools/comparam.py

@@ -13,7 +13,7 @@
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Comparam(BaseComparam):
     physical_default_value_raw: str
     dop_ref: OdxLinkRef

odxtools/comparaminstance.py

@@ -14,7 +14,7 @@
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ComparamInstance:
     """
     This class represents a communication parameter.

odxtools/comparamspec.py

@@ -15,7 +15,7 @@
     from .database import Database
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ComparamSpec(OdxCategory):
 
     prot_stacks: NamedItemList[ProtStack]

odxtools/comparamsubset.py

@@ -18,7 +18,7 @@
     from .database import Database
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ComparamSubset(OdxCategory):
     comparams: NamedItemList[Comparam]
     complex_comparams: NamedItemList[ComplexComparam]

odxtools/complexcomparam.py

@@ -24,7 +24,7 @@ def create_complex_value_from_et(et_element: ElementTree.Element) -> ComplexValu
     return result
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ComplexComparam(BaseComparam):
     subparams: NamedItemList[BaseComparam]
     physical_default_value: ComplexValue | None

odxtools/complexdop.py

@@ -4,7 +4,7 @@
 from .dopbase import DopBase
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ComplexDop(DopBase):
     """Base class for all complex data object properties.
 

odxtools/compumethods/compucodecompumethod.py

@@ -12,7 +12,7 @@
 from .compumethod import CompuMethod
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuCodeCompuMethod(CompuMethod):
     """A compu method specifies the tranfer functions using Java bytecode
 

odxtools/compumethods/compuconst.py

@@ -5,7 +5,7 @@
 from ..odxtypes import AtomicOdxType, DataType
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuConst:
     v: str | None
     vt: str | None

odxtools/compumethods/compudefaultvalue.py

@@ -8,7 +8,7 @@
 from .compuinversevalue import CompuInverseValue
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuDefaultValue(CompuConst):
     compu_inverse_value: CompuInverseValue | None
 

odxtools/compumethods/compuinternaltophys.py

@@ -12,7 +12,7 @@
 from .compuscale import CompuScale
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuInternalToPhys:
     compu_scales: list[CompuScale]
     prog_code: ProgCode | None

odxtools/compumethods/compumethod.py

@@ -13,7 +13,7 @@
 from .compuphystointernal import CompuPhysToInternal
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuMethod:
     """A compu method translates between the internal representation
     of a value and their physical representation.

odxtools/compumethods/compuphystointernal.py

@@ -12,7 +12,7 @@
 from .compuscale import CompuScale
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuPhysToInternal:
     compu_scales: list[CompuScale]
     prog_code: ProgCode | None

odxtools/compumethods/compurationalcoeffs.py

@@ -8,7 +8,7 @@
 from ..odxtypes import DataType
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuRationalCoeffs:
     value_type: DataType
 

odxtools/compumethods/compuscale.py

@@ -11,7 +11,7 @@
 from .limit import Limit
 
 
-@dataclass
+@dataclass(kw_only=True)
 class CompuScale:
     """A COMPU-SCALE represents one value range of a COMPU-METHOD.
     """

odxtools/compumethods/identicalcompumethod.py

@@ -9,7 +9,7 @@
 from .compumethod import CompuMethod
 
 
-@dataclass
+@dataclass(kw_only=True)
 class IdenticalCompuMethod(CompuMethod):
     """Identical compu methods just pass through the internal value.
 

odxtools/compumethods/limit.py

@@ -9,7 +9,7 @@
 from .intervaltype import IntervalType
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Limit:
     value_raw: str | None
     value_type: DataType | None

odxtools/compumethods/linearcompumethod.py

@@ -12,7 +12,7 @@
 from .linearsegment import LinearSegment
 
 
-@dataclass
+@dataclass(kw_only=True)
 class LinearCompuMethod(CompuMethod):
     """A compu method which does linear interpoation
 

odxtools/compumethods/linearsegment.py

@@ -7,7 +7,7 @@
 from .limit import Limit
 
 
-@dataclass
+@dataclass(kw_only=True)
 class LinearSegment:
     """Helper class to represent a segment of a piecewise-linear interpolation.
 

odxtools/compumethods/ratfunccompumethod.py

@@ -12,7 +12,7 @@
 from .ratfuncsegment import RatFuncSegment
 
 
-@dataclass
+@dataclass(kw_only=True)
 class RatFuncCompuMethod(CompuMethod):
     """A compu method using a rational function
 

odxtools/compumethods/ratfuncsegment.py

@@ -7,7 +7,7 @@
 from .limit import Limit
 
 
-@dataclass
+@dataclass(kw_only=True)
 class RatFuncSegment:
     """Helper class to represent a segment of a piecewise rational function.
     """

odxtools/compumethods/scalelinearcompumethod.py

@@ -13,7 +13,7 @@
 from .linearsegment import LinearSegment
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ScaleLinearCompuMethod(CompuMethod):
     """A piecewise linear compu method which may feature discontinuities.
 

odxtools/compumethods/scaleratfunccompumethod.py

@@ -12,7 +12,7 @@
 from .ratfuncsegment import RatFuncSegment
 
 
-@dataclass
+@dataclass(kw_only=True)
 class ScaleRatFuncCompuMethod(CompuMethod):
     """A compu method using a piecewise rational function
 

odxtools/compumethods/tabintpcompumethod.py

@@ -12,7 +12,7 @@
 from .limit import Limit
 
 
-@dataclass
+@dataclass(kw_only=True)
 class TabIntpCompuMethod(CompuMethod):
     """A table-based interpolated compu method provides a continuous
     transfer function based on piecewise linear interpolation.

odxtools/compumethods/texttablecompumethod.py

@@ -12,7 +12,7 @@
 from .compuscale import CompuScale
 
 
-@dataclass
+@dataclass(kw_only=True)
 class TexttableCompuMethod(CompuMethod):
     """Text table compute methods translate numbers to human readable
     textual descriptions.

odxtools/dataobjectproperty.py

@@ -21,7 +21,7 @@
 from .utils import dataclass_fields_asdict
 
 
-@dataclass
+@dataclass(kw_only=True)
 class DataObjectProperty(DopBase):
     """This class represents a DATA-OBJECT-PROP.
 

odxtools/description.py

@@ -7,7 +7,7 @@
 from .odxdoccontext import OdxDocContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class Description:
     text: str
     external_docs: list[ExternalDoc]

odxtools/determinenumberofitems.py

@@ -10,7 +10,7 @@
 from .snrefcontext import SnRefContext
 
 
-@dataclass
+@dataclass(kw_only=True)
 class DetermineNumberOfItems:
     """
     The object that determines the number of items of dynamic fields

odxtools/diagcodedtype.py

@@ -21,7 +21,7 @@
 ]
 
 
-@dataclass
+@dataclass(kw_only=True)
 class DiagCodedType:
     base_type_encoding: Encoding | None
     base_data_type: DataType

odxtools/diagcomm.py

@@ -26,7 +26,7 @@
     from .diaglayers.protocol import Protocol
 
 
-@dataclass
+@dataclass(kw_only=True)
 class DiagComm(IdentifiableElement):
     """Representation of a diagnostic communication object.
 

odxtools/diagdatadictionaryspec.py

@@ -25,7 +25,7 @@
 from .unitspec import UnitSpec
 
 
-@dataclass
+@dataclass(kw_only=True)
 class DiagDataDictionarySpec:
     admin_data: AdminData | None
     dtc_dops: NamedItemList[DtcDop]