Update the code generator to plugin (#578)

* Update the code generator to plugin

* Fix get all tables return type

Author: wu-clan

backend/alembic/env.py

@@ -20,7 +20,7 @@
 
 # import your new model here
 from backend.app.admin.model import *  # noqa: F401
-from backend.app.generator.model import *  # noqa: F401
+from backend.plugin.code_generator.model import *  # noqa: F401
 
 # import plugin model
 for cls in get_plugin_models():

backend/app/generator/model/__init__.py

@@ -3,11 +3,9 @@
 from fastapi import APIRouter
 
 from backend.app.admin.api.router import v1 as admin_v1
-from backend.app.generator.api.router import v1 as generator_v1
 from backend.app.task.api.router import v1 as task_v1
 
 router = APIRouter()
 
 router.include_router(admin_v1)
-router.include_router(generator_v1)
 router.include_router(task_v1)

backend/app/router.py

@@ -119,153 +119,3 @@ class FileType(StrEnum):
 
     image = 'image'
     video = 'video'
-
-
-class GenModelMySQLColumnType(StrEnum):
-    """代码生成模型列类型（MySQL）"""
-
-    # Python 类型映射
-    BIGINT = 'int'
-    BigInteger = 'int'  # BIGINT
-    BINARY = 'bytes'
-    BLOB = 'bytes'
-    BOOLEAN = 'bool'  # BOOL
-    Boolean = 'bool'  # BOOL
-    CHAR = 'str'
-    CLOB = 'str'
-    DATE = 'date'
-    Date = 'date'  # DATE
-    DATETIME = 'datetime'
-    DateTime = 'datetime'  # DATETIME
-    DECIMAL = 'Decimal'
-    DOUBLE = 'float'
-    Double = 'float'  # DOUBLE
-    DOUBLE_PRECISION = 'float'
-    Enum = 'Enum'  # Enum()
-    FLOAT = 'float'
-    Float = 'float'  # FLOAT
-    INT = 'int'  # INTEGER
-    INTEGER = 'int'
-    Integer = 'int'  # INTEGER
-    Interval = 'timedelta'  # DATETIME
-    JSON = 'dict'
-    LargeBinary = 'bytes'  # BLOB
-    NCHAR = 'str'
-    NUMERIC = 'Decimal'
-    Numeric = 'Decimal'  # NUMERIC
-    NVARCHAR = 'str'  # String
-    PickleType = 'bytes'  # BLOB
-    REAL = 'float'
-    SMALLINT = 'int'
-    SmallInteger = 'int'  # SMALLINT
-    String = 'str'  # String
-    TEXT = 'str'
-    Text = 'str'  # TEXT
-    TIME = 'time'
-    Time = 'time'  # TIME
-    TIMESTAMP = 'datetime'
-    Unicode = 'str'  # String
-    UnicodeText = 'str'  # TEXT
-    UUID = 'str | UUID'
-    Uuid = 'str'  # CHAR(32)
-    VARBINARY = 'bytes'
-    VARCHAR = 'str'  # String
-
-    # sa.dialects.mysql 导入
-    BIT = 'bool'
-    ENUM = 'Enum'
-    LONGBLOB = 'bytes'
-    LONGTEXT = 'str'
-    MEDIUMBLOB = 'bytes'
-    MEDIUMINT = 'int'
-    MEDIUMTEXT = 'str'
-    SET = 'list[str]'
-    TINYBLOB = 'bytes'
-    TINYINT = 'int'
-    TINYTEXT = 'str'
-    YEAR = 'int'
-
-
-class GenModelPostgreSQLColumnType(StrEnum):
-    """代码生成模型列类型（PostgreSQL）"""
-
-    # Python 类型映射
-    BIGINT = 'int'
-    BigInteger = 'int'  # BIGINT
-    BINARY = 'bytes'
-    BLOB = 'bytes'
-    BOOLEAN = 'bool'
-    Boolean = 'bool'  # BOOLEAN
-    CHAR = 'str'
-    CLOB = 'str'
-    DATE = 'date'
-    Date = 'date'  # DATE
-    DATETIME = 'datetime'
-    DateTime = 'datetime'  # TIMESTAMP WITHOUT TIME ZONE
-    DECIMAL = 'Decimal'
-    DOUBLE = 'float'
-    Double = 'float'  # DOUBLE PRECISION
-    DOUBLE_PRECISION = 'float'  # DOUBLE PRECISION
-    Enum = 'Enum'  # Enum(name='enum')
-    FLOAT = 'float'
-    Float = 'float'  # FLOAT
-    INT = 'int'  # INTEGER
-    INTEGER = 'int'
-    Integer = 'int'  # INTEGER
-    Interval = 'timedelta'  # INTERVAL
-    JSON = 'dict'
-    LargeBinary = 'bytes'  # BYTEA
-    NCHAR = 'str'
-    NUMERIC = 'Decimal'
-    Numeric = 'Decimal'  # NUMERIC
-    NVARCHAR = 'str'  # String
-    PickleType = 'bytes'  # BYTEA
-    REAL = 'float'
-    SMALLINT = 'int'
-    SmallInteger = 'int'  # SMALLINT
-    String = 'str'  # String
-    TEXT = 'str'
-    Text = 'str'  # TEXT
-    TIME = 'time'  # TIME WITHOUT TIME ZONE
-    Time = 'time'  # TIME WITHOUT TIME ZONE
-    TIMESTAMP = 'datetime'  # TIMESTAMP WITHOUT TIME ZONE
-    Unicode = 'str'  # String
-    UnicodeText = 'str'  # TEXT
-    UUID = 'str | UUID'
-    Uuid = 'str'
-    VARBINARY = 'bytes'
-    VARCHAR = 'str'  # String
-
-    # sa.dialects.postgresql 导入
-    ARRAY = 'list'
-    BIT = 'bool'
-    BYTEA = 'bytes'
-    CIDR = 'str'
-    CITEXT = 'str'
-    DATEMULTIRANGE = 'list[date]'
-    DATERANGE = 'tuple[date, date]'
-    DOMAIN = 'str'
-    ENUM = 'Enum'
-    HSTORE = 'dict'
-    INET = 'str'
-    INT4MULTIRANGE = 'list[int]'
-    INT4RANGE = 'tuple[int, int]'
-    INT8MULTIRANGE = 'list[int]'
-    INT8RANGE = 'tuple[int, int]'
-    INTERVAL = 'timedelta'
-    JSONB = 'dict'
-    JSONPATH = 'str'
-    MACADDR = 'str'
-    MACADDR8 = 'str'
-    MONEY = 'Decimal'
-    NUMMULTIRANGE = 'list[Decimal]'
-    NUMRANGE = 'tuple[Decimal, Decimal]'
-    OID = 'int'
-    REGCLASS = 'str'
-    REGCONFIG = 'str'
-    TSMULTIRANGE = 'list[datetime]'
-    TSQUERY = 'str'
-    TSRANGE = 'tuple[datetime, datetime]'
-    TSTZMULTIRANGE = 'list[datetime]'
-    TSTZRANGE = 'tuple[datetime, datetime]'
-    TSVECTOR = 'str'

backend/common/enums.py

@@ -17,9 +17,6 @@
 # 上传文件目录
 UPLOAD_DIR = STATIC_DIR / 'upload'
 
-# jinja2 模版文件路径
-JINJA2_TEMPLATE_DIR = BASE_PATH / 'templates' / 'generator'
-
 # 插件目录
 PLUGIN_DIR = BASE_PATH / 'plugin'
 

backend/core/path_conf.py

@@ -2,10 +2,10 @@
 # -*- coding: utf-8 -*-
 from fastapi import APIRouter
 
-from backend.app.generator.api.v1.gen import router as gen_router
-from backend.app.generator.api.v1.gen_business import router as gen_business_router
-from backend.app.generator.api.v1.gen_model import router as gen_model_router
 from backend.core.conf import settings
+from backend.plugin.code_generator.api.v1.gen import router as gen_router
+from backend.plugin.code_generator.api.v1.gen_business import router as gen_business_router
+from backend.plugin.code_generator.api.v1.gen_model import router as gen_model_router
 
 v1 = APIRouter(prefix=f'{settings.FASTAPI_API_V1_PATH}/gen', tags=['代码生成'])
 

backend/app/generator/README.md renamed to backend/plugin/code_generator/README.md

@@ -5,13 +5,13 @@
 from fastapi import APIRouter, Depends, Path, Query
 from fastapi.responses import StreamingResponse
 
-from backend.app.generator.conf import generator_settings
-from backend.app.generator.schema.gen import ImportParam
-from backend.app.generator.service.gen_service import gen_service
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
+from backend.plugin.code_generator.conf import generator_settings
+from backend.plugin.code_generator.schema.gen import ImportParam
+from backend.plugin.code_generator.service.gen_service import gen_service
 
 router = APIRouter()
 

backend/app/generator/__init__.py renamed to backend/plugin/code_generator/__init__.py

@@ -4,18 +4,18 @@
 
 from fastapi import APIRouter, Depends, Path
 
-from backend.app.generator.schema.gen_business import (
-    CreateGenBusinessParam,
-    GetGenBusinessDetail,
-    UpdateGenBusinessParam,
-)
-from backend.app.generator.schema.gen_model import GetGenModelDetail
-from backend.app.generator.service.gen_business_service import gen_business_service
-from backend.app.generator.service.gen_model_service import gen_model_service
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
+from backend.plugin.code_generator.schema.gen_business import (
+    CreateGenBusinessParam,
+    GetGenBusinessDetail,
+    UpdateGenBusinessParam,
+)
+from backend.plugin.code_generator.schema.gen_model import GetGenModelDetail
+from backend.plugin.code_generator.service.gen_business_service import gen_business_service
+from backend.plugin.code_generator.service.gen_model_service import gen_model_service
 
 router = APIRouter()
 

backend/app/generator/api/__init__.py renamed to backend/plugin/code_generator/api/__init__.py

@@ -4,12 +4,12 @@
 
 from fastapi import APIRouter, Depends, Path
 
-from backend.app.generator.schema.gen_model import CreateGenModelParam, GetGenModelDetail, UpdateGenModelParam
-from backend.app.generator.service.gen_model_service import gen_model_service
 from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 from backend.common.security.permission import RequestPermission
 from backend.common.security.rbac import DependsRBAC
+from backend.plugin.code_generator.schema.gen_model import CreateGenModelParam, GetGenModelDetail, UpdateGenModelParam
+from backend.plugin.code_generator.service.gen_model_service import gen_model_service
 
 router = APIRouter()
 

backend/app/generator/api/router.py renamed to backend/plugin/code_generator/api/router.py

@@ -12,7 +12,7 @@ class CRUDGen:
     """代码生成 CRUD 类"""
 
     @staticmethod
-    async def get_all_tables(db: AsyncSession, table_schema: str) -> list[str]:
+    async def get_all_tables(db: AsyncSession, table_schema: str) -> Sequence[str]:
         """
         获取所有表名
 

backend/app/generator/api/v1/__init__.py renamed to backend/plugin/code_generator/api/v1/__init__.py

@@ -5,8 +5,8 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy_crud_plus import CRUDPlus
 
-from backend.app.generator.model import GenBusiness
-from backend.app.generator.schema.gen_business import CreateGenBusinessParam, UpdateGenBusinessParam
+from backend.plugin.code_generator.model import GenBusiness
+from backend.plugin.code_generator.schema.gen_business import CreateGenBusinessParam, UpdateGenBusinessParam
 
 
 class CRUDGenBusiness(CRUDPlus[GenBusiness]):

backend/app/generator/api/v1/gen.py renamed to backend/plugin/code_generator/api/v1/gen.py

@@ -5,8 +5,8 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy_crud_plus import CRUDPlus
 
-from backend.app.generator.model import GenModel
-from backend.app.generator.schema.gen_model import CreateGenModelParam, UpdateGenModelParam
+from backend.plugin.code_generator.model import GenModel
+from backend.plugin.code_generator.schema.gen_model import CreateGenModelParam, UpdateGenModelParam
 
 
 class CRUDGenModel(CRUDPlus[GenModel]):