classic-scheduler 1.0.0__tar.gz

classic-scheduler-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sergei Variasov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

classic-scheduler-1.0.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: classic-scheduler
+Version: 1.0.0
+Summary: Provides scheduler
+Home-page: https://github.com/variasov/classic-scheduler
+Author: Sergei Variasov, Vasiliy Pichugin
+Author-email: variasov@gmail.com, pichugin_v_i@mail.ru
+Project-URL: Bug Tracker, https://github.com/variasov/classic-scheduler/issues
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+# Classic Scheduler
+
+## Планировщик
+
+Данная библиотека является продолжением библиотеки акторов `classic actors`. И, как следствие, она зависит от библиотеки акторов.
+
+Планировщик - это актор, который вызывает функции по расписанию.
+
+Рассмотрим пример использования библиотеки:
+
+```python
+def func():
+    print('Hello world!')
+
+scheduler = Scheduler()
+scheduler.with_delay(1, func)
+scheduler.by_period(5, func)
+scheduler.by_cron('* * * * *', func)
+scheduler.run()
+
+# Hello world!
+# Hello world!
+# Hello world!
+# ...
+```
+
+## Отмена вызова (удаление задачи)
+
+Если расписание задач планируется динамически менять, например, удалить ранее созданную задачу, то при создании задачи в методах необходимо указать атрибут `task_name`. Пример:
+
+```python
+scheduler = Scheduler()
+scheduler.by_period(1, func, task_name='periodic task')
+```
+
+Тогда в дальнейшем вы можете отменить запланированные запуски задач через:
+
+```python
+scheduler.cancel('periodic task')
+```
+
+## Параметризация вызываемой функции
+
+Планировщик может запускать и функции с аргументами. Аргументы передаются через атрибуты `args` и `kwargs`. Отдельно заметим, что вызываемые объекты так же могут быть акторами, как в примере ниже:
+
+```python
+class SomeActor(Actor):
+
+    @Actor.method
+    def func(self, a, b):
+        print('a + b =', a + b)
+
+some_actor = SomeActor()
+some_actor.run()
+
+scheduler = Scheduler()
+scheduler.run()
+scheduler.by_period(
+    2,
+    some_actor.func,
+    args=(2, 6),
+    task_name='some_actor_task',
+)
+# a + b = 8
+# a + b = 8
+# a + b = 8
+# ...
+```
+
+## Типы задач
+
+После создания экземпляра планировщика нужно добавить в него задач. Планирование и выполнение задач начнется только после запуска метода `run()`. Отметим, что добавлять задачи в планировщик можно и после вызова метода `run()`.
+
+Планировщик поддерживает три типы задач:
+
+### Одноразовая отложенная задача
+
+Создается через вызов метода планировщика `with_delay`. Задача будет выполнена ровно один раз. Ее вызов отложен на `delay` указанный либо в секундах в `float` либо в `timedelta`.
+
+### Переодическая задача
+
+Создается через вызов метода планировщика `by_period`. Задача выполнится в первый раз, затем она будет выполняется через период `periodic` заданный либо в секундах в `float` либо в `timedelta`.
+
+### Задача по расписанию
+
+Создается через вызов метода планировщика `by_cron`. Задача вызов который задается в формате `CRON` строкой.

classic-scheduler-1.0.0/README.md

@@ -0,0 +1,86 @@
+# Classic Scheduler
+
+## Планировщик
+
+Данная библиотека является продолжением библиотеки акторов `classic actors`. И, как следствие, она зависит от библиотеки акторов.
+
+Планировщик - это актор, который вызывает функции по расписанию.
+
+Рассмотрим пример использования библиотеки:
+
+```python
+def func():
+    print('Hello world!')
+
+scheduler = Scheduler()
+scheduler.with_delay(1, func)
+scheduler.by_period(5, func)
+scheduler.by_cron('* * * * *', func)
+scheduler.run()
+
+# Hello world!
+# Hello world!
+# Hello world!
+# ...
+```
+
+## Отмена вызова (удаление задачи)
+
+Если расписание задач планируется динамически менять, например, удалить ранее созданную задачу, то при создании задачи в методах необходимо указать атрибут `task_name`. Пример:
+
+```python
+scheduler = Scheduler()
+scheduler.by_period(1, func, task_name='periodic task')
+```
+
+Тогда в дальнейшем вы можете отменить запланированные запуски задач через:
+
+```python
+scheduler.cancel('periodic task')
+```
+
+## Параметризация вызываемой функции
+
+Планировщик может запускать и функции с аргументами. Аргументы передаются через атрибуты `args` и `kwargs`. Отдельно заметим, что вызываемые объекты так же могут быть акторами, как в примере ниже:
+
+```python
+class SomeActor(Actor):
+
+    @Actor.method
+    def func(self, a, b):
+        print('a + b =', a + b)
+
+some_actor = SomeActor()
+some_actor.run()
+
+scheduler = Scheduler()
+scheduler.run()
+scheduler.by_period(
+    2,
+    some_actor.func,
+    args=(2, 6),
+    task_name='some_actor_task',
+)
+# a + b = 8
+# a + b = 8
+# a + b = 8
+# ...
+```
+
+## Типы задач
+
+После создания экземпляра планировщика нужно добавить в него задач. Планирование и выполнение задач начнется только после запуска метода `run()`. Отметим, что добавлять задачи в планировщик можно и после вызова метода `run()`.
+
+Планировщик поддерживает три типы задач:
+
+### Одноразовая отложенная задача
+
+Создается через вызов метода планировщика `with_delay`. Задача будет выполнена ровно один раз. Ее вызов отложен на `delay` указанный либо в секундах в `float` либо в `timedelta`.
+
+### Переодическая задача
+
+Создается через вызов метода планировщика `by_period`. Задача выполнится в первый раз, затем она будет выполняется через период `periodic` заданный либо в секундах в `float` либо в `timedelta`.
+
+### Задача по расписанию
+
+Создается через вызов метода планировщика `by_cron`. Задача вызов который задается в формате `CRON` строкой.

classic-scheduler-1.0.0/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools >= 40.6.0",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

classic-scheduler-1.0.0/setup.cfg

@@ -0,0 +1,39 @@
+[metadata]
+name = classic-scheduler
+version = 1.0.0
+description = Provides scheduler
+author = Sergei Variasov, Vasiliy Pichugin
+author_email = variasov@gmail.com, pichugin_v_i@mail.ru
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/variasov/classic-scheduler
+project_urls = 
+	Bug Tracker = https://github.com/variasov/classic-scheduler/issues
+classifiers = 
+	Programming Language :: Python :: 3.10
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Development Status :: 4 - Beta
+
+[options]
+packages = find_namespace:
+python_requires = >=3.10
+install_requires = 
+	croniter
+package_dir = 
+	= sources
+
+[options.packages.find]
+where = sources
+
+[options.extras_require]
+dev = 
+	pytest~=6.2
+	pytest-cov~=2.12
+	twine~=3.4
+	build~=0.7
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

classic-scheduler-1.0.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

classic-scheduler-1.0.0/sources/classic/scheduler/__init__.py

@@ -0,0 +1 @@
+from .scheduler import BaseScheduler, SimpleScheduler, ThreadPoolScheduler

classic-scheduler-1.0.0/sources/classic/scheduler/scheduler.py

