diff --git a/docs/source/API/API_index.rst b/docs/source/API/API_index.rst index 6f2e54d..a114ae8 100644 --- a/docs/source/API/API_index.rst +++ b/docs/source/API/API_index.rst @@ -7,6 +7,7 @@ APITestka's API Documentation utils/assert_result.rst utils/callback_function.rst utils/executor.rst + utils/scheduler.rst utils/mock_server.rst utils/file_process.rst utils/generate_report.rst diff --git a/docs/source/API/utils/scheduler.rst b/docs/source/API/utils/scheduler.rst new file mode 100644 index 0000000..7ee025f --- /dev/null +++ b/docs/source/API/utils/scheduler.rst @@ -0,0 +1,192 @@ +Scheduler API +---- + +.. code-block:: python + + def add_blocking_job( + self, func: Callable, trigger: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, id: str = None, name: str = None, + misfire_grace_time: int = undefined, coalesce: bool = undefined, max_instances: int = undefined, + next_run_time: datetime = undefined, jobstore: str = 'default', executor: str = 'default', + replace_existing: bool = False, **trigger_args: Any) -> Job: + """ + Just an apscheduler add job wrapper. + :param func: callable (or a textual reference to one) to run at the given time + :param str|apscheduler.triggers.base.BaseTrigger trigger: trigger that determines when + ``func`` is called + :param list|tuple args: list of positional arguments to call func with + :param dict kwargs: dict of keyword arguments to call func with + :param str|unicode id: explicit identifier for the job (for modifying it later) + :param str|unicode name: textual description of the job + :param int misfire_grace_time: seconds after the designated runtime that the job is still + allowed to be run (or ``None`` to allow the job to run no matter how late it is) + :param bool coalesce: run once instead of many times if the scheduler determines that the + job should be run more than once in succession + :param int max_instances: maximum number of concurrently running instances allowed for this + job + :param datetime next_run_time: when to first run the job, regardless of the trigger (pass + ``None`` to add the job as paused) + :param str|unicode jobstore: alias of the job store to store the job in + :param str|unicode executor: alias of the executor to run the job with + :param bool replace_existing: ``True`` to replace an existing job with the same ``id`` + (but retain the number of runs from the existing one) + :return: Job + """ + +.. code-block:: python + + def add_nonblocking_job( + self, func: Callable, trigger: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, id: str = None, name: str = None, + misfire_grace_time: int = undefined, coalesce: bool = undefined, max_instances: int = undefined, + next_run_time: datetime = undefined, jobstore: str = 'default', executor: str = 'default', + replace_existing: bool = False, **trigger_args: Any) -> Job: + """ + Just an apscheduler add job wrapper. + :param func: callable (or a textual reference to one) to run at the given time + :param str|apscheduler.triggers.base.BaseTrigger trigger: trigger that determines when + ``func`` is called + :param list|tuple args: list of positional arguments to call func with + :param dict kwargs: dict of keyword arguments to call func with + :param str|unicode id: explicit identifier for the job (for modifying it later) + :param str|unicode name: textual description of the job + :param int misfire_grace_time: seconds after the designated runtime that the job is still + allowed to be run (or ``None`` to allow the job to run no matter how late it is) + :param bool coalesce: run once instead of many times if the scheduler determines that the + job should be run more than once in succession + :param int max_instances: maximum number of concurrently running instances allowed for this + job + :param datetime next_run_time: when to first run the job, regardless of the trigger (pass + ``None`` to add the job as paused) + :param str|unicode jobstore: alias of the job store to store the job in + :param str|unicode executor: alias of the executor to run the job with + :param bool replace_existing: ``True`` to replace an existing job with the same ``id`` + (but retain the number of runs from the existing one) + :return: Job + """ + +.. code-block:: python + + def get_blocking_scheduler(self) -> BlockingScheduler: + """ + Return self blocking scheduler + :return: BlockingScheduler + """ + +.. code-block:: python + + def get_nonblocking_scheduler(self) -> BackgroundScheduler: + """ + Return self background scheduler + :return: BackgroundScheduler + """ + +.. code-block:: python + + def start_block_scheduler(self, *args: Any, **kwargs: Any) -> None: + """ + Start blocking scheduler + :return: None + """ + +.. code-block:: python + + def start_nonblocking_scheduler(self, *args: Any, **kwargs: Any) -> None: + """ + Start background scheduler + :return: None + """ + +.. code-block:: python + + def start_all_scheduler(self, *args: Any, **kwargs: Any) -> None: + """ + Start background and blocking scheduler + :return: None + """ + +.. code-block:: python + + def add_interval_blocking_secondly( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, seconds: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_blocking_minutely( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, minutes: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_blocking_hourly( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, hours: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_blocking_daily( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, days: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_blocking_weekly( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, weeks: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_nonblocking_secondly( + self, function: Callable, id: str = None, args: list = None, + kwargs: dict = None, seconds: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_nonblocking_minutely( + self, function: Callable, id: str = None, args: list = None, + kwargs: dict = None, minutes: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_nonblocking_hourly( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, hours: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_nonblocking_daily( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, days: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_interval_nonblocking_weekly( + self, function: Callable, id: str = None, args: Union[list, tuple] = None, + kwargs: dict = None, weeks: int = 1, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_cron_blocking( + self, function: Callable, id: str = None, **trigger_args: Any) -> Job: + +.. code-block:: python + + def add_cron_nonblocking( + self, function: Callable, id: str = None, **trigger_args: Any) -> Job: + +.. code-block:: python + + def remove_blocking_job(self, id: str, jobstore: str = 'default') -> Any: + +.. code-block:: python + + def remove_nonblocking_job(self, id: str, jobstore: str = 'default') -> Any: + +.. code-block:: python + + def shutdown_blocking_scheduler(self, wait: bool = False) -> None: + +.. code-block:: python + + def shutdown_nonblocking_scheduler(self, wait: bool = False) -> None: diff --git a/docs/source/Eng/Eng_index.rst b/docs/source/Eng/Eng_index.rst index db505b8..3cf77a9 100644 --- a/docs/source/Eng/Eng_index.rst +++ b/docs/source/Eng/Eng_index.rst @@ -8,4 +8,5 @@ APITestka's Documentation doc/getting_started/getting_started_doc.rst doc/mock_server/mock_server_doc.rst doc/generate_report/generate_report_doc.rst - doc/cli/cli_doc.rst \ No newline at end of file + doc/cli/cli_doc.rst + doc/scheduler/scheduler_doc.rst \ No newline at end of file diff --git a/docs/source/Eng/doc/scheduler/scheduler_doc.rst b/docs/source/Eng/doc/scheduler/scheduler_doc.rst new file mode 100644 index 0000000..f9f8b05 --- /dev/null +++ b/docs/source/Eng/doc/scheduler/scheduler_doc.rst @@ -0,0 +1,19 @@ +Scheduler +---- + +You can use scheduling to perform repetitive tasks, either by using a simple wrapper for APScheduler or by consulting the API documentation to use it yourself. + +.. code-block:: python + + from je_api_testka 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() diff --git a/docs/source/Zh/Zh_index.rst b/docs/source/Zh/Zh_index.rst index 274fd18..e0f6b23 100644 --- a/docs/source/Zh/Zh_index.rst +++ b/docs/source/Zh/Zh_index.rst @@ -8,4 +8,5 @@ APITestka's 文件 doc/getting_started/getting_started_doc.rst doc/mock_server/mock_server_doc.rst doc/generate_report/generate_report_doc.rst - doc/cli/cli_doc.rst \ No newline at end of file + doc/cli/cli_doc.rst + doc/scheduler/scheduler_doc.rst \ No newline at end of file diff --git a/docs/source/Zh/doc/scheduler/scheduler_doc.rst b/docs/source/Zh/doc/scheduler/scheduler_doc.rst new file mode 100644 index 0000000..280c995 --- /dev/null +++ b/docs/source/Zh/doc/scheduler/scheduler_doc.rst @@ -0,0 +1,19 @@ +Scheduler +---- + +可以使用排程來執行重複的任務，可以使用對 APScheduler 的簡易包裝或是觀看 API 文件自行使用 + +.. code-block:: python + + from je_api_testka 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()