wip comms module testing

Author: maxd-nordic

src/nrfcredstore/comms.py

@@ -19,6 +19,7 @@
 import coloredlogs, logging
 import re
 import platform
+from typing import Tuple, List, Union
 
 logger = logging.getLogger(__name__)
 
@@ -102,7 +103,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():
+def get_connected_nordic_boards() -> List[Tuple[str, Union[str, int], serial.Serial]]:
     if platform.system() == 'Darwin':
         ports = sorted(list_ports.comports(), key=lambda x: x.device)
     else:
@@ -122,13 +123,13 @@ def get_connected_nordic_boards():
 
 
 # returns a list of SEGGER J-Link serial numbers as int
-def get_connected_jlinks():
+def get_connected_jlinks() -> List[int]:
     with LowLevel.API(LowLevel.DeviceFamily.UNKNOWN) as api:
         return api.enum_emu_snr() or []
 
 
 # for a serial device, return the serial number
-def extract_serial_number_from_serial_device(dev):
+def extract_serial_number_from_serial_device(dev : serial.Serial) -> 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=")]
@@ -141,7 +142,7 @@ def extract_serial_number_from_serial_device(dev):
 
     return serial
 
-def extract_product_name_from_serial_device(dev):
+def extract_product_name_from_serial_device(dev : serial.Serial) -> str:
     for pattern, name, main_port in usb_patterns:
         if f"SER={pattern}" in dev.hwid:
             return name
@@ -150,7 +151,7 @@ def extract_product_name_from_serial_device(dev):
             return text
     return ''
 
-def extract_product_name_from_jlink_serial(serial):
+def extract_product_name_from_jlink_serial(serial : str) -> str:
     serial = f"{serial:012}"
     for pattern, name, main_port in usb_patterns:
         if pattern in serial:
@@ -159,14 +160,14 @@ def extract_product_name_from_jlink_serial(serial):
 
 
 # find the main port for a device if it's a Nordic board
-def get_port_index(dev):
+def get_port_index(dev : serial.Serial) -> Union[int, None]:
     for pattern, name, main_port in usb_patterns:
         if f"SER={pattern}" in dev.hwid:
             return main_port
     return None
 
 
-def select_jlink(jlinks, list_all):
+def select_jlink(jlinks : List[int], list_all: bool) -> int:
     if len(jlinks) == 0:
         raise Exception("No J-Link device found")
     if len(jlinks) == 1:
@@ -194,7 +195,7 @@ def select_jlink(jlinks, list_all):
     return answer["serial"]
 
 
-def select_device_by_serial(serial_number, list_all):
+def select_device_by_serial(serial_number : Union[str, int], list_all : bool) -> Tuple[serial.Serial, Union[str, int]]:
     serial_devices = [
         x
         for x in list_ports.comports()
@@ -221,7 +222,7 @@ def select_device_by_serial(serial_number, list_all):
 
 
 # returns serial_port, serial_number of selected device
-def select_device(rtt, serial_number, port, list_all):
+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]]:
     if type(serial_number) == str and serial_number.isdigit():
         serial_number = int(serial_number)
 
@@ -247,7 +248,7 @@ def select_device(rtt, serial_number, port, list_all):
             logger.warning(
                 f"Given Serial number {serial_number} does not match device serial number {extracted_serial_number}"
             )
-        return (serial_devices[0], serial_number)
+        return (serial_devices[0], extracted_serial_number)
 
     if serial_number:
         # Often, there are multiple serial ports for a device, so we need to find the right one