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

reydb/rorm.py

@@ -9,13 +9,18 @@
 """
 
 
-from typing import Self, Any, Type, TypeVar, Generic, Final
+from typing import Self, Any, Type, TypeVar, Generic, Final, overload
+from collections.abc import Callable
 from functools import wraps as functools_wraps
+from pydantic import ConfigDict, field_validator as pydantic_field_validator, model_validator as pydantic_model_validator
 from sqlalchemy.orm import SessionTransaction
+from sqlalchemy.sql import sqltypes
+from sqlalchemy.sql.sqltypes import TypeEngine
 from sqlalchemy.sql.dml import Insert, Update, Delete
-from sqlmodel import SQLModel, Session, Field as sqlmodel_Field
+from sqlmodel import SQLModel, Session, Table
+from sqlmodel.main import SQLModelMetaclass, FieldInfo
 from sqlmodel.sql._expression_select_cls import SelectOfScalar as Select
-from reykit.rbase import CallableT, is_instance
+from reykit.rbase import CallableT, Null, is_instance
 
 from .rbase import DatabaseBase
 from .rdb import Database
@@ -23,7 +28,9 @@ from .rdb import Database
 
 __all__ = (
     'DatabaseORMBase',
+    'DatabaseORMModelMeta',
     'DatabaseORMModel',
+    'DatabaseORMModelField',
     'DatabaseORM',
     'DatabaseORMSession',
     'DatabaseORMStatement',
@@ -34,18 +41,99 @@ __all__ = (
 )
 
 
+ModelT = TypeVar('ModelT', bound='DatabaseORMModel')
+
+
 class DatabaseORMBase(DatabaseBase):
     """
     Database ORM base type.
     """
 
 
-class DatabaseORMModel(DatabaseORMBase, SQLModel):
+class DatabaseORMModelMeta(DatabaseORMBase, SQLModelMetaclass):
+    """
+    Database ORM base meta type.
+    """
+
+
+    def __new__(
+        cls,
+        name: str,
+        bases: tuple[Type],
+        attrs: dict[str, Any],
+        **kwargs: Any
+    ) -> Type:
+        """
+        Create type.
+
+        Parameters
+        ----------
+        name : Type name.
+        bases : Type base types.
+        attrs : Type attributes and methods dictionary.
+        kwargs : Type other key arguments.
+        """
+
+        # Handle parameter.
+        if attrs['__module__'] == '__main__':
+            table_args = attrs.setdefault('__table_args__', {})
+            table_args['quote'] = True
+            if '__comment__' in attrs:
+                table_args['comment'] = attrs.pop('__comment__')
+
+            ## Field.
+            for __name__ in attrs['__annotations__']:
+                field = attrs.get(__name__)
+                if field is None:
+                    field = attrs[__name__] = DatabaseORMModelField()
+                sa_column_kwargs: dict = field.sa_column_kwargs
+                sa_column_kwargs.setdefault('name', __name__)
+
+        # Base.
+        new_cls = super().__new__(cls, name, bases, attrs, **kwargs)
+
+        return new_cls
+
+
+model_metaclass: SQLModelMetaclass = DatabaseORMModelMeta
+
+
+class DatabaseORMModel(DatabaseORMBase, SQLModel, metaclass=model_metaclass):
     """
     Database ORM model type.
+
+    Examples
+    --------
+    >>> class Foo(DatabaseORMModel, table=True):
+    ...     __comment__ = 'Table comment.'
+    ...     ...
     """
 
 
+    def update(self, data: 'DatabaseORMModel | dict[dict, Any]') -> None:
+        """
+        Update attributes.
+
+        Parameters
+        ----------
+        data : `DatabaseORMModel` or `dict`.
+        """
+
+        # Update.
+        self.sqlmodel_update(data)
+
+
+    def validate(self) -> Self:
+        """
+        Validate all attributes, and copy self instance to new instance.
+        """
+
+        # Validate.
+        model = self.model_validate(self)
+
+        return model
+
+
     def copy(self) -> Self:
         """
         Copy self instance to new instance.
