Add scheduler and tests

JE-Chen · JE-Chen · commit 72f94746f9bb · 2023-06-01T10:05:40.000+08:00
diff --git a/.github/workflows/dev_python3_10.yml b/.github/workflows/dev_python3_10.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/dev_python3_11.yml b/.github/workflows/dev_python3_11.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/dev_python3_8.yml b/.github/workflows/dev_python3_8.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/dev_python3_9.yml b/.github/workflows/dev_python3_9.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/stable_python3_10.yml b/.github/workflows/stable_python3_10.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/stable_python3_11.yml b/.github/workflows/stable_python3_11.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/stable_python3_8.yml b/.github/workflows/stable_python3_8.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.github/workflows/stable_python3_9.yml b/.github/workflows/stable_python3_9.yml
@@ -68,4 +68,8 @@ jobs:
       - name: Test Callback Module
         run: python ./test/unit_test/callback/callback_test.py
       - name: Test Create Project Function
-        run: python ./test/unit_test/create_project_file/create_project_test.py
+        run: python ./test/unit_test/create_project_file/create_project_test.py
+      - name: Test Interval Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_interval_test.py
+      - name: Test Cron Scheduler
+        run: python ./test/unit_test/scheduler_test/sec_cron_test.py
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/je_auto_control/__init__.py b/je_auto_control/__init__.py
@@ -101,12 +101,14 @@
 from je_auto_control.utils.shell_process.shell_exec import default_shell_manager
 # Start exe
 from je_auto_control.utils.start_exe.start_another_process import start_exe
+# Scheduler
+from je_auto_control.utils.scheduler.extend_apscheduler import SchedulerManager
 
 __all__ = [
     "click_mouse", "mouse_keys_table", "get_mouse_position", "press_mouse", "release_mouse",
     "mouse_scroll", "set_mouse_position", "special_mouse_keys_table",
     "keyboard_keys_table", "press_keyboard_key", "release_keyboard_key", "type_keyboard", "check_key_is_press",
-    "write", "hotkey", "start_exe",
+    "write", "hotkey", "start_exe", "SchedulerManager",
     "screen_size", "screenshot", "locate_all_image", "locate_image_center", "locate_and_click",
     "CriticalExit", "AutoControlException", "AutoControlKeyboardException",
     "AutoControlMouseException", "AutoControlCantFindKeyException",
diff --git a/je_auto_control/utils/scheduler/__init__.py b/je_auto_control/utils/scheduler/__init__.py
diff --git a/je_auto_control/utils/scheduler/extend_apscheduler.py b/je_auto_control/utils/scheduler/extend_apscheduler.py
@@ -0,0 +1,128 @@
+from typing import Callable
+
+from apscheduler.schedulers.background import BackgroundScheduler
+from apscheduler.schedulers.blocking import BlockingScheduler
+from apscheduler.util import undefined
+
+
+class SchedulerManager(object):
+
+    def __init__(self):
+        self._blocking_schedulers: BlockingScheduler = BlockingScheduler()
+        self._background_schedulers: BackgroundScheduler = BackgroundScheduler()
+
+    def add_blocking_job(
+            self, func, trigger=None, args=None, kwargs=None, id=None, name=None,
+            misfire_grace_time=undefined, coalesce=undefined, max_instances=undefined,
+            next_run_time=undefined, jobstore='default', executor='default',
+            replace_existing=False, **trigger_args):
+        params = locals()
+        params.pop("self")
+        trigger_args = params.pop("trigger_args")
+        self._blocking_schedulers.add_job(**params, **trigger_args)
+
+    def add_nonblocking_job(
+            self, func, trigger=None, args=None, kwargs=None, id=None, name=None,
+            misfire_grace_time=undefined, coalesce=undefined, max_instances=undefined,
+            next_run_time=undefined, jobstore='default', executor='default',
+            replace_existing=False, **trigger_args):
+        params = locals()
+        params.pop("self")
+        trigger_args = params.pop("trigger_args")
+        self._background_schedulers.add_job(**params, **trigger_args)
+
+    def get_blocking_scheduler(self):
+        return self._blocking_schedulers
+
+    def get_nonblocking_scheduler(self):
+        return self._background_schedulers
+
+    def start_block_scheduler(self, *args, **kwargs):
+        self._blocking_schedulers.start(*args, **kwargs)
+
+    def start_nonblocking_scheduler(self, *args, **kwargs):
+        self._background_schedulers.start(*args, **kwargs)
+
+    def start_all_scheduler(self, *args, **kwargs):
+        self._blocking_schedulers.start(*args, **kwargs)
+        self._background_schedulers.start(*args, **kwargs)
+
+    def add_interval_blocking_secondly(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, seconds: int = 1, **trigger_args):
+        self.add_blocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, seconds=seconds, **trigger_args)
+
+    def add_interval_blocking_minutely(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, minutes: int = 1, **trigger_args):
+        self.add_blocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, minutes=minutes, **trigger_args)
+
+    def add_interval_blocking_hourly(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, hours: int = 1, **trigger_args):
+        self.add_blocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, hours=hours, **trigger_args)
+
+    def add_interval_blocking_daily(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, days: int = 1, **trigger_args):
+        self.add_blocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, days=days, **trigger_args)
+
+    def add_interval_blocking_weekly(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, weeks: int = 1, **trigger_args):
+        self.add_blocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, weeks=weeks, **trigger_args)
+
+    def add_interval_nonblocking_secondly(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, seconds: int = 1, **trigger_args):
+        self.add_nonblocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, seconds=seconds, **trigger_args)
+
+    def add_interval_nonblocking_minutely(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, minutes: int = 1, **trigger_args):
+        self.add_nonblocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, minutes=minutes, **trigger_args)
+
+    def add_interval_nonblocking_hourly(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, hours: int = 1, **trigger_args):
+        self.add_nonblocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, hours=hours, **trigger_args)
+
+    def add_interval_nonblocking_daily(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, days: int = 1, **trigger_args):
+        self.add_nonblocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, days=days, **trigger_args)
+
+    def add_interval_nonblocking_weekly(
+            self, function: Callable, id: str = None, args: list = None,
+            kwargs: dict = None, weeks: int = 1, **trigger_args):
+        self.add_nonblocking_job(
+            func=function, trigger="interval", id=id, args=args, kwargs=kwargs, weeks=weeks, **trigger_args)
+
+    def add_cron_blocking(
+            self, function: Callable, id: str = None, **trigger_args):
+        self.add_blocking_job(func=function, id=id, trigger="cron", **trigger_args)
+
+    def add_cron_nonblocking(
+            self, function: Callable, id: str = None, **trigger_args):
+        self.add_nonblocking_job(func=function, id=id, trigger="cron", **trigger_args)
+
+    def remove_blocking_job(self, id: str, jobstore: str = 'default'):
+        self._blocking_schedulers.remove_job(job_id=id, jobstore=jobstore)
+
+    def remove_nonblocking_job(self, id: str, jobstore: str = 'default'):
+        self._background_schedulers.remove_job(job_id=id, jobstore=jobstore)
+
+    def shutdown_blocking_scheduler(self, wait: bool = False):
+        self._blocking_schedulers.shutdown(wait=wait)
+
+    def shutdown_nonblocking_scheduler(self, wait: bool = False):
+        self._background_schedulers.shutdown(wait=wait)
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "je_auto_control_dev"
-version = "0.0.79"
+version = "0.0.80"
 authors = [
     { name = "JE-Chen", email = "jechenmailman@gmail.com" },
 ]
