tools: Add python types hints

tools/mkuf2.py

@@ -11,11 +11,12 @@ import json
 import os
 import struct
 from functools import partial
+from typing import Dict, List
 
 from future.utils import iteritems
 
 
-def round_up_int_div(n, d):
+def round_up_int_div(n: int, d: int) -> int:
     # equivalent to math.ceil(n / d)
     return (n + d - 1) // d
 
@@ -32,23 +33,23 @@ class UF2Writer(object):
     UF2_FLAG_FAMILYID_PRESENT = 0x00002000
     UF2_FLAG_MD5_PRESENT = 0x00004000
 
-    def __init__(self, chip_id, output_file, chunk_size):
+    def __init__(self, chip_id: int, output_file: os.PathLike, chunk_size: int) -> None:
         self.chip_id = chip_id
         self.CHUNK_SIZE = self.UF2_DATA_SIZE - self.UF2_MD5_PART_SIZE if chunk_size is None else chunk_size
         self.f = open(output_file, 'wb')
 
-    def __enter__(self):
+    def __enter__(self) -> 'UF2Writer':
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(self, exc_type: str, exc_val: int, exc_tb: List) -> None:
         if self.f:
             self.f.close()
 
     @staticmethod
-    def _to_uint32(num):
+    def _to_uint32(num: int) -> bytes:
         return struct.pack('<I', num)
 
-    def _write_block(self, addr, chunk, len_chunk, block_no, blocks):
+    def _write_block(self, addr: int, chunk: bytes, len_chunk: int, block_no: int, blocks: int) -> None:
         assert len_chunk > 0
         assert len_chunk <= self.CHUNK_SIZE
         assert block_no < blocks
@@ -73,7 +74,7 @@ class UF2Writer(object):
         assert len(block) == self.UF2_BLOCK_SIZE
         self.f.write(block)
 
-    def add_file(self, addr, f_path):
+    def add_file(self, addr: int, f_path: os.PathLike) -> None:
         blocks = round_up_int_div(os.path.getsize(f_path), self.CHUNK_SIZE)
         with open(f_path, 'rb') as fin:
             a = addr
@@ -83,7 +84,7 @@ class UF2Writer(object):
                 a += len_chunk
 
 
-def action_write(args):
+def action_write(args: Dict) -> None:
     with UF2Writer(args['chip_id'], args['output_file'], args['chunk_size']) as writer:
         for addr, f in args['files']:
             print('Adding {} at {:#x}'.format(f, addr))
@@ -91,19 +92,19 @@ def action_write(args):
     print('"{}" has been written.'.format(args['output_file']))
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser()
 
-    def four_byte_aligned(integer):
+    def four_byte_aligned(integer: int) -> bool:
         return integer & 3 == 0
 
-    def parse_chunk_size(string):
+    def parse_chunk_size(string: str) -> int:
         num = int(string, 0)
         if not four_byte_aligned(num):
             raise argparse.ArgumentTypeError('Chunk size should be a 4-byte aligned number')
         return num
 
-    def parse_chip_id(string):
+    def parse_chip_id(string: str) -> int:
         num = int(string, 16)
         if num < 0 or num > 0xFFFFFFFF:
             raise argparse.ArgumentTypeError('Chip ID should be a 4-byte unsigned integer')
@@ -137,12 +138,12 @@ def main():
 
     args = parser.parse_args()
 
-    def check_file(file_name):
+    def check_file(file_name: str) -> str:
         if not os.path.isfile(file_name):
             raise RuntimeError('{} is not a regular file!'.format(file_name))
         return file_name
 
-    def parse_addr(string):
+    def parse_addr(string: str) -> int:
         num = int(string, 0)
         if not four_byte_aligned(num):
             raise RuntimeError('{} is not a 4-byte aligned valid address'.format(string))
@@ -155,7 +156,7 @@ def main():
     if args.json:
         json_dir = os.path.dirname(os.path.abspath(args.json))
 
-        def process_json_file(path):
+        def process_json_file(path: str) -> str:
             '''
             The input path is relative to json_dir. This function makes it relative to the current working
             directory.