Refactor

Author: JE-Chen

docs/source/Eng/doc/callback_function/callback_function_doc.rst

@@ -1,8 +1,8 @@
-回調函數 文件
+Callback Function
 ----
 
-在 AutoControl 裡，Callback function 是由 Callback Executor 提供支援，
-以下是簡易的使用 Callback Executor 的範例，
+In AutoControl, callback functions are supported by the Callback Executor.
+Below is a simple example of using the Callback Executor:
 
 .. code-block:: python
 
@@ -18,29 +18,35 @@
         )
     )
 
-* ( 注意!，如果 callback_executor event_dict 裡面包含的 name: function 需與 executor 一樣，不一樣則是 Bug)
-* (當然跟 executor 一樣可以藉由添加外部 function 來擴充，請看下面例子)
-
-在這個範例裡，我們使用 callback_executor 執行定義在 AutoControl 的 size function，
-然後執行完 size function 後，會去執行傳遞給 callback_function 的 function，
-可以由 callback_param_method 參數來決定要使用的傳遞方法，
-如果是 "args" 請傳入 {"any_name_but_not_duplicate": value, ...} 這裡 ... 代表可以複數傳入，
-如果是 "kwargs" 請傳入 {"actually_param_name": value, ...} 這裡 ... 代表可以複數傳入，
-然後如果要使用回傳值的話，由於回傳值會在所有 function 執行完後才回傳，
-實際上 size -> print 順序沒錯，但此例會先看到 print 之後才是 print(size_function_return_value)，
-因為 size function 只有回傳值本身沒有 print 的動作。
-
-如果我們想要在 callback_executor 裡面添加 function，可以使用如下:
-這段程式碼會把所有 time module 的 builtin, function, method, class
-載入到 callback executor，然後要使用被載入的 function 需要使用 package_function 名稱，
-例如 time.sleep 會變成 time_sleep
+* Note that if the "name: function" pair in the callback_executor event_dict is different from the executor, it is a bug.
+* Of course, like the executor, it can be expanded by adding external functions. Please see the example below.
+
+In this example, we use callback_executor to execute the "size" function defined in AutoControl.
+After executing the "size" function, the function passed to callback_function will be executed.
+The delivery method can be determined by the callback_param_method parameter.
+If it is "args", please pass in {"value1", "value2", ...}.
+Here, the ellipsis (...) represents multiple inputs.
+ If it is "kwargs", please pass in {"actually_param_name": value, ...}.
+Here, the ellipsis (...) again represents multiple inputs.
+ If you want to use the return value,
+since the return value will only be returned after all functions are executed,
+you will actually see the "print" statement
+before the "print(size_function_return_value)" statement in this example,
+even though the order of size -> print is correct.
+This is because the "size" function only returns the value itself without printing it.
+
+This code will load all built-in functions, methods, and classes of the time module into the callback executor.
+To use the loaded functions, we need to use the package_function name,
+for example, time.sleep will become time_sleep.
+
+If we want to add functions in the callback_executor, we can use the following code:
 
 .. code-block:: python
 
     from je_auto_control import package_manager
     package_manager.add_package_to_callback_executor("time")
 
-如果你需要查看被更新的 event_dict 可以使用
+If you need to check the updated event_dict, you can use:
 
 .. code-block:: python
 

docs/source/Eng/doc/critical_exit/critical_exit_doc.rst

@@ -16,7 +16,7 @@
     from je_auto_control import AutoControlMouseException
     from je_auto_control import CriticalExit
     from je_auto_control import press_key
-    from je_auto_control import set_position
+    from je_auto_control import set_mouse_position
     from je_auto_control import size
 
     # print your screen width and height
@@ -30,8 +30,8 @@
 
         sleep(3)
         while True:
-            set_position(200, 400)
-            set_position(400, 600)
+            set_mouse_position(200, 400)
+            set_mouse_position(400, 600)
             raise AutoControlMouseException
     except Exception as error:
         print(repr(error), file=sys.stderr)

docs/source/Eng/doc/generate_report/generate_report_doc.rst

@@ -22,35 +22,35 @@ Generate Report 可以生成以下格式的報告
     if sys.platform in ["win32", "cygwin", "msys"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 65}],
+            ["type_keyboard", {"keycode": 65}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_html_report"],
         ]
 
     elif sys.platform in ["linux", "linux2"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 38}],
+            ["type_keyboard", {"keycode": 38}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_html_report"],
         ]
     elif sys.platform in ["darwin"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 0x00}],
+            ["type_keyboard", {"keycode": 0x00}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_html_report"],
         ]
     print("\n\n")
@@ -71,35 +71,35 @@ Generate Report 可以生成以下格式的報告
     if sys.platform in ["win32", "cygwin", "msys"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 65}],
+            ["type_keyboard", {"keycode": 65}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_json_report"],
         ]
 
     elif sys.platform in ["linux", "linux2"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 38}],
+            ["type_keyboard", {"keycode": 38}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_json_report"],
         ]
     elif sys.platform in ["darwin"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 0x00}],
+            ["type_keyboard", {"keycode": 0x00}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_json_report"],
         ]
     print("\n\n")
@@ -119,35 +119,35 @@ Generate Report 可以生成以下格式的報告
     if sys.platform in ["win32", "cygwin", "msys"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 65}],
