Optimize generator

Author: wu-clan

backend/app/generator/crud/crud_gen.py

@@ -9,8 +9,17 @@
 
 
 class CRUDGen:
+    """代码生成 CRUD 类"""
+
     @staticmethod
-    async def get_all_tables(db: AsyncSession, table_schema: str) -> Sequence[str]:
+    async def get_all_tables(db: AsyncSession, table_schema: str) -> list[str]:
+        """
+        获取所有表名
+
+        :param db: 数据库会话
+        :param table_schema: 数据库 schema 名称
+        :return:
+        """
         if settings.DATABASE_TYPE == 'mysql':
             sql = """
             SELECT table_name AS table_name FROM information_schema.tables 
@@ -30,6 +39,13 @@ async def get_all_tables(db: AsyncSession, table_schema: str) -> Sequence[str]:
 
     @staticmethod
     async def get_table(db: AsyncSession, table_name: str) -> Row[tuple]:
+        """
+        获取表信息
+
+        :param db: 数据库会话
+        :param table_name: 表名
+        :return:
+        """
         if settings.DATABASE_TYPE == 'mysql':
             sql = """
             SELECT table_name AS table_name, table_comment AS table_comment FROM information_schema.tables 
@@ -51,6 +67,14 @@ async def get_table(db: AsyncSession, table_name: str) -> Row[tuple]:
 
     @staticmethod
     async def get_all_columns(db: AsyncSession, table_schema: str, table_name: str) -> Sequence[Row[tuple]]:
+        """
+        获取所有列信息
+
+        :param db: 数据库会话
+        :param table_schema: 数据库 schema 名称
+        :param table_name: 表名
+        :return:
+        """
         if settings.DATABASE_TYPE == 'mysql':
             sql = """
             SELECT column_name AS column_name, 

backend/app/generator/crud/crud_gen_business.py

@@ -10,12 +10,14 @@
 
 
 class CRUDGenBusiness(CRUDPlus[GenBusiness]):
+    """代码生成业务 CRUD 类"""
+
     async def get(self, db: AsyncSession, pk: int) -> GenBusiness | None:
         """
         获取代码生成业务表
 
-        :param db:
-        :param pk:
+        :param db: 数据库会话
+        :param pk: 主键 ID
         :return:
         """
         return await self.select_model(db, pk)
@@ -24,8 +26,8 @@ async def get_by_name(self, db: AsyncSession, name: str) -> GenBusiness | None:
         """
         通过 name 获取代码生成业务表
 
-        :param db:
-        :param name:
+        :param db: 数据库会话
+        :param name: 表名
         :return:
         """
         return await self.select_model_by_column(db, table_name_en=name)
@@ -34,6 +36,7 @@ async def get_all(self, db: AsyncSession) -> Sequence[GenBusiness]:
         """
         获取所有代码生成业务表
 
+        :param db: 数据库会话
         :return:
         """
         return await self.select_models(db)
@@ -42,8 +45,8 @@ async def create(self, db: AsyncSession, obj_in: CreateGenBusinessParam) -> None
         """
         创建代码生成业务表
 
-        :param db:
-        :param obj_in:
+        :param db: 数据库会话
+        :param obj_in: 创建参数
         :return:
         """
         await self.create_model(db, obj_in)
@@ -52,9 +55,8 @@ async def update(self, db: AsyncSession, pk: int, obj_in: UpdateGenBusinessParam
         """
         更新代码生成业务表
 
-        :param db:
-        :param pk:
-        :param obj_in:
+        :param db: 数据库会话
+        :param obj_in: 更新参数
         :return:
         """
         return await self.update_model(db, pk, obj_in)
@@ -63,8 +65,8 @@ async def delete(self, db: AsyncSession, pk: int) -> int:
         """
         删除代码生成业务表
 
-        :param db:
-        :param pk:
+        :param db: 数据库会话
+        :param pk: 主键 ID
         :return:
         """
         return await self.delete_model(db, pk)

backend/app/generator/crud/crud_gen_model.py

@@ -10,10 +10,14 @@
 
 
 class CRUDGenModel(CRUDPlus[GenModel]):
+    """代码生成模型 CRUD 类"""
+
     async def get(self, db: AsyncSession, pk: int) -> GenModel | None:
         """
         获取代码生成模型列
 
