reykit 1.1.67__py3-none-any.whl → 1.1.69__py3-none-any.whl

reykit/rschedule.py

@@ -10,6 +10,7 @@
 
 
 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
@@ -54,15 +55,15 @@ class Schedule(Base):
             - `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,
@@ -73,26 +74,22 @@ class Schedule(Base):
                 executors=executors,
                 job_defaults=job_defaults
             )
-
-        # Set attribute.
         self.scheduler = scheduler
+
+        ### Start.
+        self.scheduler.start()
+
+        ## Database.
         self.database = database
- 
-        ## Database path name.
+
+        ### Database path name.
         self.db_names = {
             'base': 'base',
             'base.schedule': 'schedule',
-            'base.schedule_stats': 'schedule_stats'
+            'base.stats_schedule': 'stats_schedule'
         }
 
-
-    def start(self) -> None:
-        """
-        Start scheduler.
-        """
-
-        # Start.
-        self.scheduler.start()
+        self.notes: dict[str, str] = {}
 
 
     def pause(self) -> None:
@@ -136,12 +133,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,
         plan: dict[str, Any],
-        *args: Any,
-        **kwargs: Any
+        args: Any | None = None,
+        kwargs: Any | None = None,
+        note: str | None = None
     ) -> Job:
         """
         Add task.
@@ -152,6 +228,7 @@ class Schedule(Base):
         plan : Plan trigger keyword arguments.
         args : Task position arguments.
         kwargs : Task keyword arguments.
+        note : Task note.
 
         Returns
         -------
@@ -169,6 +246,11 @@ class Schedule(Base):
         }
 
         # Add.
+
+        ## Database.
+        if self.database is not None:
+            task = self.wrap_record_db(task, note)
+
         job = self.scheduler.add_job(
             task,
             trigger,
@@ -177,6 +259,9 @@ class Schedule(Base):
             **trigger_args
         )
 
+        # Note.
+        self.notes[job.id] = note
+
         return job
 
 
@@ -184,8 +269,9 @@ class Schedule(Base):
         self,
         task: Job | str,
         plan: dict[str, Any],
-        *args: Any,
-        **kwargs: Any
+        args: Any | None = None,
+        kwargs: Any | None = None,
+        note: str | None = None
     ) -> None:
         """
         Modify task.
@@ -196,6 +282,7 @@ class Schedule(Base):
         plan : Plan trigger keyword arguments.
         args : Task position arguments.
         kwargs : Task keyword arguments.
+        note : Task note.
         """
 
         # Handle parameter.
@@ -210,7 +297,7 @@ class Schedule(Base):
             if key != 'trigger'
         }
 
-        # Modify trigger.
+        # Modify plan.
         if plan != {}:
             self.scheduler.reschedule_job(
                 task,
@@ -224,11 +311,14 @@ class Schedule(Base):
             or kwargs != {}
         ):
             self.scheduler.modify_job(
-                task.id,
+                task,
                 args=args,
                 kwargs=kwargs
             )
 
+        # Modify note.
+        self.notes[task] = note
+
 
     def remove_task(
         self,
@@ -310,14 +400,14 @@ class Schedule(Base):
         ## Database.
         databases = [
             {
-                'name': self.db_names['worm']
+                'name': self.db_names['base']
             }
         ]
 
         ## Table.
         tables = [
 
-            ### 'douban_media'.
+            ### 'schedule'.
             {
                 'path': (self.db_names['base'], self.db_names['base.schedule']),
                 'fields': [
@@ -336,123 +426,25 @@ class Schedule(Base):
                     {
                         'name': 'id',
                         'type': 'int unsigned',
-                        'constraint': 'NOT NULL',
-                        'comment': 'Douban media ID.'
-                    },
-                    {
-                        'name': 'imdb',
-                        'type': 'char(10)',
-                        'comment': 'IMDb ID.'
+                        'constraint': 'NOT NULL AUTO_INCREMENT',
+                        'comment': 'ID.'
                     },
                     {
-                        'name': 'type',
-                        'type': 'varchar(5)',
+                        'name': 'status',
+                        'type': 'tinyint',
                         'constraint': 'NOT NULL',
-                        'comment': 'Media type.'
+                        'comment': 'Schedule status, 0 is executing, 1 is completed, 2 is occurred error.'
                     },
                     {
-                        'name': 'name',
-                        'type': 'varchar(50)',
+                        'name': 'task',
+                        'type': 'varchar(100)',
                         'constraint': 'NOT NULL',
-                        'comment': 'Media name.'
-                    },
-                    {
-                        'name': 'year',
-                        'type': 'year',
-                        'constraint': 'NOT NULL',
-                        'comment': 'Release year.'
-                    },
-                    {
-                        'name': 'desc',
-                        'type': 'varchar(1000)',
-                        'comment': 'Media content description.'
+                        'comment': 'Schedule task function name.'
                     },
                     {
-                        'name': 'score',
-                        'type': 'float',
-                        'comment': 'Media score, [0,10].'
-                    },
-                    {
-                        'name': 'score_count',
-                        'type': 'int',
-                        'comment': 'Media score count.'
-                    },
-                    {
-                        'name': 'minute',
-                        'type': 'smallint',
-                        'comment': 'Movie or TV drama episode minute.'
-                    },
-                    {
-                        'name': 'episode',
-                        'type': 'smallint',
-                        'comment': 'TV drama total episode number.'
-                    },
-                    {
-                        'name': 'episode_now',
-                        'type': 'smallint',
-                        'comment': 'TV drama current episode number.'
-                    },
-                    {
-                        'name': 'premiere',
-                        'type': 'json',
-                        'comment': 'Premiere region and date dictionary.'
-                    },
-                    {
-                        'name': 'country',
-                        'type': 'json',
-                        'comment': 'Release country list.'
-                    },
-                    {
-                        'name': 'class',
-                        'type': 'json',
-                        'comment': 'Class list.'
-                    },
-                    {
-                        'name': 'director',
-                        'type': 'json',
-                        'comment': 'Director list.'
-                    },
-                    {
-                        'name': 'star',
-                        'type': 'json',
-                        'comment': 'Star list.'
-                    },
-                    {
-                        'name': 'scriptwriter',
-                        'type': 'json',
-                        'comment': 'Scriptwriter list.'
-                    },
-                    {
-                        'name': 'language',
-                        'type': 'json',
-                        'comment': 'Language list.'
-                    },
-                    {
-                        'name': 'alias',
-                        'type': 'json',
-                        'comment': 'Alias list.'
-                    },
-                    {
-                        'name': 'comment',
-                        'type': 'json',
-                        'comment': 'Comment list.'
-                    },
-                    {
-                        'name': 'image',
-                        'type': 'varchar(150)',
-                        'constraint': 'NOT NULL',
-                        'comment': 'Picture image URL.'
-                    },
-                    {
-                        'name': 'image_low',
-                        'type': 'varchar(150)',
-                        'constraint': 'NOT NULL',
-                        'comment': 'Picture image low resolution URL.'
-                    },
-                    {
-                        'name': 'video',
-                        'type': 'varchar(150)',
-                        'comment': 'Preview video Douban page URL.'
+                        'name': 'note',
+                        'type': 'varchar(500)',
+                        'comment': 'Schedule note.'
                     }
                 ],
                 'primary': 'id',
@@ -470,19 +462,13 @@ class Schedule(Base):
                         'comment': 'Record update time normal index.'
                     },
                     {
-                        'name': 'u_imdb',
-                        'fields': 'imdb',
-                        'type': 'unique',
-                        'comment': 'IMDb number unique index.'
-                    },
-                    {
-                        'name': 'n_name',
-                        'fields': 'name',
+                        'name': 'n_task',
+                        'fields': 'task',
                         'type': 'noraml',
-                        'comment': 'Media name normal index.'
+                        'comment': 'Schedule task function name normal index.'
                     }
                 ],
-                'comment': 'Douban media information table.'
+                'comment': 'Schedule execute record table.'
             }
 
         ]
@@ -490,76 +476,60 @@ class Schedule(Base):
         ## View stats.
         views_stats = [
 
-            ### 'schedule_stats'.
+            ### 'stats_schedule'.
             {
-                'path': (self.db_names['base'], self.db_names['base.schedule_stats']),
+                'path': (self.db_names['base'], self.db_names['base.stats_schedule']),
                 'items': [
                     {
                         'name': 'count',
                         'select': (
                             'SELECT COUNT(1)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`'
                         ),