@@ -56,13 +144,211 @@ class DatabaseORMModel(DatabaseORMBase, SQLModel):
         """
 
         # Copy.
-        data = self.model_dump()
+        data = self.data
         instance = self.__class__(**data)
 
         return instance
 
 
-ModelT = TypeVar('ModelT', bound=DatabaseORMModel)
+    @property
+    def data(self) -> dict[str, Any]:
+        """
+        All attributes data.
+
+        Returns
+        -------
+        data.
+        """
+
+        # Get.
+        data = self.model_dump()
+
+        return data
+
+
+    @classmethod
+    def table(cls_or_self) -> Table | None:
+        """
+        Mapping `Table` instance.
+
+        Returns
+        -------
+        Instance or null.
+        """
+
+        # Get.
+        table: Table | None = getattr(cls_or_self, '__table__', None)
+
+        return table
+
+
+    @classmethod
+    def comment(cls_or_self, comment: str) -> None:
+        """
+        Set table comment.
+
+        Parameters
+        ----------
+        comment : Comment.
+        """
+
+        # Set.
+        table = cls_or_self.table()
+        table.comment = comment
+
+
+class DatabaseORMModelField(DatabaseBase, FieldInfo):
+    """
+    Database ORM model filed type.
+
+    Examples
+    --------
+    >>> class Foo(DatabaseORMModel, table=True):
+    ...     key: int = DatabaseORMModelField(key=True, commment='Field commment.')
+    """
+
+
+    @overload
+    def __init__(
+        self,
+        arg_default: Any | Callable[[], Any] | Null = Null,
+        *,
+        arg_name: str | None = None,
+        field_default: str | None = None,
+        filed_name: str | None = None,
+        field_type: TypeEngine | None = None,
+        key: bool = False,
+        key_auto: bool = False,
+        non_null: bool = False,
+        index_n: bool = False,
+        index_u: bool = False,
+        comment: str | None = None,
+        unique: bool = False,
+        re: str | None = None,
+        len_min: int | None = None,
+        len_max: int | None = None,
+        num_gt: float | None = None,
+        num_ge: float | None = None,
+        num_lt: float | None = None,
+        num_le: float | None = None,
+        num_multiple: float | None = None,
+        num_places: int | None = None,
+        num_places_dec: int | None = None,
+        **kwargs: Any
+    ) -> None: ...
+
+    def __init__(
+        self,
+        arg_default: Any | Callable[[], Any] | Null = Null,
+        **kwargs: Any
+    ) -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        arg_default : Call argument default value.
+        arg_name : Call argument name.
+            - `None`: Same as attribute name.
+        field_default : Database field defualt value.
+        filed_name : Database field name.
+            - `None`: Same as attribute name.
+        field_type : Database field type.
+            - `None`: Based type annotation automatic judgment.
+        key : Whether the field is primary key.
+        key_auto : Whether the field is automatic increment primary key.
+        non_null : Whether the field is non null constraint.
+        index_n : Whether the field add normal index.
+        index_u : Whether the field add unique index.
+        comment : Field commment.
+        unique : Require the sequence element if is all unique.
+        re : Require the partial string if is match regular expression.
+        len_min : Require the sequence or string minimum length.
+        len_max : Require the sequence or string maximum length.
+        num_gt : Require the number greater than this value. (i.e. `number > num_gt`)
+        num_lt : Require the number less than this value. (i.e. `number < num_lt`)
+        num_ge : Require the number greater than and equal to this value. (i.e. `number >= num_ge`)
+        num_le : Require the number less than and equal to this value. (i.e. `number <= num_le`)
+        num_multiple : Require the number to be multiple of this value. (i.e. `number % num_multiple == 0`)
+        num_places : Require the number digit places maximum length.
+        num_places_dec : Require the number decimal places maximum length.
+        **kwargs : Other key arguments.
+        """
+
+        # Handle parameter.
+        kwargs = {
+            key: value
+            for key, value in kwargs.items()
+            if value not in (None, False)
+        }
+        kwargs.setdefault('sa_column_kwargs', {})
+        kwargs['sa_column_kwargs']['quote'] = True
+
+        ## Convert argument name.
+        mapping_keys = {
+            'arg_name': 'alias',
+            'key': 'primary_key',
+            'index_n': 'index',
+            'index_u': 'unique',
+            're': 'pattern',
+            'len_min': ('min_length', 'min_items'),
+            'len_max': ('max_length', 'max_items'),
+            'num_gt': 'gt',
+            'num_ge': 'ge',
+            'num_lt': 'lt',
+            'num_le': 'le',
+            'num_multiple': 'multiple_of',
+            'num_places': 'max_digits',
+            'num_places_dec': 'decimal_places'
+        }
+
+        for key_old, key_new in mapping_keys.items():
+            if type(key_new) != tuple:
+                key_new = (key_new,)
+            if key_old in kwargs:
+                value = kwargs.pop(key_old)
+                for key in key_new:
+                    kwargs[key] = value
+
+        ## Argument default.
+        if (
+            arg_default != Null
+            and callable(arg_default)
+        ):
+            kwargs['default_factory'] = arg_default
+        else:
+            kwargs['default'] = arg_default
+
+        ## Field default.
+        if 'field_default' in kwargs:
+            kwargs['sa_column_kwargs']['server_default'] = kwargs.pop('field_default')
+
+        ## Field name.
+        if 'filed_name' in kwargs:
+            kwargs['sa_column_kwargs']['name'] = kwargs.pop('filed_name')
+
+        ## Field type.
+        if 'filed_name' in kwargs:
+            kwargs['sa_column_kwargs']['type_'] = kwargs.pop('filed_type')
+
+        ## Key auto.
+        if 'key_auto' in kwargs:
+            kwargs['sa_column_kwargs']['autoincrement'] = True
+        else:
+            kwargs['sa_column_kwargs']['autoincrement'] = False
+
+        ## Non null.
+        if 'non_null' in kwargs:
+            kwargs['nullable'] = not kwargs.pop('non_null')
+        else:
+            kwargs['nullable'] = True
+
+        ## Comment.
+        if 'comment' in kwargs:
+            kwargs['sa_column_kwargs']['comment'] = kwargs.pop('comment')
+
+        # Base.
+        super().__init__(**kwargs)
 
 
 class DatabaseORM(DatabaseORMBase):
