reydb 1.1.61__py3-none-any.whl → 1.2.0__py3-none-any.whl

reydb/rorm.py

@@ -17,7 +17,8 @@ from pydantic import ConfigDict, field_validator as pydantic_field_validator, mo
 from sqlalchemy import text as sqlalchemy_text
 from sqlalchemy.orm import SessionTransaction
 from sqlalchemy.ext.asyncio import AsyncSessionTransaction
-from sqlalchemy.sql import sqltypes
+from sqlalchemy import types
+from sqlalchemy.dialects.mysql import types as types_mysql
 from sqlalchemy.sql.sqltypes import TypeEngine
 from sqlalchemy.sql.dml import Insert, Update, Delete
 from sqlmodel import SQLModel, Session, Table
@@ -37,8 +38,9 @@ from .rbase import (
 __all__ = (
     'DatabaseORMBase',
     'DatabaseORMModelMeta',
-    'DatabaseORMModel',
     'DatabaseORMModelField',
+    'DatabaseORMModel',
+    'DatabaseORMModelMethod',
     'DatabaseORMSuper',
     'DatabaseORM',
     'DatabaseORMAsync',
@@ -111,7 +113,7 @@ class DatabaseORMModelMeta(DatabaseORMBase, SQLModelMetaclass):
 
             ## Name.
             if '__name__' in attrs:
-                name = attrs.pop('__name__')
+                attrs['__tablename__'] = attrs.pop('__name__')
 
             ## Comment.
             if '__comment__' in attrs:
@@ -131,108 +133,6 @@ class DatabaseORMModelMeta(DatabaseORMBase, SQLModelMetaclass):
         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.
-
-        Returns
-        -------
-        New instance.
-        """
-
-        # Copy.
-        data = self.data
-        instance = self.__class__(**data)
-
-        return instance
-
-
-    @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(DatabaseORMBase, FieldInfo):
     """
     Database ORM model filed type.
@@ -289,7 +189,7 @@ class DatabaseORMModelField(DatabaseORMBase, FieldInfo):
         field_default : Database field defualt value.
             - `Literal['current_timestamp']`: Set SQL syntax 'current_timestamp', case insensitive.
             - `Literal['on update current_timestamp']`: Set SQL syntax 'on update current_timestamp', case insensitive.
-        filed_name : Database field name.
+        field_name : Database field name.
             - `None`: Same as attribute name.
         field_type : Database field type.
             - `None`: Based type annotation automatic judgment.
@@ -366,12 +266,12 @@ class DatabaseORMModelField(DatabaseORMBase, FieldInfo):
             kwargs['sa_column_kwargs']['server_default'] = field_default
 
         ## Field name.
-        if 'filed_name' in kwargs:
-            kwargs['sa_column_kwargs']['name'] = kwargs.pop('filed_name')
+        if 'field_name' in kwargs:
+            kwargs['sa_column_kwargs']['name'] = kwargs.pop('field_name')
 
         ## Field type.
-        if 'filed_name' in kwargs:
-            kwargs['sa_column_kwargs']['type_'] = kwargs.pop('filed_type')
+        if 'field_type' in kwargs:
+            kwargs['sa_type'] = kwargs.pop('field_type')
 
         ## Key auto.
         if 'key_auto' in kwargs:
@@ -393,6 +293,129 @@ class DatabaseORMModelField(DatabaseORMBase, FieldInfo):
         super().__init__(**kwargs)
 
 
+model_metaclass: SQLModelMetaclass = DatabaseORMModelMeta
+
+
+class DatabaseORMModel(DatabaseORMBase, SQLModel, metaclass=model_metaclass):
+    """
+    Database ORM model type.
+
+    Examples
+    --------
+    >>> class Foo(DatabaseORMModel, table=True):
+    ...     __name__ = 'Table name, default is class name.'
+    ...     __comment__ = 'Table comment.'
+    ...     ...
+    """
+
+
+    @classmethod
+    def _table(cls_or_self) -> Table:
+        """
+        Return mapping database table instance.
+
+        Returns
+        -------
+        Table instance.
+        """
+
+        # Get.
+        table: Table = cls_or_self.__table__
+
+        return table
+
+
+    @property
+    def _m(self):
+        """
+        Build database ORM model method instance.
+
+        Returns
+        -------
+        Instance.
+        """
+
+        # Build.
+        method = DatabaseORMModelMethod(self)
+
+        return method
+
+
+class DatabaseORMModelMethod(DatabaseORMBase):
+    """
+    Database ORM model method type.
+    """
+
+
+    def __init__(self, model: DatabaseORMModel) -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        model : Database ORM model instance.
+        """
+
+        # Build.
+        self.model = model
+
+
+    @property
+    def data(self) -> dict[str, Any]:
+        """
+        All attributes data.
+
+        Returns
+        -------
+        data.
+        """
+
+        # Get.
+        data = self.model.model_dump()
+
+        return data
+
+
+    def update(self, data: 'DatabaseORMModel | dict[dict, Any]') -> None:
+        """
+        Update attributes.
+
+        Parameters
+        ----------
+        data : `DatabaseORMModel` or `dict`.
+        """
+
+        # Update.
+        self.model.sqlmodel_update(data)
+
+
+    def validate(self) -> Self:
+        """
+        Validate all attributes, and copy self instance to new instance.
+        """
+
+        # Validate.
+        model = self.model.model_validate(self.model)
+
+        return model
+
+
+    def copy(self) -> Self:
+        """
+        Copy self instance to new instance.
+
+        Returns
+        -------
+        New instance.
+        """
+
+        # Copy.
+        data = self.data
+        instance = self.model.__class__(**data)
+
+        return instance
+
+
 class DatabaseORMSuper(DatabaseORMBase, Generic[DatabaseT, DatabaseORMSessionT]):
     """
     Database ORM super type.
@@ -412,7 +435,8 @@ class DatabaseORMSuper(DatabaseORMBase, Generic[DatabaseT, DatabaseORMSessionT])
     Model = DatabaseORMModel
     Field = DatabaseORMModelField
     Config = ConfigDict
-    types = sqltypes
+    types = types
+    types_mysql = types_mysql
     wrap_validate_model = pydantic_model_validator
     wrap_validate_filed = pydantic_field_validator
 
@@ -819,7 +843,7 @@ class DatabaseORMSession(
 
         # Handle parameter.
         tables = [
-            model.table()
+            model._table()
             for model in models
         ]
 
@@ -848,7 +872,7 @@ class DatabaseORMSession(
 
         # Handle parameter.
         tables = [
-            model.table()
+            model._table()
             for model in models
         ]
 
@@ -1185,7 +1209,7 @@ class DatabaseORMSessionAsync(
 
         # Handle parameter.
         tables = [
-            model.table()
+            model._table()
             for model in models
         ]
 
@@ -1215,7 +1239,7 @@ class DatabaseORMSessionAsync(
 
         # Handle parameter.
         tables = [
-            model.table()
+            model._table()
             for model in models
         ]
 

reydb/rparam.py

@@ -55,10 +55,9 @@ class DatabaseSchemaSuper(DatabaseBase, Generic[DatabaseT]):
         # Set parameter.
         self.db = db
 
-
-    def _call__before(self, filter_default: bool = True) -> tuple[str, tuple[str, ...]]:
+    def handle_before__call__(self, filter_default: bool = True) -> tuple[str, tuple[str, ...]]:
         """
-        Before handle of call method.
+        Before handle method of call method.
 
         Parameters
         ----------
@@ -98,9 +97,9 @@ class DatabaseSchemaSuper(DatabaseBase, Generic[DatabaseT]):
         return sql, filter_db
 
 
-    def _call__after(self, result: Result) -> dict[str, dict[str, list[str]]]:
+    def handle_after__call__(self, result: Result) -> dict[str, dict[str, list[str]]]:
         """
-        After handle of call method.
+        After handle method of call method.
 
         Parameters
         ----------
@@ -141,13 +140,80 @@ class DatabaseSchemaSuper(DatabaseBase, Generic[DatabaseT]):
         return schema_dict
 
 
+    @overload
+    def handle_exist(
+        self,
+        schema: dict[str, dict[str, list[str]]],
+        database: str
+    ) -> bool: ...
+
+    @overload
+    def handle_exist(
+        self,
+        schema: dict[str, dict[str, list[str]]],
+        database: str,
+        table: str
+    ) -> bool: ...
+
+    @overload
+    def handle_exist(
+        self,
+        schema: dict[str, dict[str, list[str]]],
+        database: str,
+        table: str,
+        column: str
+    ) -> bool: ...
+
+    def handle_exist(
+        self,
+        schema: dict[str, dict[str, list[str]]],
+        database: str,
+        table: str | None = None,
+        column: str | None = None
+    ) -> bool:
+        """
+        Handle method of judge database or table or column whether it exists.
+
+        Parameters
+        ----------
+        schema : Schemata of databases and tables and columns.
+        database : Database name.
+        table : Table name.
+        column : Column name.
+
+        Returns
+        -------
+        Judge result.
+        """
+
+        # Handle parameter.
+
+        # Judge.
+        judge = (
+            database in schema
+            and (
+                table is None
+                or (
+                    (database_info := schema.get(database)) is not None
+                    and (table_info := database_info.get(table)) is not None
+                )
+            )
+            and (
+                column is None
+                or column in table_info
+            )
+        )
+
+        return judge
+
+
 class DatabaseSchema(DatabaseSchemaSuper['rdb.Database']):
     """
     Database schema type.
     """
 
 
-    def __call__(self, filter_default: bool = True) -> dict[str, dict[str, list[str]]]:
+    def schema(self, filter_default: bool = True) -> dict[str, dict[str, list[str]]]:
         """
         Get schemata of databases and tables and columns.
 
@@ -161,11 +227,83 @@ class DatabaseSchema(DatabaseSchemaSuper['rdb.Database']):
         """
 
         # Get.
-        sql, filter_db = self._call__before(filter_default)
+        sql, filter_db = self.handle_before__call__(filter_default)
         result = self.db.execute(sql, filter_db=filter_db)
-        schema_dict = self._call__after(result)
+        schema = self.handle_after__call__(result)
 
-        return schema_dict
+        # Cache.
+        if self.db._schema is None:
+            self.db._schema = schema
+        else:
+            self.db._schema.update(schema)
+
+        return schema
+
+
+    __call__ = schema
+
+
+    @overload
+    def exist(
+        self,
+        database: str,
+        *,
+        refresh: bool = True
+    ) -> bool: ...
+
+    @overload
+    def exist(
+        self,
+        database: str,
+        *,
+        table: str,
+        refresh: bool = True
+    ) -> bool: ...
+
+    @overload
+    def exist(
+        self,
+        database: str,
+        table: str,
+        column: str,
+        refresh: bool = True
+    ) -> bool: ...
+
+    def exist(
+        self,
+        database: str,
+        table: str | None = None,
+        column: str | None = None,
+        refresh: bool = True
+    ) -> bool:
+        """
+        Judge database or table or column whether it exists.
+
+        Parameters
+        ----------
+        database : Database name.
+        table : Table name.
+        column : Column name.
+        refresh : Whether refresh cache data. Cache can improve efficiency.
+
+        Returns
+        -------
+        Judge result.
+        """
+
+        # Handle parameter.
+        if (
+            refresh
+            or self.db._schema is None
+        ):
+            schema = self.schema()
+        else:
+            schema = self.db._schema
+
+        # Judge.
+        result = self.handle_exist(schema, database, table, column)
+
+        return result
 
 
 class DatabaseSchemaAsync(DatabaseSchemaSuper['rdb.DatabaseAsync']):
@@ -174,7 +312,7 @@ class DatabaseSchemaAsync(DatabaseSchemaSuper['rdb.DatabaseAsync']):
     """
 
 
-    async def __call__(self, filter_default: bool = True) -> dict[str, dict[str, list[str]]]:
+    async def schema(self, filter_default: bool = True) -> dict[str, dict[str, list[str]]]:
         """
         Asynchronous get schemata of databases and tables and columns.
 
@@ -188,11 +326,81 @@ class DatabaseSchemaAsync(DatabaseSchemaSuper['rdb.DatabaseAsync']):
         """
 
         # Get.
-        sql, filter_db = self._call__before(filter_default)
+        sql, filter_db = self.handle_before__call__(filter_default)
         result = await self.db.execute(sql, filter_db=filter_db)
-        schema_dict = self._call__after(result)
+        schema = self.handle_after__call__(result)
 
-        return schema_dict
+        # Cache.
+        if self.db._schema is not None:
+            self.db._schema.update(schema)
+
+        return schema
+
+
+    __call__ = schema
+
+
+    @overload
+    async def exist(
+        self,
+        database: str,
+        *,
+        refresh: bool = True
+    ) -> bool: ...
+
+    @overload
+    async def exist(
+        self,
+        database: str,
+        *,
+        table: str,
+        refresh: bool = True
+    ) -> bool: ...
+
+    @overload
+    async def exist(
+        self,
+        database: str,
+        table: str,
+        column: str,
+        refresh: bool = True
+    ) -> bool: ...
+
+    async def exist(
+        self,
+        database: str,
+        table: str | None = None,
+        column: str | None = None,
+        refresh: bool = True
+    ) -> bool:
+        """
+        Asynchronous judge database or table or column whether it exists.
+
+        Parameters
+        ----------
+        database : Database name.
+        table : Table name.
+        column : Column name.
+        refresh : Whether refresh cache data. Cache can improve efficiency.
+
+        Returns
+        -------
+        Judge result.
+        """
+
+        # Handle parameter.
+        if (
+            refresh
+            or self.db._schema is None
+        ):
+            schema = await self.schema()
+        else:
+            schema = self.db._schema
+
+        # Judge.
+        result = self.handle_exist(schema, database, table, column)
+
+        return result
 
 
 class DatabaseParametersSuper(DatabaseBase, Generic[DatabaseT]):

{reydb-1.1.61.dist-info → reydb-1.2.0.dist-info}/METADATA

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

reydb-1.2.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+reydb/__init__.py,sha256=G2U0uiNjk2koYxIZjf9zvHoiQFO485XMnfQBMYSUdRc,549
+reydb/rall.py,sha256=sOeiVXSIo2voFiiZaRx8h7_wWrx8fFjXkRQRSYHQccA,365
+reydb/rbase.py,sha256=0QGHxbdrcyDTY6BK7zMCTM9cRDkZyVNlL7S1j7A4Zp0,8260
+reydb/rbuild.py,sha256=R_WQNpp67oHZFZlRuui_vaZAlJL4s_y5NX0gJXZY1yA,40320
+reydb/rconfig.py,sha256=mVRrkWa35stM5_sB0rD7VtgqLkVDv0BDnV_u2AGh0kI,18962
+reydb/rconn.py,sha256=guRaR8N6RuzZzujwaeq7HhKWTizF9SrUBqEAFjfjpoo,6909
+reydb/rdb.py,sha256=QB9het4tAPnJo4urWJ4oePI1g1avNI8O1P0-VPJLDEo,13809
+reydb/rerror.py,sha256=LlEmKREe88QKLU3xf4mF88nXnGSQodrUruQAm9ifUeQ,14781
+reydb/rexec.py,sha256=NLSvwwFhf60OndW3pjffzyMbWcLykhTbBbfI1YSueQ8,53223
+reydb/rorm.py,sha256=IipUvaFnS0gfHxzYkNSuM60skYsIGNBA9DvD8DnTpCc,40885
+reydb/rparam.py,sha256=S32dAKrCM0c4Qm-fhZkIRRhshsK1MmI12NgavNBfvJg,17443
+reydb-1.2.0.dist-info/METADATA,sha256=0wocK72W-r7ZRvnaiZ4JFfJ9RLVCkXs2u6yrx1foDFw,1621
+reydb-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reydb-1.2.0.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reydb-1.2.0.dist-info/RECORD,,