-                        'comment': 'Media count.'
+                        'comment': 'Schedule count.'
                     },
                     {
                         'name': 'past_day_count',
                         'select': (
                             'SELECT COUNT(1)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`\n'
                             'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) = 0'
                         ),
-                        'comment': 'Media count in the past day.'
+                        'comment': 'Schedule count in the past day.'
                     },
                     {
                         'name': 'past_week_count',
                         'select': (
                             'SELECT COUNT(1)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`\n'
                             'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 6'
                         ),
-                        'comment': 'Media count in the past week.'
+                        'comment': 'Schedule count in the past week.'
                     },
                     {
                         'name': 'past_month_count',
                         'select': (
                             'SELECT COUNT(1)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`\n'
                             'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 29'
                         ),
-                        'comment': 'Media count in the past month.'
-                    },
-                    {
-                        'name': 'avg_score',
-                        'select': (
-                            'SELECT ROUND(AVG(`score`), 1)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
-                        ),
-                        'comment': 'Media average score.'
+                        'comment': 'Schedule count in the past month.'
                     },
                     {
-                        'name': 'score_count',
+                        'name': 'task_count',
                         'select': (
-                            'SELECT FORMAT(SUM(`score_count`), 0)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
+                            'SELECT COUNT(DISTINCT `task`)\n'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`'
                         ),
-                        'comment': 'Media score count.'
+                        'comment': 'Task count.'
                     },
                     {
-                        'name': 'last_create_time',
-                        'select': (
-                            'SELECT MAX(`create_time`)\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
-                        ),
-                        'comment': 'Media last record create time.'
-                    },
-                    {
-                        'name': 'last_update_time',
+                        'name': 'last_time',
                         'select': (
                             'SELECT IFNULL(MAX(`update_time`), MAX(`create_time`))\n'
-                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
+                            f'FROM `{self.db_names['base']}`.`{self.db_names['base.schedule']}`'
                         ),
-                        'comment': 'Media last record update time.'
+                        'comment': 'Schedule last record time.'
                     }
                 ]
 
@@ -570,5 +540,8 @@ class Schedule(Base):
         # Build.
         self.database.build.build(databases, tables, views_stats=views_stats)
 
+        ## Error.
+        self.database.error.build_db()
+
 
     __iter__ = tasks

{reykit-1.1.67.dist-info → reykit-1.1.69.dist-info}/METADATA

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

{reykit-1.1.67.dist-info → reykit-1.1.69.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=UfvreJ3QBvXxZAJOPZosI4Zp5isPOdgPn-oLTFeLD0k,17238
+reykit/rschedule.py,sha256=FC_8mfF9mj7EmmcDDgtVPEt9X1DST_iwNK15SctFSws,14901
 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.67.dist-info/METADATA,sha256=BGZWI7zUlK8aPG0rOlVMJENMKp12uK86Q6cYaLYaDE4,1872
-reykit-1.1.67.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.1.67.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.1.67.dist-info/RECORD,,
+reykit-1.1.69.dist-info/METADATA,sha256=j_h9WMxqDklZbv-Ch2SGAm7qWqW-nlLfqD_SUVVlWf4,1872
+reykit-1.1.69.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.1.69.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.1.69.dist-info/RECORD,,