@@ -76,7 +362,11 @@ class DatabaseORM(DatabaseORMBase):
     """
 
     Model = DatabaseORMModel
-    Field = sqlmodel_Field
+    Field = DatabaseORMModelField
+    Config = ConfigDict
+    tyeps = sqltypes
+    wrap_validate_filed = pydantic_field_validator
+    wrap_validate_model = pydantic_model_validator
 
 
     def __init__(self, db: Database) -> None:
@@ -90,27 +380,80 @@ class DatabaseORM(DatabaseORMBase):
 
         # Build.
         self.db = db
+        self._session = self.session(True)
 
-        ## Avoid descriptor error.
-        self.Field = sqlmodel_Field
+        ## Method.
+        self.get = self._session.get
+        self.gets = self._session.gets
+        self.all = self._session.all
+        self.add = self._session.add
 
 
-    def session(self):
+    def session(self, autocommit: bool = False):
         """
         Build `DataBaseORMSession` instance.
 
+        Parameters
+        ----------
+        autocommit: Whether automatic commit execute.
+
         Returns
         -------
         Instance.
         """
 
         # Build.
-        sess = DataBaseORMSession(self)
+        sess = DataBaseORMSession(self, autocommit)
 
         return sess
 
 
-    __call__ = session
+    def create(
+        self,
+        *models: Type[DatabaseORMModel] | DatabaseORMModel,
+        skip: bool = False
+    ) -> None:
+        """
+        Create table.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        check : Skip existing table and not mapping model.
+        """
+
+        # Create.
+        for model in models:
+            table = model.table()
+            if (
+                not skip
+                or table is not None
+            ):
+                table.create(self.db.engine, checkfirst=skip)
+
+
+    def drop(
+        self,
+        *models: Type[DatabaseORMModel] | DatabaseORMModel,
+        skip: bool = False
+    ) -> None:
+        """
+        Delete table.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        check : Skip not exist table and not mapping model.
+        """
+
+        # Create.
+        for model in models:
+            table = model.table()
+            if (
+                not skip
+                or table is not None
+            ):
+                table.drop(self.db.engine, checkfirst=skip)
 
 
 class DataBaseORMSession(DatabaseORMBase):
@@ -119,18 +462,24 @@ class DataBaseORMSession(DatabaseORMBase):
     """
 
 
