Merge pull request #406 from andlaus/python3.10

Bump minimum Python version to 3.10

Author: andlaus

.github/workflows/tests.yml

@@ -38,7 +38,7 @@ jobs:
       matrix:
         # restrict the matrix to the oldest and the latest Python
         # version being supported by odxtools
-        python-version: ["3.8", "3"]
+        python-version: ["3.10", "3"]
 
     steps:
       - uses: actions/checkout@v3
@@ -57,10 +57,6 @@ jobs:
 
       - name: Static type checking (mypy)
         run: |
-          # remove '# type:' comments in version.py which mypy-3.8
-          # stumbles over. for some reason, mypy cannot be
-          # instructed to ignore 'version.py'
-          sed -i "s/# type:.*//" odxtools/version.py
           python -m mypy .
 
       - name: Lint code quality (ruff)
@@ -73,13 +69,13 @@ jobs:
         os: [ubuntu-latest, windows-latest]
         # restrict the matrix to the oldest and the latest Python
         # version being supported by odxtools
-        python-version: ["3.8", "3"]
+        python-version: ["3.10", "3"]
 
         # due to the slow windows runners, we refrain from testing every python
         # version on windows-latest
         exclude:
           - os: windows-latest
-            python-version: "3.8"
+            python-version: "3.10"
 
     runs-on: ${{matrix.os}}
 

examples/mksomersaultmodifiedpdx.py

@@ -6,7 +6,7 @@
 # modified programatically. Note that this is pretty hacky...
 import argparse
 from copy import deepcopy
-from typing import List, TypeVar
+from typing import TypeVar
 
 import odxtools
 import odxtools.uds as uds
@@ -25,7 +25,7 @@
 T = TypeVar("T")
 
 
-def find_named_object(item_list: List[T], name: str) -> T:
+def find_named_object(item_list: list[T], name: str) -> T:
     for x in item_list:
         if getattr(x, "short_name", None) == name:
             return x

examples/somersaultecu.py

@@ -5,7 +5,7 @@
 from enum import IntEnum
 from io import BytesIO
 from itertools import chain
-from typing import Any, Dict
+from typing import Any
 from xml.etree import ElementTree
 
 import odxtools.uds as uds
@@ -440,7 +440,7 @@ class SomersaultSID(IntEnum):
 }
 
 # computation methods
