reydb 1.1.28__py3-none-any.whl → 1.1.29__py3-none-any.whl

reydb/rlog.py

@@ -0,0 +1,303 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2025-08-20 16:57:19
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Database log methods.
+"""
+
+
+from typing import Any
+from collections.abc import Callable
+from traceback import StackSummary
+from functools import wraps as functools_wraps
+from reykit.rbase import T, throw, catch_exc
+
+from .rbase import DatabaseBase
+from .rconn import DatabaseConnection
+from .rdb import Database
+
+
+__all__ = (
+    'DatabaseLog',
+)
+
+
+class DatabaseLog(DatabaseBase):
+    """
+    Database log type.
+    Can create database used `self.build` method.
+    """
+
+
+    def __init__(self, database: Database | DatabaseConnection) -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        database : Database or DatabaseConnection instance.
+        """
+
+        # SQLite.
+        if database.backend == 'sqlite':
+            text='not suitable for SQLite databases'
+            throw(AssertionError, text=text)
+
+        # Build.
+        self.database = database
+
+        ## Database path name.
+        self.db_names = {
+            'log': 'log',
+            'log.error': 'error',
+            'log.error_stats': 'error_stats'
+        }
+
+
+    def build_db(self) -> None:
+        """
+        Check and build all standard databases and tables, by `self.db_names`.
+        """
+
+        # Set parameter.
+
+        ## Database.
+        databases = [
+            {
+                'name': self.db_names['log']
+            }
+        ]
+
+        ## Table.
+        tables = [
+
+            ### 'error'.
+            {
+                'path': (self.db_names['log'], self.db_names['log.error']),
+                'fields': [
+                    {
+                        'name': 'create_time',
+                        'type': 'datetime',
+                        'constraint': 'NOT NULL DEFAULT CURRENT_TIMESTAMP',
+                        'comment': 'Record create time.'
+                    },
+                    {
+                        'name': 'id',
+                        'type': 'int unsigned',
+                        'constraint': 'NOT NULL AUTO_INCREMENT',
+                        'comment': 'ID.'
+                    },
+                    {
+                        'name': 'type',
+                        'type': 'varchar(50)',
+                        'constraint': 'NOT NULL',
+                        'comment': 'Error type.'
+                    },
+                    {
+                        'name': 'data',
+                        'type': 'json',
+                        'comment': 'Error data.'
+                    },
+                    {
+                        'name': 'stack',
+                        'type': 'json',
+                        'comment': 'Error code traceback stack.'
+                    },
+                    {
+                        'name': 'note',
+                        'type': 'varchar(500)',
+                        'comment': 'Error note.'
+                    }
+                ],
+                'primary': 'id',
+                'indexes': [
+                    {
+                        'name': 'n_type',
+                        'fields': 'type',
+                        'type': 'noraml',
+                        'comment': 'Error type normal index.'
+                    }
+                ],
+                'comment': 'Error log table.'
+            },
+
+        ]
+
+        ## View stats.
+        views_stats = [
+
+            ### 'error_stats'.
+            {
+                'path': (self.db_names['log'], self.db_names['log.error_stats']),
+                'items': [
+                    {
+                        'name': 'count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['log']}`.`{self.db_names['log.error']}`'
+                        ),
+                        'comment': 'Error log count.'
+                    },
+                    {
+                        'name': 'past_day_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['log']}`.`{self.db_names['log.error']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) = 0'
+                        ),
+                        'comment': 'Error log count in the past day.'
+                    },
+                    {
+                        'name': 'past_week_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['log']}`.`{self.db_names['log.error']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 6'
+                        ),
+                        'comment': 'Error log count in the past week.'
+                    },
+                    {
+                        'name': 'past_month_count',
+                        'select': (
+                            'SELECT COUNT(1)\n'
+                            f'FROM `{self.db_names['log']}`.`{self.db_names['log.error']}`\n'
+                            'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 29'
+                        ),
+                        'comment': 'Error log count in the past month.'
+                    },
+                    {
+                        'name': 'last_time',
+                        'select': (
+                            'SELECT MAX(`create_time`)\n'
+                            f'FROM `{self.db_names['log']}`.`{self.db_names['log.error']}`'
+                        ),
+                        'comment': 'Error log last record create time.'
+                    }
+                ]
+
+            }
+
+        ]
+
+        # Build.
+        self.database.build.build(databases, tables, views_stats=views_stats)
+
+
+    def error(
+        self,
+        exc: BaseException,
+        stack: StackSummary,
+        note: str | None = None
+    ) -> None:
+        """
+        Insert exception information into the table of database.
+
+        Parameters
+        ----------
+        exc : Exception instance.
+        stack : Exception traceback stack instance.
+        note : Exception note.
+        """
+
+        # Handle parameter.
+        exc_type = type(exc).__name__
+        exc_data = list(exc.args) or None
+        exc_stack = [
+            {
+                'file': frame.filename,
+                'line': frame.lineno,
+                'frame': frame.name,
+                'code': frame.line
+            }
+            for frame in stack
+        ]
+        data = {
+            'type': exc_type,
+            'data': exc_data,
+            'stack': exc_stack,
+            'note': note
+        }
+
+        # Insert.
+        self.database.execute_insert(
+            (self.db_names['log'], self.db_names['log.error']),
+            data=data
+        )
+
+
+    def wrap_error(
+        self,
+        func: Callable[..., T] | None = None,
+        *,
+        note: str | None = None
+    ) -> T | Callable[[Callable[..., T]], Callable[..., T]]:
+        """
+        Decorator, insert exception information into the table of database.
+
+        Parameters
+        ----------
+        func : Function.
+        note : Exception note.
+
+        Returns
+        -------
+        Decorated function or decorator with parameter.
+        """
+
+
+        def _wrap(func_: Callable[..., T]) -> Callable[..., T]:
+            """
+            Decorator, insert exception information into the table of database.
+
+            Parameters
+            ----------
+            _func : Function.
+
+            Returns
+            -------
+            Decorated function.
+            """
+
+
+            @functools_wraps(func_)
+            def _func(*args, **kwargs) -> Any:
+                """
+                Decorated function.
+
+                Parameters
+                ----------
+                args : Position arguments of function.
+                kwargs : Keyword arguments of function.
+
+                Returns
+                -------
+                Function return.
+                """
+
+                # Try execute.
+                try:
+                    result = func_(*args, **kwargs)
+
+                # Log.
+                except BaseException:
+                    _, exc, stack = catch_exc()
+                    self.error(exc, stack, note)
+                    raise
+
+                return result
+
+
+            return _func
+
+
+        # Decorator.
+        if func is None:
+            return _wrap
+
+        # Decorated function.
+        else:
+            _func = _wrap(func)
+            return _func

reydb/rparam.py

@@ -11,19 +11,20 @@
 
 from typing import overload
 
-from .rbase import BaseDatabase
-from .rconn import DBConnection
+from .rbase import DatabaseBase
+from .rconn import DatabaseConnection
 from .rdb import Database
 
 
 __all__ = (
-    'DBParameter',
-    'DBPStatus',
-    'DBPVariable'
+    'DatabaseParameter',
+    'DatabaseParameterStatus',
+    'DatabaseParameterVariable',
+    'DatabaseParameterPragma'
 )
 
 
-class DBParameter(BaseDatabase):
+class DatabaseParameter(DatabaseBase):
     """
     Database parameters type.
     """
@@ -31,7 +32,7 @@ class DBParameter(BaseDatabase):
 
     def __init__(
         self,
-        rdatabase: Database | DBConnection,
+        rdatabase: Database | DatabaseConnection,
         global_: bool
     ) -> None:
         """
@@ -39,7 +40,7 @@ class DBParameter(BaseDatabase):
 
         Parameters
         ----------
-        rdatabase : Database or DBConnection instance.
+        rdatabase : Database or DatabaseConnection instance.
         global\\_ : Whether base global.
         """
 
@@ -84,7 +85,7 @@ class DBParameter(BaseDatabase):
         self.update(params)
 
 
-class DBPStatus(DBParameter):
+class DatabaseParameterStatus(DatabaseParameter):
     """
     Database parameter status type.
     """
@@ -154,7 +155,7 @@ class DBPStatus(DBParameter):
         raise AssertionError('database status not update')
 
 
-class DBPVariable(DBParameter):
+class DatabaseParameterVariable(DatabaseParameter):
     """
     Database parameter variable type.
     """
@@ -246,7 +247,7 @@ class DBPVariable(DBParameter):
         self.rdatabase.execute(sql)
 
 
-class DBPPragma(DBParameter):
+class DatabaseParameterPragma(DatabaseParameter):
     """
     Database parameter pragma type.
     """
@@ -254,14 +255,14 @@ class DBPPragma(DBParameter):
 
     def __init__(
         self,
-        rdatabase: Database | DBConnection
+        rdatabase: Database | DatabaseConnection
     ) -> None:
         """
         Build instance attributes.
 
         Parameters
         ----------
-        rdatabase : Database or DBConnection instance.
+        rdatabase : Database or DatabaseConnection instance.
         """
 
         # Set parameter.

{reydb-1.1.28.dist-info → reydb-1.1.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reydb
-Version: 1.1.28
+Version: 1.1.29
 Summary: Database method set.
 Project-URL: homepage, https://github.com/reyxbo/reydb/
 Author-email: Rey <reyxbo@163.com>

reydb-1.1.29.dist-info/RECORD

@@ -0,0 +1,15 @@
+reydb/__init__.py,sha256=U7zk2fbM2FbAWHdLDgXPX2wVc-NJKNeBGht09vVS5L4,504
+reydb/rall.py,sha256=iSjkt2aqJtKVio8jAghc7-V-7rWdjYu-2rR2vPUpaDE,362
+reydb/rbase.py,sha256=X8bDBmKyIiLXGvOVnTh5nD0ltkhOPWU6g4BebifOZYY,312
+reydb/rbuild.py,sha256=s4lLVQONfL5a9B6mw5D7bfbPyJoYNIqBxlas9rCM1Y8,32458
+reydb/rconn.py,sha256=kdw2xQb0JqSUXM-BD7XfJ-ZqaWHxYkeT8psRhOK43mA,6211
+reydb/rdb.py,sha256=hjWwB778jxBoTgx2lgs6n1NZMJA0Hbg4HHdXE57hZiY,61841
+reydb/rexec.py,sha256=dGdRkG1XR0Z66T0r4nPCSdQzSRWc_Q3t6TPSSrDTIxY,9042
+reydb/rfile.py,sha256=7g6hPBz33p-mkGFc6LEmL2hpFes-LM-AWQ0SxgJe2BI,15254
+reydb/rinfo.py,sha256=KXTkcpTGAD3p9RVKKcnmc_FjJtiKRPk-K5ZepPOnphQ,15253
+reydb/rlog.py,sha256=P1Y0Ci_RJz4vZrAf9f2ojWFRSV34Wf8ixoWXOc8-3dU,8862
+reydb/rparam.py,sha256=3BGDBD8QshOf2J70ZJ6LJ9PiH-1ZU3ruZwoE0bN6OOw,7017
+reydb-1.1.29.dist-info/METADATA,sha256=c0VyVKFNb7Xj6zoTx927oHRz48p5g-I9XeQoyzlV--4,1550
+reydb-1.1.29.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reydb-1.1.29.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reydb-1.1.29.dist-info/RECORD,,

reydb-1.1.28.dist-info/RECORD

@@ -1,14 +0,0 @@
-reydb/__init__.py,sha256=UetBDQylwFTWiPMKF1ZPW45A6mwYWWSYneTesl4xKBY,474
-reydb/rall.py,sha256=i6-ph2cahhTTF17DjUYf6KX3DNxhEvy6iedlSeF4ibI,341
-reydb/rbase.py,sha256=HMhxr7_TyzAusrv5dcc1hf3PmxGWj7m63kKcr5Ikbf4,312
-reydb/rbuild.py,sha256=LiYGOMZFnZi-aVGfWpKT2aEHks4ygbEubweB0-fczfQ,32344
-reydb/rconn.py,sha256=XmT4IizNYxCNi1zl88HCgHwkLcWMRWWBcDLwuvjV6aE,6542
-reydb/rdb.py,sha256=fAWwiFgHinOCHnalzh3IdFTrmFhnvjThm_WPoYG45dw,60878
-reydb/rexec.py,sha256=ezYqSxW6PvvILugnlWtq-BoxfBHAec9f2P5mgIp_heA,8910
-reydb/rfile.py,sha256=zZ9fbnwi4BpJbreRpOujwvE9J_rR_JWkH_5vbWPvKF4,13816
-reydb/rinfo.py,sha256=p8_nlOHWqnJCD0NRgbsxqnM2VKTDNO9jj4vwgd1HvG0,14267
-reydb/rparam.py,sha256=d8Ijn86ieYlWsHjAwIjrVujynfgKtMF1E-q41wGtd9Y,6855
-reydb-1.1.28.dist-info/METADATA,sha256=6wDADfjrQBPNtwAxMIIVOQG9_bi3PVe3g4PmDdc_MJM,1550
-reydb-1.1.28.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reydb-1.1.28.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reydb-1.1.28.dist-info/RECORD,,