-    def __init__(self, orm: DatabaseORM) -> None:
+    def __init__(
+        self,
+        orm: 'DatabaseORM',
+        autocommit: bool = False
+    ) -> None:
         """
         Build instance attributes.
 
         Parameters
         ----------
         orm : `DatabaseORM` instance.
+        autocommit: Whether automatic commit execute.
         """
 
         # Build.
         self.orm = orm
-        self.session = Session(orm.db.engine)
+        self.autocommit = autocommit
+        self.session: Session | None = None
         self.begin: SessionTransaction | None = None
 
 
@@ -162,7 +511,9 @@ class DataBaseORMSession(DatabaseORMBase):
         """
 
         # Close.
-        self.session.close()
+        if self.session is not None:
+            self.session.close()
+            self.session = None
 
 
     def __enter__(self) -> Self:
@@ -202,9 +553,9 @@ class DataBaseORMSession(DatabaseORMBase):
     __del__ = close
 
 
-    def wrap_begin(method: CallableT) -> CallableT:
+    def wrap_transact(method: CallableT) -> CallableT:
         """
-        Decorator, create and store `SessionTransaction` instance.
+        Decorator, automated transaction.
 
         Parameters
         ----------
@@ -218,25 +569,76 @@ class DataBaseORMSession(DatabaseORMBase):
 
         # Define.
         @functools_wraps(method)
-        def wrap(self, *args, **kwargs):
+        def wrap(self: 'DataBaseORMSession', *args, **kwargs):
+
+            # Session.
+            if self.session is None:
+                self.session = Session(self.orm.db.engine)
 
-            # Create.
+            # Begin.
             if self.begin is None:
                 self.begin = self.session.begin()
 
             # Execute.
             result = method(self, *args, **kwargs)
 
+            # Autucommit.
+            if self.autocommit:
+                self.commit()
+                self.close()
+
             return result
 
 
         return wrap
 
 
-    @wrap_begin
+    @wrap_transact
+    def create(
+        self,
+        *models: Type[DatabaseORMModel] | DatabaseORMModel,
+        skip: bool = False
+    ) -> None:
+        """
+        Create table.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        check : Skip existing table.
+        """
+
+        # Create.
+        for model in models:
+            table = model.table()
+            table.create(self.session.connection(), checkfirst=skip)
+
+
+    @wrap_transact
+    def drop(
+        self,
+        *models: Type[DatabaseORMModel] | DatabaseORMModel,
+        skip: bool = False
+    ) -> None:
+        """
+        Delete table.
+
+        Parameters
+        ----------
+        models : ORM model instances.
+        check : Skip not exist table.
+        """
+
+        # Create.
+        for model in models:
+            table = model.table()
+            table.drop(self.session.connection(), checkfirst=skip)
+
+
+    @wrap_transact
     def get(self, model: Type[ModelT] | ModelT, key: Any | tuple[Any]) -> ModelT | None:
         """
-        select records by primary key.
+        Select records by primary key.
 
         Parameters
         ----------
@@ -257,10 +659,17 @@ class DataBaseORMSession(DatabaseORMBase):
         # Get.
         result = self.session.get(model, key)
 
+        # Autucommit.
+        if (
+            self.autocommit
+            and result is not None
+        ):
+            self.session.expunge(result)
+
         return result
 
 
-    @wrap_begin
+    @wrap_transact
     def gets(self, model: Type[ModelT] | ModelT, *keys: Any | tuple[Any]) -> list[ModelT]:
         """
         Select records by primary key sequence.
