fix some typing issues

Signed-off-by: Maximilian Deubel <maximilian.deubel@nordicsemi.no>

Author: maxd-nordic

src/nrfcredstore/cli.py

@@ -143,7 +143,7 @@ def run(argv=sys.argv):
         comms = Comms(rtt=True, baudrate=args.baudrate, timeout=args.timeout)
     # If dev is just numbers, assume it's an rtt device
     elif args.dev.isdigit():
-        comms = Comms(rtt = True, serial_number = int(args.dev), timeout=args.timeout)
+        comms = Comms(rtt = True, serial=int(args.dev), timeout=args.timeout)
     # Otherwise, assume it's a serial device
     else:
         comms = Comms(port=args.dev, baudrate=args.baudrate, timeout=args.timeout)

src/nrfcredstore/command_interface.py

@@ -13,6 +13,7 @@
 import hashlib
 import coloredlogs, logging
 import re
+from typing import List, Tuple, Optional
 
 logger = logging.getLogger(__name__)
 
@@ -32,27 +33,27 @@ def write_raw(self, command: str):
         self.comms.write_line(command)
 
     @abstractmethod
-    def write_credential(self, sectag: int, cred_type: int, cred_text: str):
+    def write_credential(self, sectag: int, cred_type: int, cred_text: str) -> bool:
         """Write a credential string to the command interface"""
-        return
+        return False
 
     @abstractmethod
-    def delete_credential(self, sectag: int, cred_type: int):
+    def delete_credential(self, sectag: int, cred_type: int) -> bool:
         """Delete a credential using command interface"""
-        return
+        return False
 
     @abstractmethod
-    def check_credential_exists(self, sectag: int, cred_type: int, get_hash=True):
+    def check_credential_exists(self, sectag: int, cred_type: int, get_hash=True) -> tuple[bool, Optional[str]]:
         """Verify that a credential is installed. If check_hash is true, retrieve the SHA hash."""
-        return
+        return False, None
 
     @abstractmethod
-    def calculate_expected_hash(self, cred_text: str):
+    def calculate_expected_hash(self, cred_text: str) -> str:
         """Returns the expected digest/hash for a given credential as a string"""
-        return
+        return ""
 
     @abstractmethod