-somersault_compumethods: Dict[str, CompuMethod] = {
+somersault_compumethods: dict[str, CompuMethod] = {
     "int_passthrough":
         IdenticalCompuMethod(
             category=CompuCategory.IDENTICAL,

examples/somersaultlazy.py

@@ -8,7 +8,7 @@
 import logging
 import random
 from socket import socket
-from typing import List, Optional, Union, cast
+from typing import cast
 
 import isotp
 import isotp.tpsock
@@ -26,19 +26,18 @@
 ecu_logger = logging.getLogger("somersault_lazy_ecu")
 
 is_sterile = False
-can_channel: Optional[str] = None
+can_channel: str | None = None
 somersault_lazy_diag_layer = somersaultdatabase.ecus.somersault_lazy
 
 # the raw payload data of the telegrams received by the ECU and by the
 # tester when in sterile mode (unittest without a CAN channel)
-sterile_rx_ecu: List[bytes] = []
-sterile_rx_ecu_event: Optional[asyncio.Event] = None
-sterile_rx_tester: List[bytes] = []
-sterile_rx_tester_event: Optional[asyncio.Event] = None
+sterile_rx_ecu: list[bytes] = []
+sterile_rx_ecu_event: asyncio.Event | None = None
+sterile_rx_tester: list[bytes] = []
+sterile_rx_tester_event: asyncio.Event | None = None
 
 
-def create_isotp_socket(channel: Optional[str], rxid: int,
-                        txid: int) -> Optional[isotp.tpsock.socket]:
+def create_isotp_socket(channel: str | None, rxid: int, txid: int) -> isotp.tpsock.socket | None:
     if is_sterile:
         return None
 
@@ -66,7 +65,7 @@ def create_isotp_socket(channel: Optional[str], rxid: int,
     return result_socket
 
 
-async def ecu_send(isotp_socket: Optional[isotp.tpsock.socket], payload: bytes) -> None:
+async def ecu_send(isotp_socket: isotp.tpsock.socket | None, payload: bytes) -> None:
     """
     ECU sends a message, either in "sterile" or in "live" mode.
     """
@@ -87,7 +86,7 @@ async def ecu_send(isotp_socket: Optional[isotp.tpsock.socket], payload: bytes)
         await loop.sock_sendall(cast(socket, isotp_socket), payload)
 
 
-async def ecu_recv(isotp_socket: Optional[isotp.tpsock.socket]) -> bytes:
+async def ecu_recv(isotp_socket: isotp.tpsock.socket | None) -> bytes:
     """
     ECU receives a message, either in "sterile" or in "live" mode.
     """
@@ -113,7 +112,7 @@ async def ecu_recv(isotp_socket: Optional[isotp.tpsock.socket]) -> bytes:
         return await loop.sock_recv(cast(socket, isotp_socket), 4095)
 
 
-async def tester_send(isotp_socket: Optional[isotp.tpsock.socket], payload: bytes) -> None:
+async def tester_send(isotp_socket: isotp.tpsock.socket | None, payload: bytes) -> None:
     """
     Tester sends a message, either in "sterile" or in "live" mode.
     """
@@ -133,7 +132,7 @@ async def tester_send(isotp_socket: Optional[isotp.tpsock.socket], payload: byte
         await loop.sock_sendall(cast(socket, isotp_socket), payload)
 
 
-async def tester_recv(isotp_socket: Optional[isotp.tpsock.socket]) -> bytes:
+async def tester_recv(isotp_socket: isotp.tpsock.socket | None) -> bytes:
     """
     Tester receives a message, either in "sterile" or in "live" mode.
     """
@@ -360,9 +359,9 @@ async def _auto_close_session_task(self) -> None:
                 continue
 
 
-async def tester_await_response(isotp_socket: Optional[isotp.tpsock.socket],
+async def tester_await_response(isotp_socket: isotp.tpsock.socket | None,
                                 raw_message: bytes,
-                                timeout: float = 0.5) -> Union[bytes, ParameterValueDict]:
+                                timeout: float = 0.5) -> bytes | ParameterValueDict:
     # await the answer from the server (be aware that the maximum
     # length of ISO-TP telegrams over the CAN bus is 4095 bytes)
     raw_response = await tester_recv(isotp_socket)

odxtools/additionalaudience.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import Any, Dict, List
+from typing import Any
 from xml.etree import ElementTree
 
 from .element import IdentifiableElement
@@ -17,12 +17,12 @@ class AdditionalAudience(IdentifiableElement):
 
     @staticmethod
     def from_et(et_element: ElementTree.Element,
-                doc_frags: List[OdxDocFragment]) -> "AdditionalAudience":
+                doc_frags: list[OdxDocFragment]) -> "AdditionalAudience":
         kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, doc_frags))
 
         return AdditionalAudience(**kwargs)
 
-    def _build_odxlinks(self) -> Dict[OdxLinkId, Any]:
+    def _build_odxlinks(self) -> dict[OdxLinkId, Any]:
         return {self.odx_id: self}
 
     def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None:

odxtools/admindata.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any, Optional
 from xml.etree import ElementTree
 
 from .companydocinfo import CompanyDocInfo
@@ -11,13 +11,13 @@
 
 @dataclass
 class AdminData:
-    language: Optional[str]
-    company_doc_infos: List[CompanyDocInfo]
-    doc_revisions: List[DocRevision]
+    language: str | None
+    company_doc_infos: list[CompanyDocInfo]
+    doc_revisions: list[DocRevision]
 
     @staticmethod
-    def from_et(et_element: Optional[ElementTree.Element],
-                doc_frags: List[OdxDocFragment]) -> Optional["AdminData"]:
+    def from_et(et_element: ElementTree.Element | None,
+                doc_frags: list[OdxDocFragment]) -> Optional["AdminData"]:
 
         if et_element is None:
             return None
@@ -37,8 +37,8 @@ def from_et(et_element: Optional[ElementTree.Element],
         return AdminData(
             language=language, company_doc_infos=company_doc_infos, doc_revisions=doc_revisions)
 
-    def _build_odxlinks(self) -> Dict[OdxLinkId, Any]:
-        result: Dict[OdxLinkId, Any] = {}
+    def _build_odxlinks(self) -> dict[OdxLinkId, Any]:
+        result: dict[OdxLinkId, Any] = {}
 
         for cdi in self.company_doc_infos:
             result.update(cdi._build_odxlinks())

odxtools/audience.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any
 from xml.etree import ElementTree
 
 from .additionalaudience import AdditionalAudience
@@ -12,14 +12,14 @@
 
 @dataclass
 class Audience:
-    enabled_audience_refs: List[OdxLinkRef]
-    disabled_audience_refs: List[OdxLinkRef]
+    enabled_audience_refs: list[OdxLinkRef]
+    disabled_audience_refs: list[OdxLinkRef]
 
-    is_supplier_raw: Optional[bool]
-    is_development_raw: Optional[bool]
-    is_manufacturing_raw: Optional[bool]
-    is_aftersales_raw: Optional[bool]
-    is_aftermarket_raw: Optional[bool]
+    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
 
     @property
     def is_supplier(self) -> bool:
@@ -50,7 +50,7 @@ def disabled_audiences(self) -> NamedItemList[AdditionalAudience]:
         return self._disabled_audiences
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) -> "Audience":
+    def from_et(et_element: ElementTree.Element, doc_frags: list[OdxDocFragment]) -> "Audience":
 
         enabled_audience_refs = [
             OdxLinkRef.from_et(ref, doc_frags)
@@ -78,7 +78,7 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
             is_aftermarket_raw=is_aftermarket_raw,
         )
 
-    def _build_odxlinks(self) -> Dict[OdxLinkId, Any]:
+    def _build_odxlinks(self) -> dict[OdxLinkId, Any]:
         return {}
 
     def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None:

odxtools/basecomparam.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional, cast
+from typing import Any, cast
 from xml.etree import ElementTree
 
 from .element import IdentifiableElement
@@ -16,11 +16,11 @@
 class BaseComparam(IdentifiableElement):
     param_class: str
     cptype: StandardizationLevel
-    display_level: Optional[int]
-    cpusage: Optional[Usage]  # Required in ODX 2.2, missing in ODX 2.0
+    display_level: int | None
+    cpusage: Usage | None  # Required in ODX 2.2, missing in ODX 2.0
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) -> "BaseComparam":
+    def from_et(et_element: ElementTree.Element, doc_frags: list[OdxDocFragment]) -> "BaseComparam":
         kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, doc_frags))
 
         param_class = odxrequire(et_element.attrib.get("PARAM-CLASS"))