@@ -291,7 +700,7 @@ class DataBaseORMSession(DatabaseORMBase):
         return results
 
 
-    @wrap_begin
+    @wrap_transact
     def all(self, model: Type[ModelT] | ModelT) -> list[ModelT]:
         """
         Select all records.
@@ -305,13 +714,19 @@ class DataBaseORMSession(DatabaseORMBase):
         With records ORM model instance list.
         """
 
+        # Handle parameter.
+        if is_instance(model):
+            model = type(model)
+
         # Get.
-        models = self.select(model).execute()
+        select = Select(model)
+        models = self.session.exec(select)
+        models = list(models)
 
         return models
 
 
-    @wrap_begin
+    @wrap_transact
     def add(self, *models: DatabaseORMModel) -> None:
         """
         Insert records.
@@ -325,7 +740,7 @@ class DataBaseORMSession(DatabaseORMBase):
         self.session.add_all(models)
 
 
-    @wrap_begin
+    @wrap_transact
     def rm(self, *models: DatabaseORMModel) -> None:
         """
         Delete records.
@@ -340,7 +755,7 @@ class DataBaseORMSession(DatabaseORMBase):
             self.session.delete(model)
 
 
-    @wrap_begin
+    @wrap_transact
     def refresh(self, *models: DatabaseORMModel) -> None:
         """
         Refresh records.
@@ -355,7 +770,7 @@ class DataBaseORMSession(DatabaseORMBase):
             self.session.refresh(model)
 
 
-    @wrap_begin
+    @wrap_transact
     def expire(self, *models: DatabaseORMModel) -> None:
         """
         Mark records to expire, refresh on next call.
@@ -370,7 +785,7 @@ class DataBaseORMSession(DatabaseORMBase):
             self.session.expire(model)
 
 
-    @wrap_begin
+    @wrap_transact
     def select(self, model: Type[ModelT] | ModelT):
         """
         Build `DatabaseORMSelect` instance.
@@ -394,7 +809,7 @@ class DataBaseORMSession(DatabaseORMBase):
         return select
 
 
-    @wrap_begin
+    @wrap_transact
     def insert(self, model: Type[ModelT] | ModelT):
         """
         Build `DatabaseORMInsert` instance.
@@ -418,7 +833,7 @@ class DataBaseORMSession(DatabaseORMBase):
         return select
 
 
-    @wrap_begin
+    @wrap_transact
     def update(self, model: Type[ModelT] | ModelT):
         """
         Build `DatabaseORMUpdate` instance.
@@ -442,7 +857,7 @@ class DataBaseORMSession(DatabaseORMBase):
         return select
 
 
-    @wrap_begin
+    @wrap_transact
     def delete(self, model: Type[ModelT] | ModelT):
         """
         Build `DatabaseORMDelete` instance.
@@ -486,13 +901,13 @@ class DatabaseORMStatement(DatabaseORMBase):
         model : ORM model instance.
         """
 
+        # Base.
+        super().__init__(self.model)
+
         # Build.
         self.sess = sess
         self.model = model
 
-        # Init.
-        super().__init__(self.model)
-
 
     def execute(self) -> None:
         """

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

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