-    def get_csr(self, sectag: int, attributes: str):
+    def get_csr(self, sectag: int, attributes: str) -> Optional[str]:
         """Generate a private/public keypair and a corresponding Certificate Signing Request.
 
         Returns:
@@ -61,17 +62,17 @@ def get_csr(self, sectag: int, attributes: str):
         return
 
     @abstractmethod
-    def go_offline(self):
+    def go_offline(self) -> bool:
         """Tell the device to go offline so that credentials can be modified"""
-        return
+        return False
 
     @abstractmethod
-    def get_imei(self):
+    def get_imei(self) -> Optional[str]:
         """Get device IMEI, if applicable"""
         return
 
     @abstractmethod
-    def get_mfw_version(self):
+    def get_mfw_version(self) -> Optional[str]:
         """Get modem firmware version, if applicable"""
         return
 
@@ -275,7 +276,7 @@ def get_csr(self, sectag=0, attributes=""):
 
     def go_offline(self):
         # TLS credentials shell has no concept of online/offline. Just no-op.
-        pass
+        return True
 
     def get_imei(self):
         raise RuntimeError("The TLS Credentials Shell does not support IMEI extraction")

src/nrfcredstore/comms.py

@@ -9,6 +9,7 @@
 # Both serial and RTT backends are supported.
 
 from serial.tools import list_ports
+from serial.tools.list_ports_common import ListPortInfo
 import serial
 from collections import defaultdict
 import sys
@@ -19,7 +20,7 @@
 import coloredlogs, logging
 import re
 import platform
-from typing import Tuple, List, Union
+from typing import Tuple, List, Union, Optional
 
 logger = logging.getLogger(__name__)
 
@@ -103,7 +104,7 @@ def parser_add_comms_args(parser):
 
 
 # Returns a list of printable name, serial number and serial port for connected Nordic boards
-def get_connected_nordic_boards() -> List[Tuple[str, Union[str, int], serial.Serial]]:
+def get_connected_nordic_boards() -> List[Tuple[str, Union[str, int], ListPortInfo]]:
     if platform.system() == 'Darwin':
         ports = sorted(list_ports.comports(), key=lambda x: x.device)
     else:
@@ -129,7 +130,7 @@ def get_connected_jlinks() -> List[int]:
 
 
 # For a serial device, return the serial number
-def extract_serial_number_from_serial_device(dev : serial.Serial) -> Union[str, int, None]:
+def extract_serial_number_from_serial_device(dev: ListPortInfo) -> Union[str, int, None]:
     hwid = dev.hwid
     # Get serial number from hwid, because port.serial_number is not always available
     serial = [x[4:] for x in hwid.split(" ") if x.startswith("SER=")]
@@ -142,7 +143,7 @@ def extract_serial_number_from_serial_device(dev : serial.Serial) -> Union[str,
 
     return serial
 
-def extract_product_name_from_serial_device(dev : serial.Serial) -> str:
+def extract_product_name_from_serial_device(dev: ListPortInfo) -> str:
     for pattern, name, main_port in usb_patterns:
         if f"SER={pattern}" in dev.hwid:
             return name
@@ -151,16 +152,16 @@ def extract_product_name_from_serial_device(dev : serial.Serial) -> str:
             return text
     return ''
 
-def extract_product_name_from_jlink_serial(serial : str) -> str:
-    serial = f"{serial:012}"
+def extract_product_name_from_jlink_serial(serial : int) -> str:
+    serial_str = f"{serial:012}"
     for pattern, name, main_port in usb_patterns:
-        if pattern in serial:
+        if pattern in serial_str:
             return name
     return ''
 
 
 # Find the main port for a device if it's a Nordic board
-def get_port_index(dev : serial.Serial) -> Union[int, None]:
+def get_port_index(dev: ListPortInfo) -> Optional[int]:
     for pattern, name, main_port in usb_patterns:
         if f"SER={pattern}" in dev.hwid:
             return main_port
@@ -195,7 +196,7 @@ def select_jlink(jlinks : List[int], list_all: bool) -> int:
     return answer["serial"]
 
 
-def select_device_by_serial(serial_number : Union[str, int], list_all : bool) -> Tuple[serial.Serial, Union[str, int]]:
+def select_device_by_serial(serial_number : Union[str, int], list_all : bool) -> Tuple[ListPortInfo, Union[str, int]]:
     serial_devices = [
         x
         for x in list_ports.comports()
@@ -222,7 +223,7 @@ def select_device_by_serial(serial_number : Union[str, int], list_all : bool) ->
 
 
 # Returns serial_port, serial_number of selected device
-def select_device(rtt : bool, serial_number : Union[None, int, str], port : Union[None, serial.Serial], list_all : bool) -> Tuple[serial.Serial, Union[str, int]]:
+def select_device(rtt : bool, serial_number : Optional[Union[str, int]], port : Optional[ListPortInfo], list_all : bool) -> Tuple[Optional[ListPortInfo], Optional[Union[str, int]]]:
     if type(serial_number) == str and serial_number.isdigit():
         serial_number = int(serial_number)
 
@@ -372,7 +373,7 @@ def write_line(self, data : str):
         logger.debug(f"> {data}")
         self.write((data + self.line_ending).encode('ascii'))
 
-    def _readline_rtt(self) -> str:
+    def _readline_rtt(self) -> Optional[str]:
         time_end = time.time() + self.timeout
         while time.time() < time_end:
             self._rtt_line_buffer += self.jlink_api.rtt_read(channel_index=0, length=4096)
@@ -387,7 +388,7 @@ def _readline_rtt(self) -> str:
             time.sleep(0.1)
         return None
 
-    def _readline_serial(self) -> str:
+    def _readline_serial(self) -> Optional[str]:
         # Read a line from the serial port
         line = self.serial_api.readline()
         if line: