reykit 1.1.66__py3-none-any.whl → 1.1.68__py3-none-any.whl

reykit/rschedule.py

@@ -9,14 +9,16 @@
 """
 
 
-from typing import Any, Literal
+from typing import Any, Literal, TypedDict, NotRequired
+from functools import wraps as functools_wraps
 from collections.abc import Callable
 from apscheduler.executors.pool import ThreadPoolExecutor
 from apscheduler.schedulers.background import BackgroundScheduler
 from apscheduler.schedulers.blocking import BlockingScheduler
 from apscheduler.job import Job
+from reydb.rdb import Database
 
-from .rbase import Base
+from .rbase import Base, throw
 
 
 __all__ = (
@@ -27,6 +29,7 @@ __all__ = (
 class Schedule(Base):
     """
     Schedule type.
+    Can create database used `self.build_db` method.
     """
 
 
@@ -35,7 +38,8 @@ class Schedule(Base):
         max_workers: int = 10,
         max_instances: int = 1,
         coalesce: bool = True,
-        block: bool = False
+        block: bool = False,
+        database: Database | None = None
     ) -> None:
         """
         Build instance attributes.
@@ -46,17 +50,20 @@ class Schedule(Base):
         max_instances : Maximum number of synchronized executions of tasks with the same ID.
         coalesce : Whether to coalesce tasks with the same ID.
         block : Whether to block.
+        database : `Database` instance.
+            - `None`: Not use database.
+            - `Database`: Automatic record to database.
         """
 
-        # Set parameter.
+        # Build.
+
+        ## Scheduler.
         executor = ThreadPoolExecutor(max_workers)
         executors = {'default': executor}
         job_defaults = {
             'coalesce': coalesce,
             'max_instances': max_instances
         }
-
-        # Instance.
         if block:
             scheduler = BlockingScheduler(
                 executors=executors,
@@ -67,10 +74,20 @@ class Schedule(Base):
                 executors=executors,
                 job_defaults=job_defaults
             )
-
-        # Set attribute.
         self.scheduler = scheduler
 
+        ## Database.
+        self.database = database
+
+        ### Database path name.
+        self.db_names = {
+            'base': 'base',
+            'base.schedule': 'schedule',
+            'base.stats_schedule': 'stats_schedule'
+        }
+
+        self.notes: dict[str, str] = {}
+
 
     def start(self) -> None:
         """
@@ -122,13 +139,91 @@ class Schedule(Base):
         return jobs
 
 
+    def wrap_record_db(
+        self,
+        task: Callable,
+        note: str | None
+    ) -> None:
+        """
+        Decorator, record to database.
+
+        Parameters
+        ----------
+        task : Task.
+        note : Task note.
+        """
+
+
+        # Define.
+        @functools_wraps(task)
+        def _task(*args, **kwargs) -> None:
+            """
+            Decorated function.
+
+            Parameters
+            ----------
+            args : Position arguments of function.
+            kwargs : Keyword arguments of function.
+            """
+
+            # Handle parameter.
+            nonlocal task, note
+
+            # Status executing.
+            data = {
+                'status': 0,
+                'task': task.__name__,
+                'note': note
+            }
+            conn = self.database.connect()
+            conn.execute_insert(
+                (self.db_names['base'], self.db_names['base.schedule']),
+                data
+            )
+            id_ = conn.variables['identity']
+            conn.commit()
+
+            # Try execute.
+
+            ## Record error.
+            task = self.database.error.wrap(task, note=note)
+
+            try:
+                task(*args, **kwargs)
+
+            # Status occurred error.
+            except BaseException:
+                data = {
+                    'id': id_,
+                    'status': 2
+                }
+                self.database.execute_update(
+                    (self.db_names['base'], self.db_names['base.schedule']),
+                    data
+                )
+                raise
+
+            # Status completed.
+            else:
+                data = {
+                    'id': id_,
+                    'status': 1
+                }
+                self.database.execute_update(
+                    (self.db_names['base'], self.db_names['base.schedule']),
+                    data
+                )
+
+        return _task
+
+
     def add_task(
         self,
         task: Callable,
-        trigger: Literal['date', 'interval', 'cron'] = 'date',
-        args: tuple | None = None,
-        kwargs: dict | None = None,
-        **trigger_kwargs: Any
+        plan: dict[str, Any],
+        args: Any | None = None,
+        kwargs: Any | None = None,
+        note: str | None = None
     ) -> Job:
         """
         Add task.
@@ -136,35 +231,53 @@ class Schedule(Base):
         Parameters
         ----------
         task : Task function.
-        trigger : Trigger type.
+        plan : Plan trigger keyword arguments.
         args : Task position arguments.
         kwargs : Task keyword arguments.
-        trigger_kwargs : Trigger keyword arguments.
+        note : Task note.
 
         Returns
         -------
         Task instance.
         """
 
