Fix add module error & Add create project and template

JE-Chen · JE-Chen · commit 5aca927e74c8 · 2023-04-10T11:25:24.000+08:00
Fix add module error &amp; Add create project and template
diff --git a/je_auto_control/__init__.py b/je_auto_control/__init__.py
@@ -32,8 +32,8 @@
 from je_auto_control.utils.executor.action_executor import execute_action
 from je_auto_control.utils.executor.action_executor import execute_files
 from je_auto_control.utils.executor.action_executor import executor
-from je_auto_control.utils.file_process.create_project_structure import \
-    create_template_dir
+from je_auto_control.utils.project.create_project_structure import \
+    create_project_dir
 # file process
 from je_auto_control.utils.file_process.get_dir_file_list import \
     get_dir_files_as_list
@@ -119,7 +119,7 @@
     "generate_html", "generate_html_report",
     "generate_json", "generate_json_report",
     "generate_xml", "generate_xml_report",
-    "get_dir_files_as_list", "create_template_dir",
+    "get_dir_files_as_list", "create_project_dir",
     "start_autocontrol_socket_server",
     "callback_executor", "package_manager",
     "get_special_table"
diff --git a/je_auto_control/utils/callback/callback_function_executor.py b/je_auto_control/utils/callback/callback_function_executor.py
@@ -6,7 +6,7 @@
 # executor
 from je_auto_control.utils.executor.action_executor import execute_action
 from je_auto_control.utils.executor.action_executor import execute_files
-from je_auto_control.utils.file_process.create_project_structure import create_template_dir
+from je_auto_control.utils.project.create_project_structure import create_project_dir
 # file process
 from je_auto_control.utils.file_process.get_dir_file_list import get_dir_files_as_list
 # html report
@@ -101,7 +101,7 @@ def __init__(self):
             # execute
             "execute_action": execute_action,
             "execute_files": execute_files,
-            "create_template_dir": create_template_dir,
+            "create_template_dir": create_project_dir,
             "get_dir_files_as_list": get_dir_files_as_list,
             "pil_screenshot": pil_screenshot,
             "read_action_json": read_action_json,
diff --git a/je_auto_control/utils/executor/action_executor.py b/je_auto_control/utils/executor/action_executor.py
@@ -1,6 +1,7 @@
 import sys
 import time
 import types
+import builtins
 from inspect import getmembers, isbuiltin
 
 from je_auto_control.utils.exception.exception_tags import action_is_null_error, add_command_exception_tag, \
@@ -80,9 +81,9 @@ def __init__(self):
             "add_package_to_executor": package_manager.add_package_to_executor,
             "add_package_to_callback_executor": package_manager.add_package_to_callback_executor
         }
-        # get all time module builtin function and add to event dict
-        for function in getmembers(time, isbuiltin):
-            self.event_dict.update({str(function): function})
+        # get all builtin function and add to event dict
+        for function in getmembers(builtins, isbuiltin):
+            self.event_dict.update({str(function[0]): function[1]})
 
     def _execute_event(self, action: list):
         event = self.event_dict.get(action[0])
diff --git a/je_auto_control/utils/file_process/create_project_structure.py b/je_auto_control/utils/file_process/create_project_structure.py
diff --git a/je_auto_control/utils/generate_report/generate_html_report.py b/je_auto_control/utils/generate_report/generate_html_report.py
@@ -154,8 +154,8 @@ def generate_html_report(html_name: str = "default_name"):
     :param html_name: save html file name
     """
     new_html_string = generate_html()
+    _lock.acquire()
     try:
-        _lock.acquire()
         with open(html_name + ".html", "w+") as file_to_write:
             file_to_write.write(
                 new_html_string
diff --git a/je_auto_control/utils/generate_report/generate_json_report.py b/je_auto_control/utils/generate_report/generate_json_report.py
@@ -55,16 +55,16 @@ def generate_json_report(json_file_name: str = "default_name"):
     """
     lock = Lock()
     success_dict, failure_dict = generate_json()
+    lock.acquire()
     try:
