rainycode 1.3.0__tar.gz → 1.4.1__tar.gz

{rainycode-1.3.0 → rainycode-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rainycode
-Version: 1.3.0
+Version: 1.4.1
 Summary: FastAPI base modules
 Requires-Python: >=3.10
 Requires-Dist: aerich==0.9.2

rainycode-1.4.1/common_models/base_model.py

@@ -0,0 +1,268 @@
+import uuid
+from collections.abc import Iterable
+from typing import Any
+
+from common_utils.snowflake_util import get_snowflake_id
+from core.databases.aiodb import MySQLUtils
+from tortoise import BaseDBAsyncClient, Model, fields
+from tortoise.expressions import Q
+from tortoise.queryset import BulkCreateQuery, QuerySet, QuerySetSingle
+from typing_extensions import Self
+
+
+class BaseModel(MySQLUtils):
+    
+    @classmethod
+    async def create(
+            cls,
+            using_db: BaseDBAsyncClient | None = None,
+            **kwargs: Any
+    ) -> Self:
+        if not kwargs.get('id', 0) and 'id' in cls._meta.fields:
+            # uuid生成id
+            if kwargs.get('id_uuid', False):
+                kwargs['id'] = str(uuid.uuid4()).replace('-', '')
+            # 雪花算法生成id
+            if kwargs.get('id_snowflake', False):
+                kwargs['id'] = get_snowflake_id()
+        return await super().create(using_db=using_db, **kwargs)
+
+    @classmethod
+    def get(
+        cls,
+        *args: Q, 
+        using_db: BaseDBAsyncClient | None = None, 
+        **kwargs: Any
+    ) -> QuerySetSingle[Self]:
+        if 'deleted' in cls._meta.fields:
+            deleted = kwargs.get('deleted')
+            if deleted is None:
+                # 默认只查未删除的记录
+                kwargs['deleted'] = 0
+            elif deleted == -1:
+                # -1 表示不过滤 deleted 字段，未删除(0)和已删除(1)的记录都可查
+                kwargs.pop('deleted', None)
+            # 其余值（0/1）原样透传
+        return super().get(*args, using_db=using_db, **kwargs)
+
+    @classmethod
+    def filter(
+        cls, 
+        *args: Q, 
+        **kwargs: Any
+    ) -> QuerySet[Self]:
+        if 'deleted' in cls._meta.fields:
+            deleted = kwargs.get('deleted')
+            if deleted is None:
+                # 默认只查未删除的记录
+                kwargs['deleted'] = 0
+            elif deleted == -1:
+                # -1 表示不过滤 deleted 字段，未删除(0)和已删除(1)的记录都可查
+                kwargs.pop('deleted', None)
+            # 其余值（0/1）原样透传
+        return cls._meta.manager.get_queryset().filter(*args, **kwargs)
+
+    @classmethod
+    def bulk_create(
+            cls,
+            objects: Iterable[Self],
+            batch_size: int | None = None,
+            ignore_conflicts: bool = False,
+            update_fields: Iterable[str] | None = None,
+            on_conflict: Iterable[str] | None = None,
+            using_db: BaseDBAsyncClient | None = None,
+            **kwargs: Any
+    ) -> "BulkCreateQuery[Self]":
+        if 'id' in cls._meta.fields:
+            for obj in objects:
+                if not getattr(obj, 'id', 0):
+                    # uuid生成id
+                    if kwargs.get('id_uuid', False):
+                        obj.id = str(uuid.uuid4()).replace('-', '')
+                    # 雪花算法生成id
+                    if kwargs.get('id_snowflake', False):
+                        obj.id = get_snowflake_id()
+
+        params = {
+            "objects": objects,
+            "batch_size": batch_size,
+            "ignore_conflicts": ignore_conflicts,
+            "update_fields": update_fields,
+            "on_conflict": on_conflict,
+            "using_db": using_db,
+        }    
+        return super().bulk_create(**params)
+
+    async def save(
+            self,
+            using_db: BaseDBAsyncClient | None = None,
+            update_fields: Iterable[str] | None = None,
+            force_create: bool = False,
+            force_update: bool = False,
+            **kwargs: Any
+    ) -> None:
+        if not getattr(self, 'id', 0) and kwargs.get('id_uuid', False)  and 'id' in self._meta.fields:
+            setattr(self, 'id', str(uuid.uuid4()).replace('-', ''))
+        return await super().save(using_db=using_db, update_fields=update_fields, force_create=force_create,
+                                  force_update=force_update)
+
+
+class TimeModel(BaseModel):
+    update_time = fields.DatetimeField(auto_now=True, description='更新时间')
+    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
+
+    class Meta:
+        abstract = True
+
+
+# class CreateModel(BaseModel):
+#     create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
+#     creator = fields.CharField(max_length=50, null=True, description="创建人")
+
+#     class Meta:
+#         abstract = True
+
+
+# class UpdateModel(BaseModel):
+#     update_time = fields.DatetimeField(auto_now=True, description='更新时间')
+#     create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
+#     updater = fields.CharField(max_length=50, null=True, description="更新人")
+#     creator = fields.CharField(max_length=50, null=True, description="创建人")
+
+#     class Meta:
+#         abstract = True
+
+
+# class DeleteModel(BaseModel):
+#     deleted = fields.IntField(default=0, description="是否已删除, 0:未删除, 1:已删除")
+#     create_time = fields.DatetimeField(auto_now_add=True, description="创建时间")
+#     update_time = fields.DatetimeField(auto_now=True, description="更新时间")
+#     creator = fields.CharField(max_length=50, null=True, description="创建人")
+#     updater = fields.CharField(max_length=50, null=True, description="更新人")
+
+
+class CreateRelatedMeta(type(Model)):
+    """元类：更新外键字段，解决用户related_name重复问题"""
+    def __new__(cls, name: str, bases: tuple, attrs: dict):
+        if name == 'CreateModel':
+            return super().__new__(cls, name, bases, attrs)
+
+        creator_related_name = f"{name.lower()}_creator"
+        attrs["creator"] = fields.ForeignKeyField(
+            'main.User',
+            null=True,
+            related_name=creator_related_name,
+            db_constraint=False,
+            description="创建人"
+        )
+
+        new_class = super().__new__(cls, name, bases, attrs)
+        return new_class
+
+
+class CreateModel(BaseModel, metaclass=CreateRelatedMeta):
+    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
+    creator = fields.ForeignKeyField(
+        'main.User',
+        null=True,
+        db_constraint=False,
+        description="创建人"
+    )
+
+    class Meta:
+        abstract = True
+
+
+class UpdateRelatedMeta(type(Model)):
+    """元类：更新外键字段，解决用户related_name重复问题"""
+    def __new__(cls, name: str, bases: tuple, attrs: dict):
+        if name == 'UpdateModel':
+            return super().__new__(cls, name, bases, attrs)
+
+        creator_related_name = f"{name.lower()}_creator"
+        attrs["creator"] = fields.ForeignKeyField(
+            'main.User',
+            null=True,
+            related_name=creator_related_name,
+            db_constraint=False,
+            description="创建人"
+        )
+
+        updater_related_name = f"{name.lower()}_updater"
+        attrs["updater"] = fields.ForeignKeyField(
+            'main.User',
+            null=True,
+            related_name=updater_related_name,
+            db_constraint=False,
+            description="更新人"
+        )
+
+        new_class = super().__new__(cls, name, bases, attrs)
+        return new_class
+
+
+class UpdateModel(BaseModel, metaclass=UpdateRelatedMeta):
+    update_time = fields.DatetimeField(auto_now=True, description='更新时间')
+    updater = fields.ForeignKeyField(
+        'main.User',
+        null=True,
+        db_constraint=False,
+        description="更新人"
+    )
+    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
+    creator = fields.ForeignKeyField(
+        'main.User',
+        null=True,
+        db_constraint=False,
+        description="创建人"
+    )
+    class Meta:
+        abstract = True      
+
+
+class DeleteRelatedMeta(type(Model)):
+    """元类：更新外键字段，解决用户related_name重复问题"""
+    def __new__(cls, name: str, bases: tuple, attrs: dict):
+        if name == 'DeleteModel':
+            return super().__new__(cls, name, bases, attrs)
+
+        creator_related_name = f"{name.lower()}_creator"
+        attrs["creator"] = fields.ForeignKeyField(
+            'main.User',
+            null=True,
+            related_name=creator_related_name,
+            db_constraint=False,
+            description="创建人"
+        )
+
+        updater_related_name = f"{name.lower()}_updater"
+        attrs["updater"] = fields.ForeignKeyField(
+            'main.User',
+            null=True,
+            related_name=updater_related_name,
+            db_constraint=False,
+            description="更新人"
+        )
+
+        new_class = super().__new__(cls, name, bases, attrs)
+        return new_class
+
+
+class DeleteModel(BaseModel, metaclass=DeleteRelatedMeta):
+    deleted = fields.IntField(default=0, description="是否已删除, 0:未删除, 1:已删除")
+    update_time = fields.DatetimeField(auto_now=True, description='更新时间')
+    updater = fields.ForeignKeyField(
+        'main.User',
+        null=True,
+        db_constraint=False,
+        description="更新人"
+    )
+    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
+    creator = fields.ForeignKeyField(
+        'main.User',
+        null=True,
+        db_constraint=False,
+        description="创建人"
+    )
+    class Meta:
+        abstract = True

{rainycode-1.3.0 → rainycode-1.4.1}/common_utils/captcha_util.py

@@ -10,7 +10,16 @@ class CaptchaUtil:
     """
     验证码工具类
     """
-    @classmethod 
+    @classmethod
+    def generate_code(cls, length: int = 6) -> str:
+        """
+        生成随机验证码（纯随机生成；存储/TTL/校验由调用方自行处理）
+        字符集去 0/O、1/I/L，避免误读
+        """
+        alphabet = "ABCDEFGHJKLMNPQRSTUVWXYZ23456789"
+        return "".join(random.choice(alphabet) for _ in range(length))
+
+    @classmethod
     def generate_captcha(cls) -> tuple[str, str]:
         """
         生成带有噪声和干扰的验证码图片：4位随机字符

{rainycode-1.3.0 → rainycode-1.4.1}/core/databases/aiodb.py

@@ -234,8 +234,15 @@ class MySQLUtils(Model):
             queryset_model: QuerySetSingle | Model | None = None,
             **kwargs
     ) -> dict[str, Any] | None:
-        if 'deleted' in cls._meta.fields and deleted is None:
-            kwargs['deleted'] = False
+        if 'deleted' in cls._meta.fields:
+            deleted = kwargs.get('deleted')
+            if deleted is None:
+                # 默认只查未删除的记录
+                kwargs['deleted'] = 0
+            elif deleted == -1:
+                # -1 表示不过滤 deleted 字段，未删除(0)和已删除(1)的记录都可查
+                kwargs.pop('deleted', None)
+            # 其余值（0/1）原样透传
 
         queryKwargs = {}
         if fetch_related:
@@ -274,8 +281,15 @@ class MySQLUtils(Model):
             queryset_model: QuerySetSingle | Model | None = None,
             **kwargs
     ) -> dict[str, Any] | None:
-        if 'deleted' in cls._meta.fields and deleted is None:
-            kwargs['deleted'] = False
+        if 'deleted' in cls._meta.fields:
+            deleted = kwargs.get('deleted')
+            if deleted is None:
+                # 默认只查未删除的记录
+                kwargs['deleted'] = 0
+            elif deleted == -1:
+                # -1 表示不过滤 deleted 字段，未删除(0)和已删除(1)的记录都可查
+                kwargs.pop('deleted', None)
+            # 其余值（0/1）原样透传
 
         queryKwargs = {}
         if fetch_related:
@@ -318,8 +332,15 @@ class MySQLUtils(Model):
             order_by: list[str] | None = None,
             **kwargs
     ) -> dict[str, Any] | list[dict[str, Any]]:
-        if 'deleted' in cls._meta.fields and deleted is None:
-            kwargs['deleted'] = False
+        if 'deleted' in cls._meta.fields:
+            deleted = kwargs.get('deleted')
+            if deleted is None:
+                # 默认只查未删除的记录
+                kwargs['deleted'] = 0
+            elif deleted == -1:
+                # -1 表示不过滤 deleted 字段，未删除(0)和已删除(1)的记录都可查
+                kwargs.pop('deleted', None)
+            # 其余值（0/1）原样透传
 
         queryKwargs = {}
         if fetch_related:

{rainycode-1.3.0 → rainycode-1.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rainycode"
-version = "1.3.0"
+version = "1.4.1"
 description = "FastAPI base modules"
 requires-python = ">=3.10"
 

{rainycode-1.3.0 → rainycode-1.4.1}/rainycode.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rainycode
-Version: 1.3.0
+Version: 1.4.1
 Summary: FastAPI base modules
 Requires-Python: >=3.10
 Requires-Dist: aerich==0.9.2

rainycode-1.3.0/common_models/base_model.py

@@ -1,209 +0,0 @@
-import uuid
-from collections.abc import Iterable
-from typing import Any, Optional
-
-from common_utils.snowflake_util import get_snowflake_id
-from core.databases.aiodb import MySQLUtils
-from tortoise import BaseDBAsyncClient, fields
-from tortoise.expressions import Q
-from tortoise.queryset import BulkCreateQuery, QuerySet, QuerySetSingle
-from typing_extensions import Self
-
-
-class BaseModel(MySQLUtils):
-    
-    @classmethod
-    async def create(
-            cls,
-            using_db: BaseDBAsyncClient | None = None,
-            **kwargs: Any
-    ) -> Self:
-        if not kwargs.get('id', 0) and 'id' in cls._meta.fields:
-            # uuid生成id
-            if kwargs.get('id_uuid', False):
-                kwargs['id'] = str(uuid.uuid4()).replace('-', '')
-            # 雪花算法生成id
-            if kwargs.get('id_snowflake', False):
-                kwargs['id'] = get_snowflake_id()
-        return await super().create(using_db=using_db, **kwargs)
-
-    @classmethod
-    def get(
-        cls,
-        *args: Q, 
-        using_db: BaseDBAsyncClient | None = None, 
-        **kwargs: Any
-    ) -> QuerySetSingle[Self]:
-        if 'deleted' in cls._meta.fields and kwargs.get('deleted', None) is None:
-            kwargs['deleted'] = False
-        return super().get(*args, using_db=using_db, **kwargs)
-
-    @classmethod
-    def filter(
-        cls, 
-        *args: Q, 
-        **kwargs: Any
-    ) -> QuerySet[Self]:
-        if 'deleted' in cls._meta.fields and kwargs.get('deleted', None) is None:
-            kwargs['deleted'] = False
-        return cls._meta.manager.get_queryset().filter(*args, **kwargs)
-
-    @classmethod
-    def bulk_create(
-            cls,
-            objects: Iterable[Self],
-            batch_size: int | None = None,
-            ignore_conflicts: bool = False,
-            update_fields: Iterable[str] | None = None,
-            on_conflict: Iterable[str] | None = None,
-            using_db: BaseDBAsyncClient | None = None,
-            **kwargs: Any
-    ) -> "BulkCreateQuery[Self]":
-        if 'id' in cls._meta.fields:
-            for obj in objects:
-                if not getattr(obj, 'id', 0):
-                    # uuid生成id
-                    if kwargs.get('id_uuid', False):
-                        obj.id = str(uuid.uuid4()).replace('-', '')
-                    # 雪花算法生成id
-                    if kwargs.get('id_snowflake', False):
-                        obj.id = get_snowflake_id()
-
-        params = {
-            "objects": objects,
-            "batch_size": batch_size,
-            "ignore_conflicts": ignore_conflicts,
-            "update_fields": update_fields,
-            "on_conflict": on_conflict,
-            "using_db": using_db,
-        }    
-        return super().bulk_create(**params)
-
-    async def save(
-            self,
-            using_db: BaseDBAsyncClient | None = None,
-            update_fields: Iterable[str] | None = None,
-            force_create: bool = False,
-            force_update: bool = False,
-            **kwargs: Any
-    ) -> None:
-        if not getattr(self, 'id', 0) and kwargs.get('id_uuid', False)  and 'id' in self._meta.fields:
-            setattr(self, 'id', str(uuid.uuid4()).replace('-', ''))
-        return await super().save(using_db=using_db, update_fields=update_fields, force_create=force_create,
-                                  force_update=force_update)
-
-
-class TimeModel(BaseModel):
-    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
-    update_time = fields.DatetimeField(auto_now=True, description='更新时间')
-
-    class Meta:
-        abstract = True
-
-
-class CreateModel(BaseModel):
-    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
-    creator = fields.CharField(max_length=50, null=True, description="创建人")
-
-    class Meta:
-        abstract = True
-
-
-class UpdateModel(BaseModel):
-    create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
-    update_time = fields.DatetimeField(auto_now=True, description='更新时间')
-    creator = fields.CharField(max_length=50, null=True, description="创建人")
-    updater = fields.CharField(max_length=50, null=True, description="更新人")
-
-    class Meta:
-        abstract = True
-
-
-class DeleteModel(BaseModel):
-    deleted = fields.BooleanField(default=False, description="是否已删除")
-    create_time = fields.DatetimeField(auto_now_add=True, description="创建时间")
-    update_time = fields.DatetimeField(auto_now=True, description="更新时间")
-    creator = fields.CharField(max_length=50, null=True, description="创建人")
-    updater = fields.CharField(max_length=50, null=True, description="更新人")
-
-
-# class CreateRelatedMeta(type(Model)):
-#     """元类：更新外键字段，解决用户related_name重复问题"""
-#     def __new__(cls, name: str, bases: tuple, attrs: dict):
-#         if name == 'UpdateModel':
-#             return super().__new__(cls, name, bases, attrs)
-
-#         creator_related_name = f"{name.lower()}_creator"
-#         attrs["creator"] = fields.ForeignKeyField(
-#             'main.SystemUserModel',
-#             null=True,
-#             related_name=creator_related_name,
-#             db_constraint=False,
-#             description="创建人"
-#         )
-
-#         new_class = super().__new__(cls, name, bases, attrs)
-#         return new_class
-
-
-# class CreateModel(BaseModel, metaclass=CreateRelatedMeta):
-#     deleted = fields.BooleanField(default=False, description='是否已删除')
-#     create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
-#     creator = fields.ForeignKeyField(
-#         'main.SystemUserModel',
-#         null=True,
-#         db_constraint=False,
-#         description="创建人"
-#     )
-
-#     class Meta:
-#         abstract = True
-
-
-# class UpdateRelatedMeta(type(Model)):
-#     """元类：更新外键字段，解决用户related_name重复问题"""
-#     def __new__(cls, name: str, bases: tuple, attrs: dict):
-#         if name == 'UpdateModel':
-#             return super().__new__(cls, name, bases, attrs)
-
-#         creator_related_name = f"{name.lower()}_creator"
-#         attrs["creator"] = fields.ForeignKeyField(
-#             'main.SystemUserModel',
-#             null=True,
-#             related_name=creator_related_name,
-#             db_constraint=False,
-#             description="创建人"
-#         )
-
-#         updater_related_name = f"{name.lower()}_updater"
-#         attrs["updater"] = fields.ForeignKeyField(
-#             'main.SystemUserModel',
-#             null=True,
-#             related_name=updater_related_name,
-#             db_constraint=False,
-#             description="更新人"
-#         )
-
-#         new_class = super().__new__(cls, name, bases, attrs)
-#         return new_class
-
-# class UpdateModel(BaseModel, metaclass=UpdateRelatedMeta):
-#     deleted = fields.BooleanField(default=False, description='是否已删除')
-#     create_time = fields.DatetimeField(auto_now_add=True, description='创建时间')
-#     update_time = fields.DatetimeField(auto_now=True, description='更新时间')
-#     creator = fields.ForeignKeyField(
-#         'main.SystemUserModel',
-#         null=True,
-#         db_constraint=False,
-#         description="创建人"
-#     )
-
-#     updater = fields.ForeignKeyField(
-#         'main.SystemUserModel',
-#         null=True,
-#         db_constraint=False,
-#         description="更新人"
-#     )
-
-#     class Meta:
-#         abstract = True