+        # Handle parameter.
+        if plan is None:
+            plan = {}
+        trigger = plan.get('trigger')
+        trigger_args = {
+            key: value
+            for key, value in plan.items()
+            if key != 'trigger'
+        }
+
         # Add.
+
+        ## Database.
+        if self.database is not None:
+            task = self.wrap_record_db(task, note)
+
         job = self.scheduler.add_job(
             task,
             trigger,
             args,
             kwargs,
-            **trigger_kwargs
+            **trigger_args
         )
 
+        # Note.
+        self.notes[job.id] = note
+
         return job
 
 
     def modify_task(
         self,
         task: Job | str,
-        trigger: Literal['date', 'interval', 'cron'] | None = None,
-        args: tuple | None = None,
-        kwargs: dict | None = None,
-        **trigger_kwargs: Any
+        plan: dict[str, Any],
+        args: Any | None = None,
+        kwargs: Any | None = None,
+        note: str | None = None
     ) -> None:
         """
         Modify task.
@@ -172,37 +285,46 @@ class Schedule(Base):
         Parameters
         ----------
         task : Task instance or ID.
-        trigger : Trigger type.
+        plan : Plan trigger keyword arguments.
         args : Task position arguments.
         kwargs : Task keyword arguments.
-        trigger_kwargs : Trigger keyword arguments.
+        note : Task note.
         """
 
-        # Arguments.
-        params_arg = {}
-        if args is not None:
-            params_arg['args'] = args
-        if kwargs is not None:
-            params_arg['kwargs'] = kwargs
+        # Handle parameter.
+        if type(task) == Job:
+            task = task.id
+        if plan is None:
+            plan = {}
+        trigger = plan.get('trigger')
+        trigger_args = {
+            key: value
+            for key, value in plan.items()
+            if key != 'trigger'
+        }
 
-        ## Modify.
-        if params_arg != {}:
-            self.scheduler.modify_job(
-                task.id,
-                **params_arg
+        # Modify plan.
+        if plan != {}:
+            self.scheduler.reschedule_job(
+                task,
+                trigger=trigger,
+                **trigger_args
             )
 
-        # Trigger.
+        # Modify arguments.
         if (
-            trigger is not None
-            or trigger_kwargs != {}
+            args != ()
+            or kwargs != {}
         ):
-            self.scheduler.reschedule_job(
-                task.id,
-                trigger=trigger,
-                **trigger_kwargs
+            self.scheduler.modify_job(
+                task,
+                args=args,
+                kwargs=kwargs
             )
 
+        # Modify note.
+        self.notes[task] = note
+
 
     def remove_task(
         self,
@@ -270,4 +392,162 @@ class Schedule(Base):
         self.scheduler.resume_job(id_)
 
 
+    def build_db(self) -> None:
+        """
+        Check and build all standard databases and tables, by `self.db_names`.
+        """
+
+        # Check.
+        if self.database is None:
+            throw(ValueError, self.database)
+
+        # Set parameter.
+
+        ## Database.
+        databases = [
+            {
+                'name': self.db_names['base']
+            }
+        ]
+
+        ## Table.
+        tables = [
+
+            ### 'schedule'.
+            {
+                'path': (self.db_names['base'], self.db_names['base.schedule']),
+                'fields': [
+                    {
+                        'name': 'create_time',
+                        'type': 'datetime',
+                        'constraint': 'NOT NULL DEFAULT CURRENT_TIMESTAMP',
+                        'comment': 'Record create time.'
+                    },
+                    {
+                        'name': 'update_time',
+                        'type': 'datetime',
+                        'constraint': 'DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP',
+                        'comment': 'Record update time.'
+                    },
+                    {
+                        'name': 'id',
+                        'type': 'int unsigned',
+                        'constraint': 'NOT NULL AUTO_INCREMENT',
+                        'comment': 'ID.'
+                    },
+                    {
+                        'name': 'status',
+                        'type': 'tinyint',
+                        'constraint': 'NOT NULL',
+                        'comment': 'Schedule status, 0 is executing, 1 is completed, 2 is occurred error.'
+                    },
+                    {
+                        'name': 'task',
+                        'type': 'varchar(100)',
+                        'constraint': 'NOT NULL',
+                        'comment': 'Schedule task function name.'
+                    },
+                    {
+                        'name': 'note',
+                        'type': 'varchar(500)',
+                        'comment': 'Schedule note.'
+                    }
+                ],
+                'primary': 'id',
+                'indexes': [
+                    {
+                        'name': 'n_create_time',
+                        'fields': 'create_time',
+                        'type': 'noraml',
+                        'comment': 'Record create time normal index.'
+                    },
+                    {
+                        'name': 'n_update_time',
+                        'fields': 'update_time',
+                        'type': 'noraml',
+                        'comment': 'Record update time normal index.'
+                    },
+                    {
+                        'name': 'n_task',
+                        'fields': 'task',
+                        'type': 'noraml',
+                        'comment': 'Schedule task function name normal index.'
+                    }
+                ],
+                'comment': 'Schedule execute record table.'
+            }
+
+        ]
+
+        ## View stats.
+        views_stats = [
+
+            ### 'stats_schedule'.
+            {
+                'path': (self.db_names['base'], self.db_names['base.stats_schedule']),
+                'items': [
+                    {
+                        'name': 'count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`'
+                        ),
+                        'comment': 'Schedule count.'
+                    },
+                    {
+                        'name': 'past_day_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) = 0'
+                        ),
+                        'comment': 'Schedule count in the past day.'
+                    },
+                    {
+                        'name': 'past_week_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 6'
+                        ),
+                        'comment': 'Schedule count in the past week.'
+                    },
+                    {
+                        'name': 'past_month_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 29'
+                        ),
+                        'comment': 'Schedule count in the past month.'
+                    },
+                    {
+                        'name': 'task_count',
+                        'select': (
+                            'SELECT COUNT(DISTINCT `task`)\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`'
+                        ),
+                        'comment': 'Task count.'
+                    },
+                    {
+                        'name': 'last_time',
+                        'select': (
+                            'SELECT IFNULL(MAX(`update_time`), MAX(`create_time`))\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`'
+                        ),
+                        'comment': 'Schedule last record time.'
+                    }
+                ]
+
+            }
+
+        ]
+
+        # Build.
+        self.database.build.build(databases, tables, views_stats=views_stats)
+
+        ## Error.
+        self.database.error.build_db()
+
+
     __iter__ = tasks