@@ -17,6 +17,7 @@ dependencies = [
     "je_open_cv",
     "pillow",
     "numpy",
+    "APScheduler",
     "pyobjc-core;platform_system=='Darwin'",
     "pyobjc;platform_system=='Darwin'",
     "python-Xlib;platform_system=='Linux'"
diff --git a/stable.toml b/stable.toml
@@ -17,6 +17,7 @@ dependencies = [
     "je_open_cv",
     "pillow",
     "numpy",
+    "APScheduler",
     "pyobjc-core;platform_system=='Darwin'",
     "pyobjc;platform_system=='Darwin'",
     "python-Xlib;platform_system=='Linux'"
diff --git a/test/unit_test/scheduler_test/sec_cron_test.py b/test/unit_test/scheduler_test/sec_cron_test.py
@@ -0,0 +1,12 @@
+from je_auto_control import SchedulerManager
+
+
+def test_scheduler():
+    print("Test Scheduler")
+    scheduler.remove_blocking_job(id="test")
+    scheduler.shutdown_blocking_scheduler()
+
+
+scheduler = SchedulerManager()
+scheduler.add_cron_blocking(function=test_scheduler, id="test", second="*")
+scheduler.start_block_scheduler()
diff --git a/test/unit_test/scheduler_test/sec_interval_test.py b/test/unit_test/scheduler_test/sec_interval_test.py
@@ -0,0 +1,12 @@
+from je_auto_control import SchedulerManager
+
+
+def test_scheduler():
+    print("Test Scheduler")
+    scheduler.remove_blocking_job(id="test")
+    scheduler.shutdown_blocking_scheduler()
+
+
+scheduler = SchedulerManager()
+scheduler.add_interval_blocking_secondly(function=test_scheduler, id="test")
+scheduler.start_block_scheduler()