+        :param db: 数据库会话
+        :param pk: 主键 ID
         :return:
         """
         return await self.select_model(db, pk)
@@ -22,8 +26,8 @@ async def get_all_by_business_id(self, db: AsyncSession, business_id: int) -> Se
         """
         获取所有代码生成模型列
 
-        :param db:
-        :param business_id:
+        :param db: 数据库会话
+        :param business_id: 业务 ID
         :return:
         """
         return await self.select_models_order(db, sort_columns='sort', gen_business_id=business_id)
@@ -32,21 +36,21 @@ async def create(self, db: AsyncSession, obj_in: CreateGenModelParam, pd_type: s
         """
         创建代码生成模型表
 
-        :param db:
-        :param obj_in:
-        :param pd_type:
+        :param db: 数据库会话
+        :param obj_in: 创建参数
+        :param pd_type: Pydantic 类型
         :return:
         """
         await self.create_model(db, obj_in, pd_type=pd_type)
 
     async def update(self, db: AsyncSession, pk: int, obj_in: UpdateGenModelParam, pd_type: str | None = None) -> int:
         """
-        更细代码生成模型表
+        更新代码生成模型表
 
-        :param db:
-        :param pk:
-        :param obj_in:
-        :param pd_type:
+        :param db: 数据库会话
+        :param pk: 主键 ID
+        :param obj_in: 更新参数
+        :param pd_type: Pydantic 类型
         :return:
         """
         return await self.update_model(db, pk, obj_in, pd_type=pd_type)
@@ -55,8 +59,8 @@ async def delete(self, db: AsyncSession, pk: int) -> int:
         """
         删除代码生成模型表
 