-        lock.acquire()
         with open(json_file_name + "_success.json", "w+") as file_to_write:
             json.dump(dict(success_dict), file_to_write, indent=4)
     except Exception as error:
         print(repr(error), file=sys.stderr)
     finally:
         lock.release()
+    lock.acquire()
     try:
-        lock.acquire()
         with open(json_file_name + "_failure.json", "w+") as file_to_write:
             json.dump(dict(failure_dict), file_to_write, indent=4)
     except Exception as error:
diff --git a/je_auto_control/utils/generate_report/generate_xml_report.py b/je_auto_control/utils/generate_report/generate_xml_report.py
@@ -27,16 +27,16 @@ def generate_xml_report(xml_file_name: str = "default_name"):
     success_xml = success_xml.toprettyxml()
     failure_xml = failure_xml.toprettyxml()
     lock = Lock()
+    lock.acquire()
     try:
-        lock.acquire()
         with open(xml_file_name + "_failure.xml", "w+") as file_to_write:
             file_to_write.write(failure_xml)
     except Exception as error:
         print(repr(error), file=sys.stderr)
     finally:
         lock.release()
+    lock.acquire()
     try:
-        lock.acquire()
         with open(xml_file_name + "_success.xml", "w+") as file_to_write:
             file_to_write.write(success_xml)
             pass
diff --git a/je_auto_control/utils/json/json_file.py b/je_auto_control/utils/json/json_file.py
@@ -14,8 +14,8 @@ def read_action_json(json_file_path: str) -> list:
     use to read action file
     :param json_file_path json file's path to read
     """
+    _lock.acquire()
     try:
-        _lock.acquire()
         file_path = Path(json_file_path)
         if file_path.exists() and file_path.is_file():
             with open(json_file_path) as read_file:
@@ -32,10 +32,10 @@ def write_action_json(json_save_path: str, action_json: list) -> None:
     :param json_save_path  json save path
     :param action_json the json str include action to write
     """
+    _lock.acquire()
     try:
-        _lock.acquire()
         with open(json_save_path, "w+") as file_to_write:
-            file_to_write.write(json.dumps(action_json))
+            file_to_write.write(json.dumps(action_json, indent=4))
     except AutoControlJsonActionException:
         raise AutoControlJsonActionException(cant_save_json_error)
     finally:
diff --git a/je_auto_control/utils/project/__init__.py b/je_auto_control/utils/project/__init__.py
diff --git a/je_auto_control/utils/project/create_project_structure.py b/je_auto_control/utils/project/create_project_structure.py
@@ -0,0 +1,54 @@
+from pathlib import Path
+from os import getcwd
+from threading import Lock
+
+from je_auto_control.utils.json.json_file import write_action_json
+from je_auto_control.utils.project.template.template_executor import executor_template_1, \
+    executor_template_2
+from je_auto_control.utils.project.template.template_keyword import template_keyword_1, \
+    template_keyword_2
+
+
+def create_dir(dir_name: str) -> None:
+    """
+    :param dir_name: create dir use dir name
+    :return: None
+    """
+    Path(dir_name).mkdir(
+        parents=True,
+        exist_ok=True
+    )
+
+
+def create_template(parent_name: str) -> None:
+    keyword_dir_path = Path(getcwd() + "/" + parent_name + "/keyword")
+    executor_dir_path = Path(getcwd() + "/" + parent_name + "/executor")
+    lock = Lock()
+    if keyword_dir_path.exists() and keyword_dir_path.is_dir():
+        write_action_json(getcwd() + "/" + parent_name + "/keyword/keyword1.json", template_keyword_1)
+        write_action_json(getcwd() + "/" + parent_name + "/keyword/keyword2.json", template_keyword_2)
+    if executor_dir_path.exists() and keyword_dir_path.is_dir():
+        lock.acquire()
+        try:
+            with open(getcwd() + "/" + parent_name + "/executor/executor_one_file.py", "w+") as file:
+                file.write(
+                    executor_template_1.replace(
+                        "{temp}",
+                        getcwd() + "/" + parent_name + "/keyword/keyword1.json"
+                    )
+                )
+            with open(getcwd() + "/" + parent_name + "/executor/executor_folder.py", "w+") as file:
+                file.write(
+                    executor_template_2.replace(
+                        "{temp}",
+                        getcwd() + "/" + parent_name + "/keyword"
+                    )
+                )
+        finally:
+            lock.release()
+
+
+def create_project_dir(parent_name: str) -> None:
+    create_dir(getcwd() + "/" + parent_name + "/keyword")
+    create_dir(getcwd() + "/" + parent_name + "/executor")
+    create_template(parent_name)
diff --git a/je_auto_control/utils/project/template/__init__.py b/je_auto_control/utils/project/template/__init__.py
diff --git a/je_auto_control/utils/project/template/template_executor.py b/je_auto_control/utils/project/template/template_executor.py
@@ -0,0 +1,19 @@
+executor_template_1: str = \
+    """from je_auto_control import execute_action, read_action_json
+
+execute_action(
+    read_action_json(
+        r"{temp}"
+    )
+)
+"""
+
+executor_template_2: str = \
+    """from je_auto_control import execute_files, get_dir_files_as_list
+
+execute_files(
+    get_dir_files_as_list(
+        r"{temp}"
+    )
+)
+"""
diff --git a/je_auto_control/utils/project/template/template_keyword.py b/je_auto_control/utils/project/template/template_keyword.py
@@ -0,0 +1,50 @@
+template_keyword_1: list = [
+    ["set_record_enable", [True]],
+    ["write", {"write_string": "Hello World"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["write", {"write_string": "If you want Windows write upcase string"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["write", {"write_string": "you need to press shift first"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["press_keyboard_key", {"keycode": "shift"}],
+    ["write", {"write_string": "UPCASEE"}],
+    ["release_keyboard_key", {"keycode": "shift"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["write", {"write_string": "this is example how to use keyword"}],
+    ["write", {"write_string": " and add module to executor"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["write", {"write_string": "now i will add time module and sleep 3 sec"}],
+    ["add_package_to_executor", ["time"]],
+    ["time_sleep", [3]],
+    ["type_keyboard", {"keycode": "return"}],
+    ["write", {"write_string": "also you can use builtin function on executor like print"}],
+    ["print", ["Google Bye World"]],
+    ["type_keyboard", {"keycode": "return"}],
+    ["write", {"write_string": "and i will create an html report for you"}],
+    ["generate_html_report"],
+    ["type_keyboard", {"keycode": "return"}]
+]
+
+template_keyword_2: list = [
+    ["set_record_enable", [True]],
+    ["write", {"write_string": "in this keyword file we will change the mouse position"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["set_mouse_position", [500, 500]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["set_mouse_position", [600, 600]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["set_mouse_position", [400, 400]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["set_mouse_position", [300, 300]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["set_mouse_position", [200, 200]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["set_mouse_position", [700, 700]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["set_mouse_position", [800, 800]],
+    ["set_mouse_position", {"x": 100, "y": 100}],
+    ["write", {"write_string": "now i will create an json report for you"}],
+    ["type_keyboard", {"keycode": "return"}],
+    ["generate_json_report"]
+]
+
diff --git a/je_auto_control/wrapper/auto_control_keyboard.py b/je_auto_control/wrapper/auto_control_keyboard.py
@@ -162,11 +162,19 @@ def write(write_string: str, is_shift: bool = False) -> str:
             record_write_string = ""
             for single_string in write_string:
                 try:
-                    if keyboard_keys_table.get(single_string) is not None:
+                    key = keyboard_keys_table.get(single_string, None)
+                    if key is not None:
                         record_write_string = "".join(
                             [
                                 record_write_string,
-                                type_keyboard(single_string, is_shift, skip_record=True)
+                                type_keyboard(key, is_shift, skip_record=True)
+                            ]
+                        )
+                    elif single_string.isspace():
+                        record_write_string = "".join(
+                            [
+                                record_write_string,
+                                type_keyboard("space", is_shift, skip_record=True)
                             ]
                         )
                     else:
diff --git a/test/unit_test/create_project_file/create_project_test.py b/test/unit_test/create_project_file/create_project_test.py
@@ -0,0 +1,3 @@
+from je_auto_control import create_project_dir
+
+create_project_dir("My Test Project")