@@ -0,0 +1,245 @@
+import heapq
+from abc import ABC, abstractmethod
+from concurrent.futures import ThreadPoolExecutor
+from datetime import datetime, timedelta, timezone
+from queue import Empty, Queue
+from threading import Thread
+from typing import Any, Callable, Union
+
+from .task import (STOP, CronTask, OneTimeTask, PeriodicTask,
+                   ScheduleCancellation, Task)
+
+
+class BaseScheduler(ABC):
+    """
+    Планировщик задач. Вызывает переданные ему Callable объекты в соответствии
+    с расписанием.
+    """
+    _stopped: bool
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._thread = Thread(target=self.loop)
+        self._tasks = []
+        self._inbox = Queue()
+
+    def _get_timeout(self) -> float:
+        """
+        Возвращает время ожидания выполнения следующей задачи.
+
+        Returns:
+            float: тайм-аут ожидания задачи.
+        """
+        if len(self._tasks) < 1:
+            return 60
+
+        dt_next_task = self._tasks[0].next_run_time
+        dt_current = datetime.now(timezone.utc)
+        if dt_next_task < dt_current:
+            return 0
+        else:
+            return (dt_next_task - dt_current).total_seconds()
+
+    def _schedule(self, task: Task) -> None:
+        heapq.heappush(self._tasks, task)
+
+    def _unshedule(self, task_name: str) -> None:
+        """
+        Отменяет выполнение запланированной задачи.
+
+        Args:
+            task_name (str): Имя задачи для отмены.
+        """
+        tasks = [t for t in self._tasks if t.name != task_name]
+        if len(self._tasks) != len(tasks):
+            heapq.heapify(tasks)
+            self._tasks = tasks
+
+    @abstractmethod
+    def _execute(self, task: Task) -> None:
+        """
+        Выполняет текущую задачу.
+
+        Args:
+            task (Task): Задача, которую необходимо выполнить.
+        """
+        pass
+
+    def _stop(self) -> None:
+        self._stopped = True
+
+    def loop(self) -> None:
+        """
+        Главный цикл выполнения планировщика.
+        """
+        self._stopped = False
+        while not self._stopped:
+            try:
+                timeout = self._get_timeout()
+                if timeout > 0:
+                    try:
+                        command = self._inbox.get(block=True, timeout=timeout)
+                    except Empty:
+                        continue
+
+                    if isinstance(command, Task):
+                        self._schedule(command)
+                    elif isinstance(command, ScheduleCancellation):
+                        self._unshedule(command.task_name)
+                    elif command is STOP:
+                        break
+                else:
+                    task: Task = heapq.heappop(self._tasks)
+                    self._execute(task)
+
+                    task.set_next_run_time()
+                    if task.next_run_time:
+                        self._schedule(task)
+            except KeyboardInterrupt:
+                break
+        self._stop()
+
+    def with_delay(
+        self,
+        delay: Union[timedelta, float],
+        job: Callable[[], None],
+        args: tuple = None,
+        kwargs: dict = None,
+        task_name: str = None,
+    ) -> None:
+        """
+        Добавляет отложенную задачу в планировщик.
+        Задача будет выполнена ровно один раз.
+
+        Args:
+            delay (Union[timedelta, float]): Отсрочка выполнения задачи.
+            job (Callable[[], Any]): Вызываемая в задаче функция.
+            args (tuple, optional): Аргументы. По умолчанию None.
+            kwargs (dict, optional): Аргументы. По умолчанию None.
+            task_name (str, optional): Имя таски. По умолчанию None.
+        """
+        if not isinstance(delay, timedelta):
+            delay = timedelta(seconds=delay)
+
+        date = datetime.now(timezone.utc) + delay
+        task = OneTimeTask(
+            date=date,
+            job=job,
+            args=args,
+            kwargs=kwargs,
+            name=task_name,
+        )
+        self._inbox.put(task)
+
+    def by_cron(
+        self,
+        schedule: str,
+        job: Callable[[], Any],
+        args: tuple = None,
+        kwargs: dict = None,
+        task_name: str = None,
+    ) -> None:
+        """
+        Добавляет задачу которая будет выполнятся по CRON расписанию.
+
+        Args:
+            schedule (str): Расписание задачи в CRON формате.
+            job (Callable[[], Any]): Вызываемая в задаче функция.
+            args (tuple, optional): Аргументы. По умолчанию None.
+            kwargs (dict, optional): Аргументы. По умолчанию None.
+            task_name (str, optional): Имя таски. По умолчанию None.
+        """
+        task = CronTask(
+            schedule=schedule,
+            job=job,
+            args=args,
+            kwargs=kwargs,
+            name=task_name,
+        )
+        self._inbox.put(task)
+
+    def by_period(
+        self,
+        period: Union[timedelta, float],
+        job: Callable[[], Any],
+        args: tuple = None,
+        kwargs: dict = None,
+        task_name: str = None,
+    ) -> None:
+        """
+        Добавляет задачу которая будет выполняется периодически через
+        указанный интервал времени.
+
+        Args:
+            period (Union[timedelta, float]): Период выполнения задачи.
+            job (Callable[[], Any]): Вызываемая в задаче функция.
+            args (tuple, optional): Аргументы. По умолчанию None.
+            kwargs (dict, optional): Аргументы. По умолчанию None.
+            task_name (_type_, optional): Имя таски. По умолчанию None.
+        """
+        if not isinstance(period, timedelta):
+            period = timedelta(seconds=period)
+
+        task = PeriodicTask(
+            period=period,
+            job=job,
+            args=args,
+            kwargs=kwargs,
+            name=task_name,
+        )
+        self._inbox.put(task)
+
+    def unshedule(self, task_name: str) -> None:
+        """
+        Отменяет выполнение запланированной задачи.
+
+        Args:
+            task_name (str): Имя задачи для отмены.
+        """
+        cancellation = ScheduleCancellation(task_name=task_name)
+        self._inbox.put(cancellation)
+
+    def start(self) -> None:
+        """
+        Запускает выполнение планировщика.
+        """
+        self._thread.start()
+
+    def stop(self) -> None:
+        """
+        Завершает выполнение планировщика.
+        """
+        self._inbox.put(STOP)
+
+
+class SimpleScheduler(BaseScheduler):
+    """
+    Планировщик задач. Вызывает переданные ему Callable объекты в своем потоке
+    в соответствии с расписанием. Поскольку поток один, то не допускается
+    параллельное выполнение задач.
+    """
+
+    def _execute(self, task: Task) -> None:
+        task.run_job()
+
+
+class ThreadPoolScheduler(BaseScheduler):
+    """
+    Планировщик задач. Вызывает переданные ему Callable объекты в пуле потоков
+    в соответствии с расписанием.
+
+    Данный планировщик не предоставляет гарантий
+    того, что одна и та же задача не будет работать в разных потоках
+    одновременно.
+    """
+
+    def __init__(self, workers_count: int = 5):
+        super().__init__()
+        self._thread_pool = ThreadPoolExecutor(max_workers=workers_count)
+
+    def _execute(self, task: Task) -> None:
+        self._thread_pool.submit(task.run_job)
+
+    def _stop(self) -> None:
+        super()._stop()
+        self._thread_pool.shutdown(wait=True)