@@ -52,7 +52,7 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
             cpusage=cpusage,
             **kwargs)
 
-    def _build_odxlinks(self) -> Dict[OdxLinkId, Any]:
+    def _build_odxlinks(self) -> dict[OdxLinkId, Any]:
         return {self.odx_id: self}
 
     def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None:

odxtools/basevariantpattern.py

@@ -1,6 +1,5 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import List, Union
 from xml.etree import ElementTree
 
 from typing_extensions import override
@@ -17,11 +16,11 @@ 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]
 
     @staticmethod
     def from_et(et_element: ElementTree.Element,
-                doc_frags: List[OdxDocFragment]) -> "BaseVariantPattern":
+                doc_frags: list[OdxDocFragment]) -> "BaseVariantPattern":
 
         matching_base_variant_parameters = [
             MatchingBaseVariantParameter.from_et(mbvp_el, doc_frags)
@@ -33,6 +32,6 @@ def from_et(et_element: ElementTree.Element,
         return BaseVariantPattern(matching_base_variant_parameters=matching_base_variant_parameters)
 
     @override
-    def get_matching_parameters(
-            self) -> Union[List[MatchingParameter], List[MatchingBaseVariantParameter]]:
+    def get_matching_parameters(self
+                               ) -> list[MatchingParameter] | list[MatchingBaseVariantParameter]:
         return self.matching_base_variant_parameters

odxtools/basicstructure.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: MIT
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any
 from xml.etree import ElementTree
 
 from typing_extensions import override
@@ -30,20 +30,20 @@ class BasicStructure(ComplexDop):
     data objects. All structure-like objects adhere to the
     `CompositeCodec` type protocol.
     """
-    byte_size: Optional[int]
+    byte_size: int | None
     parameters: NamedItemList[Parameter]
 
     @property
-    def required_parameters(self) -> List[Parameter]:
+    def required_parameters(self) -> list[Parameter]:
         return composite_codec_get_required_parameters(self)
 
     @property
-    def free_parameters(self) -> List[Parameter]:
+    def free_parameters(self) -> list[Parameter]:
         return composite_codec_get_free_parameters(self)
 
     @staticmethod
     def from_et(et_element: ElementTree.Element,
-                doc_frags: List[OdxDocFragment]) -> "BasicStructure":
+                doc_frags: list[OdxDocFragment]) -> "BasicStructure":
         """Read a BASIC-STRUCTURE."""
         kwargs = dataclass_fields_asdict(ComplexDop.from_et(et_element, doc_frags))
 
@@ -56,7 +56,7 @@ def from_et(et_element: ElementTree.Element,
 
         return BasicStructure(byte_size=byte_size, parameters=parameters, **kwargs)
 
-    def _build_odxlinks(self) -> Dict[OdxLinkId, Any]:
+    def _build_odxlinks(self) -> dict[OdxLinkId, Any]:
         result = super()._build_odxlinks()
 
         for param in self.parameters:
@@ -79,7 +79,7 @@ def _resolve_snrefs(self, context: SnRefContext) -> None:
 
         context.parameters = None
 
-    def get_static_bit_length(self) -> Optional[int]:
+    def get_static_bit_length(self) -> int | None:
         # Explicit size was specified, so we do not need to look at
         # the list of parameters
         if self.byte_size is not None:
@@ -96,7 +96,7 @@ def print_free_parameters_info(self) -> None:
         print(parameter_info(self.free_parameters), end="")
 
     @override
-    def encode_into_pdu(self, physical_value: Optional[ParameterValue],
+    def encode_into_pdu(self, physical_value: ParameterValue | None,
                         encode_state: EncodeState) -> None:
         orig_pos = encode_state.cursor_byte_position