Skip to content

Commit 8f6aaf8

Browse files
committed
Complete Doc
1 parent ed2e83b commit 8f6aaf8

File tree

6 files changed

+123
-45
lines changed

6 files changed

+123
-45
lines changed

.idea/workspace.xml

Lines changed: 50 additions & 33 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
Keyword and Executor documentation
2+
----
3+
4+
* Keyword 是一個 JSON 檔案裏面包含許多自定義的關鍵字與參數。
5+
* Keyword 會與 Executor 搭配使用。
6+
* Keyword 的格式是以下範例,且在 JSON 檔案裡面使用一樣格式。
7+
8+
.. code-block:: python
9+
[
10+
["function_name_in_event_dict": {"param_name": param_value}],
11+
["function_name_in_event_dict": {"param_name": param_value}],
12+
["function_name_in_event_dict": {"param_name": param_value}],
13+
# many....
14+
# If you are using position param
15+
["function_name_in_event_dict": {param_value1, param_value2....}]
16+
]
17+
----
18+
19+
如果我們想要在 executor 裡面添加 function,可以使用如下:
20+
這段程式碼會把所有 time module 的 builtin, function, method, class
21+
載入到 executor,然後要使用被載入的 function 需要使用 package_function 名稱,
22+
例如 time.sleep 會變成 time_sleep
23+
24+
----
25+
26+
.. code-block:: python
27+
from je_auto_control import package_manager
28+
package_manager.add_package_to_executor("time")
29+
30+
----
31+
32+
如果你需要查看被更新的 event_dict 可以使用
33+
34+
----
35+
36+
.. code-block:: python
37+
from je_auto_control import executor
38+
print(executor.event_dict)
39+
40+
----
41+
42+
如果我們想要執行 JSON 檔案
43+
44+
----
45+
46+
.. code-block:: python
47+
from je_auto_control import execute_action, read_action_json
48+
execute_action(read_action_json(file_path))
49+
50+
----
51+
52+
如果我們想要執行資料夾裡所有 JSON 檔案
53+
54+
----
55+
56+
.. code-block:: python
57+
from je_auto_control import execute_files, get_dir_files_as_list
58+
execute_files(get_dir_files_as_list(dir_path))

je_auto_control/utils/executor/action_executor.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@ def __init__(self):
8484
def _execute_event(self, action: list):
8585
event = self.event_dict.get(action[0])
8686
if len(action) == 2:
87-
return event(**action[1])
87+
if isinstance(action[1], dict):
88+
return event(**action[1])
89+
else:
90+
return event(*action[1])
8891
elif len(action) == 1:
8992
return event()
9093
else:

je_auto_control/utils/package_manager/package_manager_class.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def get_member(self, package, predicate, target):
4141
if installed_package is not None and target is not None:
4242
for member in getmembers(installed_package, predicate):
4343
target.event_dict.update(
44-
{str(package) + "_" + str(member): member})
44+
{str(package) + "_" + str(member[0]): member[1]})
4545
elif installed_package is None:
4646
print(repr(ModuleNotFoundError(f"Can't find package {package}")),
4747
file=stderr)

pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Rename to build stable version
2-
# This is stable version
1+
# Rename to build dev version
2+
# This is dev version
33
[build-system]
4-
requires = ["setuptools>=61.0"]
4+
requires = ["setuptools"]
55
build-backend = "setuptools.build_meta"
66

77
[project]
8-
name = "je_auto_control"
9-
version = "0.0.126"
8+
name = "je_auto_control_dev"
9+
version = "0.0.62"
1010
authors = [
1111
{ name = "JE-Chen", email = "zenmailman@gmail.com" },
1212
]

0 commit comments

Comments
 (0)