Refactor update dev version

Refactor update dev version

Author: JE-Chen

.idea/workspace.xml

@@ -1,4 +1,4 @@
-import typing
+from typing import Callable, Any
 from sys import stderr
 
 from je_auto_control.utils.exception.exception_tags import get_bad_trigger_method, get_bad_trigger_function
@@ -122,11 +122,11 @@ def __init__(self):
     def callback_function(
             self,
             trigger_function_name: str,
-            callback_function: typing.Callable,
+            callback_function: Callable,
             callback_function_param: [dict, None] = None,
             callback_param_method: str = "kwargs",
             **kwargs
-    ) -> typing.Any:
+    ) -> Any:
         """
         :param trigger_function_name: what function we want to trigger only accept function in event_dict
         :param callback_function: what function we want to callback
@@ -155,4 +155,3 @@ def callback_function(
 
 callback_executor = CallbackFunctionExecutor()
 package_manager.callback_executor = callback_executor
-

je_auto_control/utils/callback/callback_function_executor.py

@@ -1,7 +1,7 @@
 import builtins
-import sys
 import types
 from inspect import getmembers, isbuiltin
+from typing import Any, Dict, List
 
 from je_auto_control.utils.exception.exception_tags import action_is_null_error, add_command_exception, \
     executor_list_error
@@ -94,7 +94,7 @@ def __init__(self):
         for function in getmembers(builtins, isbuiltin):
             self.event_dict.update({str(function[0]): function[1]})
 
-    def _execute_event(self, action: list):
+    def _execute_event(self, action: list) -> Any:
         event = self.event_dict.get(action[0])
         if len(action) == 2:
             if isinstance(action[1], dict):
@@ -106,7 +106,7 @@ def _execute_event(self, action: list):
         else:
             raise AutoControlActionException(cant_execute_action_error + " " + str(action))
 
-    def execute_action(self, action_list: [list, dict]) -> dict:
+    def execute_action(self, action_list: [list, dict]) -> Dict[str, str]:
         """
         use to execute all action on action list(action file or program list)
         :param action_list the list include action
@@ -145,7 +145,7 @@ def execute_action(self, action_list: [list, dict]) -> dict:
             print(value, flush=True)
         return execute_record_dict
 
-    def execute_files(self, execute_files_list: list) -> list:
+    def execute_files(self, execute_files_list: list) -> List[Dict[str, str]]:
         """
         :param execute_files_list: list include execute files path
         :return: every execute detail as list
@@ -161,7 +161,7 @@ def execute_files(self, execute_files_list: list) -> list:
 package_manager.executor = executor
 
 
-def add_command_to_executor(command_dict: dict):
+def add_command_to_executor(command_dict: dict) -> None:
     """
     :param command_dict: dict include command we want to add to event_dict
     """
@@ -172,9 +172,9 @@ def add_command_to_executor(command_dict: dict):
             raise AutoControlAddCommandException(add_command_exception)
 
 
-def execute_action(action_list: list) -> dict:
+def execute_action(action_list: list) -> Dict[str, str]:
     return executor.execute_action(action_list)
 
 
-def execute_files(execute_files_list: list) -> list:
+def execute_files(execute_files_list: list) -> List[Dict[str, str]]:
     return executor.execute_files(execute_files_list)

je_auto_control/utils/executor/action_executor.py

@@ -150,7 +150,7 @@ def generate_html() -> str:
     return new_html_string
 
 
-def generate_html_report(html_name: str = "default_name"):
+def generate_html_report(html_name: str = "default_name") -> None:
     auto_control_logger.info(f"generate_html_report, html_name: {html_name}")
     """
     Output html report file

je_auto_control/utils/generate_report/generate_html_report.py

@@ -1,5 +1,4 @@
 import json
-import sys
 from threading import Lock
 
 from je_auto_control.utils.exception.exception_tags import cant_generate_json_report
@@ -8,7 +7,7 @@
 from je_auto_control.utils.test_record.record_test_class import test_record_instance
 
 
-def generate_json():
+def generate_json() -> tuple[dict[str, dict[str, str]], dict[str, dict[str, str]]]:
     auto_control_logger.info("generate_json")
     """
     :return: two dict {success_dict}, {failure_dict}

je_auto_control/utils/generate_report/generate_json_report.py

@@ -1,13 +1,13 @@
-import sys
 from threading import Lock
 from xml.dom.minidom import parseString
+from typing import Tuple, Dict, Union
 
 from je_auto_control.utils.generate_report.generate_json_report import generate_json
 from je_auto_control.utils.logging.loggin_instance import auto_control_logger
 from je_auto_control.utils.xml.change_xml_structure.change_xml_structure import dict_to_elements_tree
 
 
-def generate_xml():
+def generate_xml() -> Tuple[Union[str, bytes], Union[str, bytes]]:
     auto_control_logger.info("generate_xml")
     """
     :return: two dict {success_dict}, {failure_dict}
@@ -52,4 +52,3 @@ def generate_xml_report(xml_file_name: str = "default_name"):
             f"failed: {repr(error)}")
     finally:
         lock.release()
-

je_auto_control/utils/generate_report/generate_xml_report.py

@@ -1,6 +1,7 @@
 import json
 from pathlib import Path
 from threading import Lock
+from typing import List, Dict
 
 from je_auto_control.utils.exception.exception_tags import cant_find_json_error
 from je_auto_control.utils.exception.exception_tags import cant_save_json_error
@@ -9,7 +10,7 @@
 _lock = Lock()
 
 
-def read_action_json(json_file_path: str) -> list:
+def read_action_json(json_file_path: str) -> List[List[Dict[str, Dict[str, str]]]]:
     """
     use to read action file
     :param json_file_path json file's path to read

je_auto_control/utils/json/json_file.py

@@ -2,6 +2,7 @@
 from importlib.util import find_spec
 from inspect import getmembers, isfunction, isbuiltin, isclass
 from sys import stderr
+from typing import Union, Callable
 
 from je_auto_control.utils.logging.loggin_instance import auto_control_logger
 
@@ -14,7 +15,7 @@ def __init__(self):
         self.executor = None
         self.callback_executor = None
 
-    def check_package(self, package: str):
+    def check_package(self, package: str) -> Union[None, dict[str, Callable]]:
         """
         :param package: package to check exists or not
         :return: package if find else None
@@ -30,7 +31,7 @@ def check_package(self, package: str):
                     print(repr(error), file=stderr)
         return self.installed_package_dict.get(package, None)
 
-    def add_package_to_executor(self, package):
+    def add_package_to_executor(self, package) -> None:
         auto_control_logger.info(f"add_package_to_executor, package: {package}")
         """
         :param package: package's function will add to executor
@@ -40,7 +41,7 @@ def add_package_to_executor(self, package):
             target=self.executor
         )
 
-    def add_package_to_callback_executor(self, package):
+    def add_package_to_callback_executor(self, package) -> None:
         auto_control_logger.info(f"add_package_to_callback_executor, package: {package}")
         """
         :param package: package's function will add to callback_executor
@@ -50,7 +51,7 @@ def add_package_to_callback_executor(self, package):
             target=self.callback_executor
         )
 
-    def get_member(self, package, predicate, target):
+    def get_member(self, package, predicate, target) -> None:
         """
         :param package: package we want to get member
         :param predicate: predicate
@@ -67,7 +68,7 @@ def get_member(self, package, predicate, target):
         else:
             print(f"Executor error {self.executor}", file=stderr)
 
-    def add_package_to_target(self, package, target):
+    def add_package_to_target(self, package, target) -> None:
         """
         :param package: package we want to get member
         :param target: which event_dict will be added