reydb 1.1.49__py3-none-any.whl → 1.1.51__py3-none-any.whl

reydb/rorm.py

@@ -0,0 +1,567 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+@Time    : 2025-09-23 00:50:32
+@Author  : Rey
+@Contact : reyxbo@163.com
+@Explain : Database ORM methods.
+"""
+
+
+from typing import Self, Any, Type, TypeVar, Generic, Final
+from functools import wraps as functools_wraps
+from sqlalchemy.orm import SessionTransaction
+from sqlalchemy.sql.dml import Insert, Update, Delete
+from sqlmodel import SQLModel, Session, Field as sqlmodel_Field
+from sqlmodel.sql._expression_select_cls import SelectOfScalar as Select
+from reykit.rbase import CallableT, is_instance
+
+from .rbase import DatabaseBase
+from .rdb import Database
+
+
+__all__ = (
+    'DatabaseORMBase',
+    'DatabaseORMModel',
+    'DatabaseORM',
+    'DatabaseORMSession',
+    'DatabaseORMStatement',
+    'DatabaseORMStatementSelect',
+    'DatabaseORMStatementInsert',
+    'DatabaseORMStatementUpdate',
+    'DatabaseORMStatementDelete'
+)
+
+
+class DatabaseORMBase(DatabaseBase):
+    """
+    Database ORM base type.
+    """
+
+
+class DatabaseORMModel(DatabaseORMBase, SQLModel):
+    """
+    Database ORM model type.
+    """
+
+
+    def copy(self) -> Self:
+        """
+        Copy self instance to new instance.
+
+        Returns
+        -------
+        New instance.
+        """
+
+        # Copy.
+        data = self.model_dump()
+        instance = self.__class__(**data)
+
+        return instance
+
+
+ModelT = TypeVar('ModelT', bound=DatabaseORMModel)
+
+
+class DatabaseORM(DatabaseORMBase):
+    """
+    Database ORM type.
+
+    Attributes
+    ----------
+    DatabaseModel : Database ORM model type.
+    Field : Factory function of database ORM model field.
+    """
+
+    Model = DatabaseORMModel
+    Field = sqlmodel_Field
+
+
+    def __init__(self, db: Database) -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        db: `Database` instance.
+        """
+
+        # Build.
+        self.db = db
+
+        ## Avoid descriptor error.
+        self.Field = sqlmodel_Field
+
+
+    def session(self):
+        """
+        Build `DataBaseORMSession` instance.
+
+        Returns
+        -------
+        Instance.
+        """
+
+        # Build.
+        sess = DataBaseORMSession(self)
+
+        return sess
+
+
+    __call__ = session
+
+
+class DataBaseORMSession(DatabaseORMBase):
+    """
+    Database ORM session type, based ORM model.
+    """
+
+
+    def __init__(self, orm: DatabaseORM) -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        orm : `DatabaseORM` instance.
+        """
+
+        # Build.
+        self.orm = orm
+        self.session = Session(orm.db.engine)
+        self.begin: SessionTransaction | None = None
+
+
+    def commit(self) -> None:
+        """
+        Commit cumulative executions.
+        """
+
+        # Commit.
+        if self.begin is not None:
+            self.begin.commit()
+            self.begin = None
+
+
+    def rollback(self) -> None:
+        """
+        Rollback cumulative executions.
+        """
+
+        # Rollback.
+        if self.begin is not None:
+            self.begin.rollback()
+            self.begin = None
+
+
+    def close(self) -> None:
+        """
+        Close database connection.
+        """
+
+        # Close.
+        self.session.close()
+
+
+    def __enter__(self) -> Self:
+        """
+        Enter syntax `with`.
+
+        Returns
+        -------
+        Self.
+        """
+
+        return self
+
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        *_
+    ) -> None:
+        """
+        Exit syntax `with`.
+
+        Parameters
+        ----------
+        exc_type : Exception type.
+        """
+
+        # Commit.
+        if exc_type is None:
+            self.commit()
+
+        # Close.
+        else:
+            self.close()
+
+
+    __del__ = close
+
+
+    def wrap_begin(method: CallableT) -> CallableT:
+        """
+        Decorator, create and store `SessionTransaction` instance.
+
+        Parameters
+        ----------
+        method : Method.
+
+        Returns
+        -------
+        Decorated method.
+        """
+
+
+        # Define.
+        @functools_wraps(method)
+        def wrap(self, *args, **kwargs):
+
+            # Create.
+            if self.begin is None:
+                self.begin = self.session.begin()
+
+            # Execute.
+            result = method(self, *args, **kwargs)
+
+            return result
+
+
+        return wrap
+
+
+    @wrap_begin
+    def get(self, model: Type[ModelT] | ModelT, key: Any | tuple[Any]) -> ModelT | None:
+        """
+        select records by primary key.
+
+        Parameters
+        ----------
+        model : ORM model type or instance.
+        key : Primary key.
+            - `Any`: Single primary key.
+            - `tuple[Any]`: Composite primary key.
+
+        Returns
+        -------
+        With records ORM model instance or null.
+        """
+
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
+        # Get.
+        result = self.session.get(model, key)
+
+        return result
+
+
+    @wrap_begin
+    def gets(self, model: Type[ModelT] | ModelT, *keys: Any | tuple[Any]) -> list[ModelT]:
+        """
+        Select records by primary key sequence.
+
+        Parameters
+        ----------
+        model : ORM model type or instance.
+        keys : Primary key sequence.
+            - `Any`: Single primary key.
+            - `tuple[Any]`: Composite primary key.
+
+        Returns
+        -------
+        With records ORM model instance list.
+        """
+
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
+        # Get.
+        results = [
+            result
+            for key in keys
+            if (result := self.session.get(model, key)) is not None
+        ]
+
+        return results
+
+
+    @wrap_begin
+    def all(self, model: Type[ModelT] | ModelT) -> list[ModelT]:
+        """
+        Select all records.
+
+        Parameters
+        ----------
+        model : ORM model type or instance.
+
+        Returns
+        -------
+        With records ORM model instance list.
+        """
+
+        # Get.
+        models = self.select(model).execute()
+
+        return models
+
+
+    @wrap_begin
+    def add(self, *models: DatabaseORMModel) -> None:
+        """
+        Insert records.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        """
+
+        # Add.
+        self.session.add_all(models)
+
+
+    @wrap_begin
+    def rm(self, *models: DatabaseORMModel) -> None:
+        """
+        Delete records.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        """
+
+        # Delete.
+        for model in models:
+            self.session.delete(model)
+
+
+    @wrap_begin
+    def refresh(self, *models: DatabaseORMModel) -> None:
+        """
+        Refresh records.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        """ 
+
+        # Refresh.
+        for model in models:
+            self.session.refresh(model)
+
+
+    @wrap_begin
+    def expire(self, *models: DatabaseORMModel) -> None:
+        """
+        Mark records to expire, refresh on next call.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        """ 
+
+        # Refresh.
+        for model in models:
+            self.session.expire(model)
+
+
+    @wrap_begin
+    def select(self, model: Type[ModelT] | ModelT):
+        """
+        Build `DatabaseORMSelect` instance.
+
+        Parameters
+        ----------
+        model : ORM model instance.
+
+        Returns
+        -------
+        Instance.
+        """
+
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
+        # Build.
+        select = DatabaseORMStatementSelect[ModelT](self, model)
+
+        return select
+
+
+    @wrap_begin
+    def insert(self, model: Type[ModelT] | ModelT):
+        """
+        Build `DatabaseORMInsert` instance.
+
+        Parameters
+        ----------
+        model : ORM model instance.
+
+        Returns
+        -------
+        Instance.
+        """
+
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
+        # Build.
+        select = DatabaseORMStatementInsert[ModelT](self, model)
+
+        return select
+
+
+    @wrap_begin
+    def update(self, model: Type[ModelT] | ModelT):
+        """
+        Build `DatabaseORMUpdate` instance.
+
+        Parameters
+        ----------
+        model : ORM model instance.
+
+        Returns
+        -------
+        Instance.
+        """
+
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
+        # Build.
+        select = DatabaseORMStatementUpdate[ModelT](self, model)
+
+        return select
+
+
+    @wrap_begin
+    def delete(self, model: Type[ModelT] | ModelT):
+        """
+        Build `DatabaseORMDelete` instance.
+
+        Parameters
+        ----------
+        model : ORM model instance.
+
+        Returns
+        -------
+        Instance.
+        """
+
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
+        # Build.
+        select = DatabaseORMStatementDelete[ModelT](self, model)
+
+        return select
+
+
+class DatabaseORMStatement(DatabaseORMBase):
+    """
+    Database ORM statement type.
+    """
+
+
+    def __init__(
+        self,
+        sess: DataBaseORMSession,
+        model: Type[ModelT]
+    ) -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        sess : `DataBaseORMSession` instance.
+        model : ORM model instance.
+        """
+
+        # Build.
+        self.sess = sess
+        self.model = model
+
+        # Init.
+        super().__init__(self.model)
+
+
+    def execute(self) -> None:
+        """
+        Execute statement.
+        """
+
+        # Execute.
+        self.sess.session.exec(self)
+
+
+class DatabaseORMStatementSelect(DatabaseORMStatement, Select, Generic[ModelT]):
+    """
+    Database ORM `select` statement type.
+
+    Attributes
+    ----------
+    inherit_cache : Compatible `Select` type.
+    """
+
+    inherit_cache: Final = True
+
+
+    def execute(self) -> list[ModelT]:
+        """
+        Execute self statement.
+
+        Returns
+        -------
+        With records ORM model instance list.
+        """
+
+        # Execute.
+        result = self.sess.session.exec(self)
+        models = list(result)
+
+        return models
+
+
+class DatabaseORMStatementInsert(Generic[ModelT], DatabaseORMStatement, Insert):
+    """
+    Database ORM `insert` statement type.
+
+    Attributes
+    ----------
+    inherit_cache : Compatible `Select` type.
+    """
+
+    inherit_cache: Final = True
+
+
+class DatabaseORMStatementUpdate(Generic[ModelT], DatabaseORMStatement, Update):
+    """
+    Database ORM `update` statement type.
+
+    Attributes
+    ----------
+    inherit_cache : Compatible `Update` type.
+    """
+
+    inherit_cache: Final = True
+
+
+class DatabaseORMStatementDelete(Generic[ModelT], DatabaseORMStatement, Delete):
+    """
+    Database ORM `delete` statement type.
+
+    Attributes
+    ----------
+    inherit_cache : Compatible `Delete` type.
+    """
+
+    inherit_cache: Final = True

reydb/rparam.py

@@ -12,7 +12,6 @@
 from typing import overload
 
 from .rbase import DatabaseBase
-from .rconn import DatabaseConnection
 from .rdb import Database
 
 
@@ -32,7 +31,7 @@ class DatabaseParameters(DatabaseBase):
 
     def __init__(
         self,
-        rdatabase: Database | DatabaseConnection,
+        db: Database,
         global_: bool
     ) -> None:
         """
@@ -40,12 +39,12 @@ class DatabaseParameters(DatabaseBase):
 
         Parameters
         ----------
-        rdatabase : Database or DatabaseConnection instance.
+        db: `Database` instance.
         global\\_ : Whether base global.
         """
 
         # Set parameter.
-        self.rdatabase = rdatabase
+        self.db = db
         self.global_ = global_
 
 
@@ -126,13 +125,13 @@ class DatabaseParametersStatus(DatabaseParameters):
 
         ## Dictionary.
         if key is None:
-            result = self.rdatabase.execute(sql, key=key)
+            result = self.db.execute(sql, key=key)
             status = result.to_dict(val_field=1)
 
         ## Value.
         else:
             sql += ' LIKE :key'
-            result = self.rdatabase.execute(sql, key=key)
+            result = self.db.execute(sql, key=key)
             row = result.first()
             if row is None:
                 status = None
@@ -196,13 +195,13 @@ class DatabaseParametersVariable(DatabaseParameters):
 
         ## Dictionary.
         if key is None:
-            result = self.rdatabase.execute(sql, key=key)
+            result = self.db.execute(sql, key=key)
             variables = result.to_dict(val_field=1)
 
         ## Value.
         else:
             sql += ' LIKE :key'
-            result = self.rdatabase.execute(sql, key=key)
+            result = self.db.execute(sql, key=key)
             row = result.first()
             if row is None:
                 variables = None
@@ -244,7 +243,7 @@ class DatabaseParametersVariable(DatabaseParameters):
             sql = f'SET {sql_set}'
 
         # Execute SQL.
-        self.rdatabase.execute(sql)
+        self.db.execute(sql)
 
 
 class DatabaseParametersPragma(DatabaseParameters):
@@ -255,18 +254,18 @@ class DatabaseParametersPragma(DatabaseParameters):
 
     def __init__(
         self,
-        rdatabase: Database | DatabaseConnection
+        db: Database
     ) -> None:
         """
         Build instance attributes.
 
         Parameters
         ----------
-        rdatabase : Database or DatabaseConnection instance.
+        db: `Database` instance.
         """
 
         # Set parameter.
-        self.rdatabase = rdatabase
+        self.db = db
 
 
     def get(self, key: str) -> str | None:
@@ -286,7 +285,7 @@ class DatabaseParametersPragma(DatabaseParameters):
         sql = f'PRAGMA %s' % key
 
         # Execute SQL.
-        result = self.rdatabase.execute(sql)
+        result = self.db.execute(sql)
         row = result.first()
         if row is None:
             variables = None
@@ -320,4 +319,4 @@ class DatabaseParametersPragma(DatabaseParameters):
         sql = ';\n'.join(sql_set_list)
 
         # Execute SQL.
-        self.rdatabase.execute(sql)
+        self.db.execute(sql)

{reydb-1.1.49.dist-info → reydb-1.1.51.dist-info}/METADATA

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

reydb-1.1.51.dist-info/RECORD

@@ -0,0 +1,17 @@
+reydb/__init__.py,sha256=vwShFPkCDpLTrVGCq1AZgKCGQ8tBBodCxrvrib9ptrs,574
+reydb/rall.py,sha256=GsXHqvT1k--U53HpDY4SALjIHN8rwgSxeXpJjH5gq2E,409
+reydb/rbase.py,sha256=A7or663TcrQyq56P813WsV4BlApZIzXOPdZLsT7KwWw,7040
+reydb/rbuild.py,sha256=6N8aLqCeX8JnOwQstVA2AuM0Rl5kUHx5Enrm2GGcGvo,31852
+reydb/rconfig.py,sha256=kkqJg68bGZTE3JqH9dF1n-c1shuPJ4O8Bqg7J9Pd2CM,12659
+reydb/rconn.py,sha256=48c9bkfMsC993RCBsa4Dvca_ysCwNhYU2d1xiULQ6g8,2813
+reydb/rdb.py,sha256=Ijxja3lb73YmJfzpJBT3bQrqz9rV3TC5w2shQfwj0gQ,12919
+reydb/rerror.py,sha256=Lsl7UECYdIFYjd9t7RhvNcHdyGStI3gffm8zmkK1DEc,9943
+reydb/rexec.py,sha256=xROuWRjIj_j5Y2Iq41DhyyeQ7YNYCyv4pTih-7MxIoE,29073
+reydb/rfile.py,sha256=8HSrlpuslSCcWzjeh2y4Fs7R_qnm3jS_c13CDrKxpaw,15182
+reydb/rinfo.py,sha256=cQe5AJmPT_OyaXcNHCmYip2NETAKRvvESateR2STcw4,12745
+reydb/rorm.py,sha256=miv5K73rJ_ut2hrwdX1HjJke8R94U3ns75NxhAig3_M,11605
+reydb/rparam.py,sha256=six7wwQRKycoscv-AGyQqsPjA4_TZgcGQ_jk7FZytQs,6803
+reydb-1.1.51.dist-info/METADATA,sha256=kmP4hYYegLCJrFtjs5V6pl5nBxI4fXSSjvlbYMBxXGI,1550
+reydb-1.1.51.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reydb-1.1.51.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reydb-1.1.51.dist-info/RECORD,,

reydb-1.1.49.dist-info/RECORD

@@ -1,16 +0,0 @@
-reydb/__init__.py,sha256=SqjJEBMiUMnKkNfmOvw_jprZcj9Edi0jyBKt67xeYUE,544
-reydb/rall.py,sha256=UWnbtl4oG4YqXyqTMN_5uqE-QqD5nb_-dvarotlTUeU,388
-reydb/rbase.py,sha256=A7or663TcrQyq56P813WsV4BlApZIzXOPdZLsT7KwWw,7040
-reydb/rbuild.py,sha256=GafJ8ocDolj8OsvD9EvMZbR7hKb1WpyQv8LuQO4auKg,32083
-reydb/rconfig.py,sha256=h6L1QFtTcLgUcqzsn35lZfChcVBT0eVBzf5NOqzCUmQ,12721
-reydb/rconn.py,sha256=IGRiOkk0TzWj-NQ2o6A1FnMqYnDvg2G1Dd-7cA0dpP0,2765
-reydb/rdb.py,sha256=E6bFLCKI2f4XXatEsfKDRiZOnT42eYnvsJBV5-OyxQY,12600
-reydb/rerror.py,sha256=UcBU_EuiponHhraU2tqULcip-s5uNRnDmEQIA4IgrYc,10067
-reydb/rexec.py,sha256=xIUbTULfmMkLBYZTPX6lyN5yob-eg6M7Xir1j3jf6PM,29071
-reydb/rfile.py,sha256=OjQQRIZI-vZj0kv9Jljm4_kdp0aL005fAoTl0nAiYAg,15343
-reydb/rinfo.py,sha256=WXuN2sJtI7EK83HceLyoVXewILYtPxo9wDJFg7SQoJ8,13508
-reydb/rparam.py,sha256=6cnSjNlX54iPS1uxMQdpazPM5XL4J87vVgfL6CIYG3U,7031
-reydb-1.1.49.dist-info/METADATA,sha256=7Ae3lNDDvWlwHt4iyfsRzXkF-PlOgoEp7KL7k-U5LSg,1550
-reydb-1.1.49.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reydb-1.1.49.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reydb-1.1.49.dist-info/RECORD,,