tools: Add python types hints

tools/idf_py_actions/serial_ext.py

@@ -4,18 +4,19 @@
 import json
 import os
 import sys
+from typing import Any, Dict, List
 
 import click
 from idf_monitor_base.output_helpers import yellow_print
 from idf_py_actions.errors import FatalError, NoSerialPortFoundError
 from idf_py_actions.global_options import global_options
-from idf_py_actions.tools import ensure_build_directory, get_sdkconfig_value, run_target, run_tool
+from idf_py_actions.tools import PropertyDict, ensure_build_directory, get_sdkconfig_value, run_target, run_tool
 
 PYTHON = sys.executable
 
 
-def action_extensions(base_actions, project_path):
-    def _get_project_desc(ctx, args):
+def action_extensions(base_actions: Dict, project_path: str) -> Dict:
+    def _get_project_desc(ctx: click.core.Context, args: PropertyDict) -> Any:
         desc_path = os.path.join(args.build_dir, 'project_description.json')
         if not os.path.exists(desc_path):
             ensure_build_directory(args, ctx.info_name)
@@ -23,7 +24,7 @@ def action_extensions(base_actions, project_path):
             project_desc = json.load(f)
         return project_desc
 
-    def _get_default_serial_port(args):
+    def _get_default_serial_port(args: PropertyDict) -> Any:
         # Import is done here in order to move it after the check_environment() ensured that pyserial has been installed
         try:
             import esptool
@@ -45,7 +46,7 @@ def action_extensions(base_actions, project_path):
         except Exception as e:
             raise FatalError('An exception occurred during detection of the serial port: {}'.format(e))
 
-    def _get_esptool_args(args):
+    def _get_esptool_args(args: PropertyDict) -> List:
         esptool_path = os.path.join(os.environ['IDF_PATH'], 'components/esptool_py/esptool/esptool.py')
         esptool_wrapper_path = os.environ.get('ESPTOOL_WRAPPER', '')
         if args.port is None:
@@ -68,7 +69,7 @@ def action_extensions(base_actions, project_path):
             result += ['--no-stub']
         return result
 
-    def _get_commandline_options(ctx):
+    def _get_commandline_options(ctx: click.core.Context) -> List:
         """ Return all the command line options up to first action """
         # This approach ignores argument parsing done Click
         result = []
@@ -81,7 +82,8 @@ def action_extensions(base_actions, project_path):
 
         return result
 
-    def monitor(action, ctx, args, print_filter, monitor_baud, encrypted, no_reset, timestamps, timestamp_format):
+    def monitor(action: str, ctx: click.core.Context, args: PropertyDict, print_filter: str, monitor_baud: str, encrypted: bool,
+                no_reset: bool, timestamps: bool, timestamp_format: str) -> None:
         """
         Run idf_monitor.py to watch build output
         """
@@ -152,7 +154,7 @@ def action_extensions(base_actions, project_path):
 
         run_tool('idf_monitor', monitor_args, args.project_dir)
 
-    def flash(action, ctx, args):
+    def flash(action: str, ctx: click.core.Context, args: PropertyDict) -> None:
         """
         Run esptool to flash the entire project, from an argfile generated by the build system
         """
@@ -165,13 +167,13 @@ def action_extensions(base_actions, project_path):
         esp_port = args.port or _get_default_serial_port(args)
         run_target(action, args, {'ESPBAUD': str(args.baud), 'ESPPORT': esp_port})
 
-    def erase_flash(action, ctx, args):
+    def erase_flash(action: str, ctx: click.core.Context, args: PropertyDict) -> None:
         ensure_build_directory(args, ctx.info_name)
         esptool_args = _get_esptool_args(args)
         esptool_args += ['erase_flash']
         run_tool('esptool.py', esptool_args, args.build_dir)
 
-    def global_callback(ctx, global_args, tasks):
+    def global_callback(ctx: click.core.Context, global_args: Dict, tasks: PropertyDict) -> None:
         encryption = any([task.name in ('encrypted-flash', 'encrypted-app-flash') for task in tasks])
         if encryption:
             for task in tasks:
@@ -179,7 +181,7 @@ def action_extensions(base_actions, project_path):
                     task.action_args['encrypted'] = True
                     break
 
-    def ota_targets(target_name, ctx, args):
+    def ota_targets(target_name: str, ctx: click.core.Context, args: PropertyDict) -> None:
         """
         Execute the target build system to build target 'target_name'.
         Additionally set global variables for baud and port.