-        :param db:
-        :param pk:
+        :param db: 数据库会话
+        :param pk: 主键 ID
         :return:
         """
         return await self.delete_model(db, pk)

backend/app/generator/model/gen_business.py

@@ -1,12 +1,17 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from typing import TYPE_CHECKING
+
 from sqlalchemy import String
 from sqlalchemy.dialects.mysql import LONGTEXT
 from sqlalchemy.dialects.postgresql import TEXT
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
 from backend.common.model import Base, id_key
 
+if TYPE_CHECKING:
+    from backend.app.generator.model.gen_model import GenModel
+
 
 class GenBusiness(Base):
     """代码生成业务表"""
@@ -28,4 +33,4 @@ class GenBusiness(Base):
         LONGTEXT().with_variant(TEXT, 'postgresql'), default=None, comment='备注'
     )
     # 代码生成业务模型一对多
-    gen_model: Mapped[list['GenModel']] = relationship(init=False, back_populates='gen_business')  # noqa: F821
+    gen_model: Mapped[list['GenModel']] = relationship(init=False, back_populates='gen_business')

backend/app/generator/model/gen_model.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from typing import Union
+from typing import TYPE_CHECKING, Union
 
 from sqlalchemy import ForeignKey, String
 from sqlalchemy.dialects.mysql import LONGTEXT
@@ -9,6 +9,9 @@
 
 from backend.common.model import DataClassBase, id_key
 
+if TYPE_CHECKING:
+    from backend.app.generator.model.gen_business import GenBusiness
+
 
 class GenModel(DataClassBase):
     """代码生成模型表"""
@@ -32,4 +35,4 @@ class GenModel(DataClassBase):
     gen_business_id: Mapped[int] = mapped_column(
         ForeignKey('sys_gen_business.id', ondelete='CASCADE'), default=0, comment='代码生成业务ID'
     )
-    gen_business: Mapped[Union['GenBusiness', None]] = relationship(init=False, back_populates='gen_model')  # noqa: F821
+    gen_business: Mapped[Union['GenBusiness', None]] = relationship(init=False, back_populates='gen_model')

backend/app/generator/schema/gen.py

@@ -6,6 +6,8 @@
 
 
 class ImportParam(SchemaBase):
+    """导入参数"""
+
     app: str = Field(description='应用名称，用于代码生成到指定 app')
     table_name: str = Field(description='数据库表名')
     table_schema: str = Field(description='数据库名')

backend/app/generator/schema/gen_business.py

@@ -9,35 +9,40 @@
 
 
 class GenBusinessSchemaBase(SchemaBase):
-    app_name: str
-    table_name_en: str
-    table_name_zh: str
-    table_simple_name_zh: str
-    table_comment: str | None = None
-    schema_name: str | None = None
-    default_datetime_column: bool = Field(default=True)
-    api_version: str = Field(default='v1')
-    gen_path: str | None = None
-    remark: str | None = None
+    """代码生成业务基类"""
+
+    app_name: str = Field(description='应用名称（英文）')
+    table_name_en: str = Field(description='表名称（英文）')
+    table_name_zh: str = Field(description='表名称（中文）')
+    table_simple_name_zh: str = Field(description='表名称（中文简称）')
+    table_comment: str | None = Field(default=None, description='表描述')
+    schema_name: str | None = Field(default=None, description='Schema 名称 (默认为英文表名称)')
+    default_datetime_column: bool = Field(default=True, description='是否存在默认时间列')
+    api_version: str = Field(default='v1', description='代码生成 api 版本，默认为 v1')
+    gen_path: str | None = Field(default=None, description='代码生成路径（默认为 app 根路径）')
+    remark: str | None = Field(default=None, description='备注')
 
     @model_validator(mode='after')
     def check_schema_name(self) -> Self:
+        """检查并设置 schema 名称"""
         if self.schema_name is None:
             self.schema_name = self.table_name_en
         return self
 
 
 class CreateGenBusinessParam(GenBusinessSchemaBase):
-    pass
+    """创建代码生成业务"""
 
 
 class UpdateGenBusinessParam(GenBusinessSchemaBase):
-    pass
+    """更新代码生成业务"""
 
 
 class GetGenBusinessDetail(GenBusinessSchemaBase):
+    """获取代码生成业务详情"""
+
     model_config = ConfigDict(from_attributes=True)
 
-    id: int
-    created_time: datetime
-    updated_time: datetime | None = None
+    id: int = Field(description='主键 ID')
+    created_time: datetime = Field(description='创建时间')
+    updated_time: datetime | None = Field(default=None, description='更新时间')

backend/app/generator/schema/gen_model.py

@@ -7,32 +7,37 @@
 
 
 class GenModelSchemaBase(SchemaBase):
-    name: str
-    comment: str | None = None
-    type: str
-    default: str | None = None
-    sort: int
-    length: int
-    is_pk: bool = Field(default=False)
-    is_nullable: bool = Field(default=False)
-    gen_business_id: int | None = Field(ge=1)
+    """代码生成模型基类"""
+
+    name: str = Field(description='列名称')
+    comment: str | None = Field(default=None, description='列描述')
+    type: str = Field(description='SQLA 模型列类型')
+    default: str | None = Field(default=None, description='列默认值')
+    sort: int = Field(description='列排序')
+    length: int = Field(description='列长度')
+    is_pk: bool = Field(default=False, description='是否主键')
+    is_nullable: bool = Field(default=False, description='是否可为空')
+    gen_business_id: int | None = Field(ge=1, description='代码生成业务ID')
 
     @field_validator('type')
     @classmethod
-    def type_update(cls, v):
+    def type_update(cls, v: str) -> str:
+        """更新列类型"""
         return sql_type_to_sqlalchemy(v)
 
 
 class CreateGenModelParam(GenModelSchemaBase):
-    pass
+    """创建代码生成模型"""
 
 
 class UpdateGenModelParam(GenModelSchemaBase):
-    pass
+    """更新代码生成模型"""
 
 
 class GetGenModelDetail(GenModelSchemaBase):
+    """获取代码生成模型详情"""
+
     model_config = ConfigDict(from_attributes=True)
 
-    id: int
-    pd_type: str
+    id: int = Field(description='主键 ID')
+    pd_type: str = Field(description='列类型对应的 pydantic 类型')