Lint more python scripts

hw/production_test/Makefile

@@ -3,7 +3,9 @@ SHELL := /bin/bash
 PYTHON_FILES = \
     usb_test.py \
     icenvcm.py \
-    icebin2nvcm.py
+    icebin2nvcm.py \
+    encode_usb_strings.py \
+    reset.py
 
 lint:
 	autopep8 --in-place --max-line-length 70 --aggressive --aggressive  ${PYTHON_FILES}

hw/production_test/encode_usb_strings.py

@@ -4,87 +4,101 @@ manufacturer = 'Mullvad'
 product = 'MTA1-USB-V1'
 serial = "68de5d27-e223-4874-bc76-a54d6e84068f"
 
-def descriptor_to_string(descriptor):
+
-    """ Convert a bytes object containing a USB string descriptor into a python string"""
+def descriptor_to_string(descriptor: bytes) -> str:
+    """ Convert a USB string descriptor into a python string
+
+    Keyword arguments:
+    descriptor -- UTF-16 formatted USB descriptor string
+    """
     bLength = descriptor[0]
     if bLength != len(descriptor):
-        raise Exception('Descriptor length mismatch, length_field:{} actual_length:{}'.format(
+        raise Exception(
-                bLength,
+            'Length mismatch, length_field:{:} actual_length:{:}'
-                len(descriptor)
+            .format(bLength, len(descriptor)))
-                ))
 
     bDescriptorType = descriptor[1]
     if bDescriptorType != 0x03:
-        raise Exception('Descriptor type mismatch, bDescriptorType:{02x} expected:0x03'.format(
+        raise Exception(
-            bDescriptorType
+            'Type mismatch, bDescriptorType:{:02x} expected:0x03'
-            ))
+            .format(bDescriptorType))
 
     return descriptor[2:].decode('utf-16', errors='strict')
 
-def string_to_descriptor(string):
+
-    """ Convert a python string into a bytes object containing a USB string descriptor"""
+def string_to_descriptor(string: str) -> bytes:
+    """ Convert a python string into a USB string descriptor
+
+    Keyword arguments:
+    string: String to convert
+    """
     descriptor = bytearray()
-    descriptor.append(0x00) # placeholder for length
+    descriptor.append(0x00)  # placeholder for length
     descriptor.append(0x03)
-    descriptor.extend(string.encode('utf-16')[2:]) # crop the BOM
+    descriptor.extend(string.encode('utf-16')[2:])  # crop the BOM
     descriptor[0] = len(descriptor)
 
     return bytes(descriptor)
 
 
 if __name__ == "__main__":
-    #serial = bytes([
+    # serial = bytes([
     #    0x14,0x03,
     #    0x32,0x00,0x30,0x00,0x31,0x00,0x37,0x00,0x2D,0x00,
     #    0x32,0x00,0x2D,0x00,
     #    0x32,0x00,0x35,0x00
     #    ])
-    #print(descriptor_to_string(serial))
+    # print(descriptor_to_string(serial))
 
-    #sample_product = bytes([
+    # sample_product = bytes([
     #    0x14,0x03,
     #    0x43,0x00,0x48,0x00,0x35,0x00,0x35,0x00,0x34,0x00,0x5F,0x00,
     #    0x43,0x00,0x44,0x00,0x43,0x00
     #    ])
-    #print(descriptor_to_string(sample_product))
+    # print(descriptor_to_string(sample_product))
-    #rt = string_to_descriptor(descriptor_to_string(sample_product))
+    # rt = string_to_descriptor(descriptor_to_string(sample_product))
-    #print(descriptor_to_string(rt))
+    # print(descriptor_to_string(rt))
     #
-    #print(['{:02x} '.format(i) for i in sample_product])
+    # print(['{:02x} '.format(i) for i in sample_product])
-    #print(['{:02x} '.format(i) for i in rt])
+    # print(['{:02x} '.format(i) for i in rt])
 
-    
+    # sample_mfr = bytes([
-    #sample_mfr = bytes([
     #    0x0A,0x03,
     #    0x5F,0x6c,0xCF,0x82,0x81,0x6c,0x52,0x60,
     #    ])
-    #print(descriptor_to_string(sample_mfr))
+    # print(descriptor_to_string(sample_mfr))
-    #rt = string_to_descriptor(descriptor_to_string(sample_mfr))
+    # rt = string_to_descriptor(descriptor_to_string(sample_mfr))
-    #print(descriptor_to_string(rt))
+    # print(descriptor_to_string(rt))
     #
-    #print(['{:02x} '.format(i) for i in sample_mfr])
+    # print(['{:02x} '.format(i) for i in sample_mfr])
-    #print(['{:02x} '.format(i) for i in rt])
+    # print(['{:02x} '.format(i) for i in rt])
-    
-    
 
     with open('usb_strings.h', 'w') as f:
         f.write('#ifndef USB_STRINGS\n')
         f.write('#define USB_STRINGS\n')
 
-        f.write('unsigned char __code Prod_Des[]={{  // "{}"\n'.format(product))
+        f.write(
+            'unsigned char __code Prod_Des[]={{  // "{}"\n'
+            .format(product))
         f.write('    ')
-        f.write(', '.join(['0x{:02x}'.format(i) for i in string_to_descriptor(product)]))
+        f.write(', '.join(['0x{:02x}'.format(i)
+                for i in string_to_descriptor(product)]))
         f.write('\n};\n')
 
-        f.write('unsigned char __code Manuf_Des[]={{  // "{}"\n'.format(manufacturer))
+        f.write(
+            'unsigned char __code Manuf_Des[]={{  // "{}"\n'
+            .format(manufacturer))
         f.write('    ')
-        f.write(', '.join(['0x{:02x}'.format(i) for i in string_to_descriptor(manufacturer)]))
+        f.write(', '.join(['0x{:02x}'.format(i)
+                for i in string_to_descriptor(manufacturer)]))
         f.write('\n};\n')
 
-        f.write('unsigned char __code SerDes[]={{  // "{}"\n'.format(serial))
+        f.write(
+            'unsigned char __code SerDes[]={{  // "{}"\n'
+            .format(serial))
         f.write('    ')
-        f.write(', '.join(['0x{:02x}'.format(i) for i in string_to_descriptor(serial)]))
+        f.write(', '.join(['0x{:02x}'.format(i)
+                for i in string_to_descriptor(serial)]))
         f.write('\n};\n')
 
-    
         f.write('#endif\n')

hw/production_test/reset.py

@@ -1,16 +1,20 @@
 #!/usr/bin/env python
-import hid_test
+import hid_test  # type: ignore
 import time
 
 
-def reset_tk1():
+def reset_tk1() -> None:
-    """Manipulate the GPIO lines on the MTA1-USB-CH552 Programmer to issue a
+    """ Reset a TK1 contained in a TP1 programmer
-    hardware reset to the TK1. The result is that TK1 again will be in firmware
+
-    mode, so a new app can be loaded."""
+    Manipulate the GPIO lines on the TP1 to issue a hardware reset
+    to the TK1. The result is that TK1 again will be in firmware
+    mode, so a new app can be loaded.
+    """
     d = hid_test.ice40_flasher()
     d.gpio_set_direction(14, True)
     d.gpio_put(14, False)
     d.gpio_set_direction(14, False)
     d.close()
 
+
 reset_tk1()