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

reykit/rschedule.py

@@ -9,14 +9,15 @@
 """
 
 
-from typing import Any, Literal
+from typing import Any, Literal, TypedDict, NotRequired
 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 +28,7 @@ __all__ = (
 class Schedule(Base):
     """
     Schedule type.
+    Can create database used `self.build_db` method.
     """
 
 
@@ -35,7 +37,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,6 +49,9 @@ 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.
@@ -70,6 +76,14 @@ class Schedule(Base):
 
         # Set attribute.
         self.scheduler = scheduler
+        self.database = database
+ 
+        ## Database path name.
+        self.db_names = {
+            'base': 'base',
+            'base.schedule': 'schedule',
+            'base.schedule_stats': 'schedule_stats'
+        }
 
 
     def start(self) -> None:
@@ -125,10 +139,9 @@ class Schedule(Base):
     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,
+        **kwargs: Any
     ) -> Job:
         """
         Add task.
@@ -136,23 +149,32 @@ 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.
 
         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.
         job = self.scheduler.add_job(
             task,
             trigger,
             args,
             kwargs,
-            **trigger_kwargs
+            **trigger_args
         )
 
         return job
@@ -161,10 +183,9 @@ class Schedule(Base):
     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,
+        **kwargs: Any
     ) -> None:
         """
         Modify task.
@@ -172,35 +193,40 @@ 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.
         """
 
-        # 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 trigger.
+        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(
+            self.scheduler.modify_job(
                 task.id,
-                trigger=trigger,
-                **trigger_kwargs
+                args=args,
+                kwargs=kwargs
             )
 
 
@@ -270,4 +296,279 @@ 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['worm']
+            }
+        ]
+
+        ## Table.
+        tables = [
+
+            ### 'douban_media'.
+            {
+                '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',
+                        'comment': 'Douban media ID.'
+                    },
+                    {
+                        'name': 'imdb',
+                        'type': 'char(10)',
+                        'comment': 'IMDb ID.'
+                    },
+                    {
+                        'name': 'type',
+                        'type': 'varchar(5)',
+                        'constraint': 'NOT NULL',
+                        'comment': 'Media type.'
+                    },
+                    {
+                        'name': 'name',
+                        'type': 'varchar(50)',
+                        '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.'
+                    },
+                    {
+                        '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.'
+                    }
+                ],
+                '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': 'u_imdb',
+                        'fields': 'imdb',
+                        'type': 'unique',
+                        'comment': 'IMDb number unique index.'
+                    },
+                    {
+                        'name': 'n_name',
+                        'fields': 'name',
+                        'type': 'noraml',
+                        'comment': 'Media name normal index.'
+                    }
+                ],
+                'comment': 'Douban media information table.'
+            }
+
+        ]
+
+        ## View stats.
+        views_stats = [
+
+            ### 'schedule_stats'.
+            {
+                'path': (self.db_names['base'], self.db_names['base.schedule_stats']),
+                'items': [
+                    {
+                        'name': 'count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
+                        ),
+                        'comment': 'Media count.'
+                    },
+                    {
+                        'name': 'past_day_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) = 0'
+                        ),
+                        'comment': 'Media 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'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 6'
+                        ),
+                        'comment': 'Media 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'
+                            '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.'
+                    },
+                    {
+                        'name': 'score_count',
+                        'select': (
+                            'SELECT FORMAT(SUM(`score_count`), 0)\n'
+                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
+                        ),
+                        'comment': 'Media score 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',
+                        'select': (
+                            'SELECT IFNULL(MAX(`update_time`), MAX(`create_time`))\n'
+                            f'FROM `{self.db_names['worm']}`.`{self.db_names['worm.douban_media']}`'
+                        ),
+                        'comment': 'Media last record update time.'
+                    }
+                ]
+
+            }
+
+        ]
+
+        # Build.
+        self.database.build.build(databases, tables, views_stats=views_stats)
+
+
     __iter__ = tasks

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reykit
-Version: 1.1.66
+Version: 1.1.67
 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.67.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=UfvreJ3QBvXxZAJOPZosI4Zp5isPOdgPn-oLTFeLD0k,17238
 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.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,,