+            ["type_keyboard", {"keycode": 65}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_xml_report"]
         ]
 
     elif sys.platform in ["linux", "linux2"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 38}],
+            ["type_keyboard", {"keycode": 38}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_xml_report"]
         ]
     elif sys.platform in ["darwin"]:
         test_list = [
             ["set_record_enable", {"set_enable": True}],
-            ["type_key", {"keycode": 0x00}],
+            ["type_keyboard", {"keycode": 0x00}],
             ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["position"],
+            ["get_mouse_position"],
             ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
             ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
-            ["type_key", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
+            ["type_keyboard", {"mouse_keycode": "dwadwawda", "dwadwad": 500, "wdawddwawad": 500}],
             ["generate_xml_report"]
         ]
     print("\n\n")

docs/source/Eng/doc/keyboard/keyboard_doc.rst

@@ -31,9 +31,9 @@
 
 .. code-block:: python
 
-    from je_auto_control import type_key
+    from je_auto_control import type_keyboard
 
-    type_key("a")
+    type_keyboard("a")
 
 以下範例是檢查鍵盤 a 鍵是否按著
 

docs/source/Eng/doc/mouse/mouse_doc.rst

@@ -36,10 +36,10 @@
 
 .. code-block:: python
 
-    from je_auto_control import position, set_position
+    from je_auto_control import get_mouse_position, set_mouse_position
 
-    print(position)
-    set_position(100, 100)
+    print(get_mouse_position())
+    set_mouse_position(100, 100)
 
 以下範例是3秒後滑鼠會往上 scroll
 

docs/source/Eng/doc/record/record_doc.rst

@@ -13,17 +13,17 @@
     from je_auto_control import execute_action
     from je_auto_control import record
     from je_auto_control import stop_record
-    from je_auto_control import type_key
+    from je_auto_control import type_keyboard
 
     # this program will type test two time
     # one time is type key one time is test_record
 
     record()
     sleep(1)
-    print(type_key("t"))
-    print(type_key("e"))
-    print(type_key("s"))
-    print(type_key("t"))
+    print(type_keyboard("t"))
+    print(type_keyboard("e"))
+    print(type_keyboard("s"))
+    print(type_keyboard("t"))
     sleep(2)
     record_result = stop_record()
     print(record_result)

docs/source/Zh/doc/callback_function/callback_function_doc.rst

@@ -1,4 +1,4 @@
-回調函數 文件
+回調函數
 ----
 
 在 AutoControl 裡，Callback function 是由 Callback Executor 提供支援，
@@ -24,7 +24,7 @@
 在這個範例裡，我們使用 callback_executor 執行定義在 AutoControl 的 size function，
 然後執行完 size function 後，會去執行傳遞給 callback_function 的 function，
 可以由 callback_param_method 參數來決定要使用的傳遞方法，
-如果是 "args" 請傳入 {"any_name_but_not_duplicate": value, ...} 這裡 ... 代表可以複數傳入，
+如果是 "args" 請傳入 {"value1", "value2", ...} 這裡 ... 代表可以複數傳入，
 如果是 "kwargs" 請傳入 {"actually_param_name": value, ...} 這裡 ... 代表可以複數傳入，
 然後如果要使用回傳值的話，由於回傳值會在所有 function 執行完後才回傳，
 實際上 size -> print 順序沒錯，但此例會先看到 print 之後才是 print(size_function_return_value)，
@@ -35,6 +35,8 @@
 載入到 callback executor，然後要使用被載入的 function 需要使用 package_function 名稱，
 例如 time.sleep 會變成 time_sleep
 
+這段程式碼會把 time 所有的 function 加入 executor(直譯器裡)。
+
 .. code-block:: python
 
     from je_auto_control import package_manager

docs/source/Zh/doc/cli/cli_doc.rst

@@ -1,4 +1,4 @@
-命令列介面 文件
+命令列介面
 ----
 
 我們可以使用 CLI 模式去執行 keyword.json 檔案或執行包含 Keyword.json files 的資料夾，

docs/source/Zh/doc/critical_exit/critical_exit_doc.rst

@@ -1,13 +1,15 @@
-緊急退出 文件
+緊急退出
 ----
+
 * Critical Exit 是提供故障保護的機制。
 * Critical Exit 預設是關閉的。
 * 如果開啟，預設按鍵是 F7。
-* 開啟的方法是 CriticalExit().init_critical_exit()
+* 開啟的方法是 CriticalExit().init_critical_exit() (開啟後會額外消耗系統資源)
 
 以下這個範例是讓滑鼠不受控制的移動並拋出例外，
 當接收到例外，初始化 Critical Exit 並自動按下 F7，
 ( 注意! 如果修改這個範例必須極度小心。 )
+(你可能會失去對你電腦的控制，例如滑鼠不受控制)
 
 .. code-block:: python
 
@@ -27,11 +29,11 @@
 
     try:
         from time import sleep
-
+        # Or no sleep
         sleep(3)
         while True:
-            set_position(200, 400)
-            set_position(400, 600)
+            set_mouse_position(200, 400)
+            set_mouse_position(400, 600)
             raise AutoControlMouseException
     except Exception as error:
         print(repr(error), file=sys.stderr)