classic-scheduler-1.0.0/sources/classic/scheduler/task.py

@@ -0,0 +1,128 @@
+import logging
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from datetime import datetime, timedelta, timezone
+from typing import Any, Callable, Optional
+
+from croniter import croniter
+
+
+class Task(ABC):
+    """
+    Задача, выполняемая в потоке планировщика.
+    """
+
+    def __init__(
+        self,
+        job: Callable[[...], None],
+        args: tuple = None,
+        kwargs: dict = None,
+        name: Optional[str] = None,
+    ) -> None:
+        self._job = job
+        self._args = args or ()
+        self._kwargs = kwargs or {}
+        self._name = name
+        self._next_run_time = None  # время следующего запуска задачи
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def next_run_time(self) -> datetime:
+        """
+        Свойство возвращающее время следующего запуска.
+
+        Returns:
+            datetime: Время следующего запуска.
+        """
+        return self._next_run_time
+
+    @abstractmethod
+    def set_next_run_time(self) -> None:
+        """
+        Метод рассчитывающий у устанавливающий время следующего запуска.
+        Переопределяется в дочерних классах.
+        """
+
+    def run_job(self) -> None:
+        """
+        Вызывает переданный Callable объект со всем аргументами
+        в потоке планировщика.
+        """
+        logging.info(
+            'Task [%s] started with schedule [%s]',
+            self._name,
+            self._next_run_time,
+        )
+
+        try:
+            self._job(*self._args, **self._kwargs)
+        except Exception as ex:
+            logging.exception(
+                'Unexpected error occurred in task [%s]: "%s".',
+                self._name,
+                ex,
+            )
+        else:
+            logging.info('Task completed [%s]', self._name)
+
+    def __lt__(self, other: 'Task') -> bool:
+        return self._next_run_time < other._next_run_time
+
+    def __gt__(self, other: 'Task') -> bool:
+        return self._next_run_time > other._next_run_time
+
+
+class OneTimeTask(Task):
+    """
+    Одноразовая задача, которая будет выполнена ровно один раз.
+    """
+
+    def __init__(self, date: datetime, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._next_run_time = date
+
+    def set_next_run_time(self) -> None:
+        self._next_run_time = None
+
+
+class CronTask(Task):
+    """
+    Задача которая выполняется по CRON расписанию.
+    """
+
+    def __init__(self, schedule: str, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._schedule = croniter(schedule, datetime.now(timezone.utc))
+        self._next_run_time = self._schedule.get_next(datetime)
+
+    def set_next_run_time(self) -> None:
+        self._next_run_time = self._schedule.get_next(datetime)
+
+
+class PeriodicTask(Task):
+    """
+    Задача которая будет выполняется переодически
+    через указанный интервал времени.
+    """
+
+    def __init__(self, period: timedelta, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._period = period
+        self._next_run_time = datetime.now(timezone.utc)
+
+    def set_next_run_time(self) -> None:
+        self._next_run_time = datetime.now(timezone.utc) + self._period
+
+
+@dataclass
+class ScheduleCancellation:
+    """
+    Команда отмены запланированной задачи.
+    """
+    task_name: str
+
+
+STOP = object()

classic-scheduler-1.0.0/sources/classic_scheduler.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: classic-scheduler
+Version: 1.0.0
+Summary: Provides scheduler
+Home-page: https://github.com/variasov/classic-scheduler
+Author: Sergei Variasov, Vasiliy Pichugin
+Author-email: variasov@gmail.com, pichugin_v_i@mail.ru
+Project-URL: Bug Tracker, https://github.com/variasov/classic-scheduler/issues
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+# Classic Scheduler
+
+## Планировщик
+
+Данная библиотека является продолжением библиотеки акторов `classic actors`. И, как следствие, она зависит от библиотеки акторов.
+
+Планировщик - это актор, который вызывает функции по расписанию.
+
+Рассмотрим пример использования библиотеки:
+
+```python
+def func():
+    print('Hello world!')
+
+scheduler = Scheduler()
+scheduler.with_delay(1, func)
+scheduler.by_period(5, func)
+scheduler.by_cron('* * * * *', func)
+scheduler.run()
+
+# Hello world!
+# Hello world!
+# Hello world!
+# ...
+```
+
+## Отмена вызова (удаление задачи)
+
+Если расписание задач планируется динамически менять, например, удалить ранее созданную задачу, то при создании задачи в методах необходимо указать атрибут `task_name`. Пример:
+
+```python
+scheduler = Scheduler()
+scheduler.by_period(1, func, task_name='periodic task')
+```
+
+Тогда в дальнейшем вы можете отменить запланированные запуски задач через:
+
+```python
+scheduler.cancel('periodic task')
+```
+
+## Параметризация вызываемой функции
+
+Планировщик может запускать и функции с аргументами. Аргументы передаются через атрибуты `args` и `kwargs`. Отдельно заметим, что вызываемые объекты так же могут быть акторами, как в примере ниже:
+
+```python
+class SomeActor(Actor):
+
+    @Actor.method
+    def func(self, a, b):
+        print('a + b =', a + b)
+
+some_actor = SomeActor()
+some_actor.run()
+
+scheduler = Scheduler()
+scheduler.run()
+scheduler.by_period(
+    2,
+    some_actor.func,
+    args=(2, 6),
+    task_name='some_actor_task',
+)
+# a + b = 8
+# a + b = 8
+# a + b = 8
+# ...
+```
+
+## Типы задач
+
+После создания экземпляра планировщика нужно добавить в него задач. Планирование и выполнение задач начнется только после запуска метода `run()`. Отметим, что добавлять задачи в планировщик можно и после вызова метода `run()`.
+
+Планировщик поддерживает три типы задач:
+
+### Одноразовая отложенная задача
+
+Создается через вызов метода планировщика `with_delay`. Задача будет выполнена ровно один раз. Ее вызов отложен на `delay` указанный либо в секундах в `float` либо в `timedelta`.
+
+### Переодическая задача
+
+Создается через вызов метода планировщика `by_period`. Задача выполнится в первый раз, затем она будет выполняется через период `periodic` заданный либо в секундах в `float` либо в `timedelta`.
+
+### Задача по расписанию
+
+Создается через вызов метода планировщика `by_cron`. Задача вызов который задается в формате `CRON` строкой.

classic-scheduler-1.0.0/sources/classic_scheduler.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+sources/classic/scheduler/__init__.py
+sources/classic/scheduler/scheduler.py
+sources/classic/scheduler/task.py
+sources/classic_scheduler.egg-info/PKG-INFO
+sources/classic_scheduler.egg-info/SOURCES.txt
+sources/classic_scheduler.egg-info/dependency_links.txt
+sources/classic_scheduler.egg-info/requires.txt
+sources/classic_scheduler.egg-info/top_level.txt

classic-scheduler-1.0.0/sources/classic_scheduler.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

classic-scheduler-1.0.0/sources/classic_scheduler.egg-info/requires.txt

@@ -0,0 +1,7 @@
+croniter
+
+[dev]
+pytest~=6.2
+pytest-cov~=2.12
+twine~=3.4
+build~=0.7

classic-scheduler-1.0.0/sources/classic_scheduler.egg-info/top_level.txt

@@ -0,0 +1 @@
+classic