{reykit-1.1.66.dist-info → reykit-1.1.68.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reykit
-Version: 1.1.66
+Version: 1.1.68
 Summary: Kit method set.
 Project-URL: homepage, https://github.com/reyxbo/reykit/
 Author-email: Rey <reyxbo@163.com>

{reykit-1.1.66.dist-info → reykit-1.1.68.dist-info}/RECORD

@@ -11,7 +11,7 @@ reykit/rnum.py,sha256=PhG4V_BkVfCJUsbpMDN1umGZly1Hsus80TW8bpyBtyY,3653
 reykit/ros.py,sha256=Yi_mfYzVHwjjUZke0BNX7PKFLZpoT5NRyj5aDOSNQRU,46911
 reykit/rrand.py,sha256=4VwooITgox54_GonELcJfcIpStDi-UJchpnyWKnyeIA,8606
 reykit/rre.py,sha256=1qva7xatKVE9qC2j7IujjXSM59qxHWwTYpiizFFQ8Xo,6024
-reykit/rschedule.py,sha256=QakEAtOcMg8uL2iOLre9uSsH-DsW6uAvzdXFiPJw_1o,5767
+reykit/rschedule.py,sha256=uUSZyWAjurkWPlvDO57OgRLAreeE7WHOV0J_MG6S-zY,14985
 reykit/rstdout.py,sha256=yesWo7wIGablpyAu-2J2Gw11Qp3GdQjGICTyIcvLyt4,8200
 reykit/rsys.py,sha256=AP62KyN40flCeQJBclfJq8shachSAFT0LkVjiKsXkrw,24946
 reykit/rtable.py,sha256=UQ-JlwjssMR3gY1iY-VGQEKQ5_BZabpJy6TL7Fx19c4,12200
@@ -22,7 +22,7 @@ reykit/rwrap.py,sha256=FEmeK_fboJ-OyXeJf8bilc7U2ph8xIbZGNHb6fLCy2c,15063
 reykit/rzip.py,sha256=BGEONswuBZxQ-zcgd_xp2fcvYesC9AmKaaXWvnT3bTI,3456
 reykit/rdll/__init__.py,sha256=nLSb8onBm2ilyoxzpDzUeGfSCKwkLEesIhzK3LiJ8mk,701
 reykit/rdll/rdll_core.py,sha256=o6-rKcTQgxZQe0kD3GnwyNb3KL9IogzgCQNOmYLMm7A,5086
-reykit-1.1.66.dist-info/METADATA,sha256=TXCGGPt494VS6fF95ogjAuJovsm4kqc-TCMinRBG-X8,1872
-reykit-1.1.66.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.1.66.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.1.66.dist-info/RECORD,,
+reykit-1.1.68.dist-info/METADATA,sha256=VkV4-QQHi1iAAq-8m7WMj0KO9qyqIsRkNfes0n2l6RM,1872
+reykit-1.1.68.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.1.68.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.1.68.dist-info/RECORD,,