Merge branch 'master' into add-aliyun-oss-plugin

Author: wu-clan

.pre-commit-config.yaml

@@ -1,14 +1,14 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: end-of-file-fixer
       - id: check-yaml
       - id: check-toml
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.7.2
+    rev: v0.9.5
     hooks:
       - id: ruff
         args:
@@ -20,7 +20,7 @@ repos:
       - id: ruff-format
 
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.4.29
+    rev: 0.5.29
     hooks:
       - id: uv-lock
         args:

README.md

@@ -47,18 +47,6 @@ pattern, use templates to transform it to your heart's content!
 | data access    | dao / mapper   | crud                      |
 | model          | model / entity | model                     |
 
-## Online Demo
-
-You can view some of the preview screenshots
-in [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui)
-
-For the demo entrance, please refer
-to [Official documentation](https://fastapi-practices.github.io/fastapi_best_architecture_docs/)
-
-> tester: test / 123456
->
-> super: admin / 123456
-
 ## Features
 
 - [x] Design with FastAPI PEP 593 Annotated Parameters
@@ -81,6 +69,7 @@ to [Official documentation](https://fastapi-practices.github.io/fastapi_best_arc
 - [x] Menu management: Configuration of system menus, user menus, button permission labels
 - [x] Role management: assignment of role menu privileges, assignment of role routing privileges
 - [x] Dictionary management: maintenance of commonly used fixed data or parameters within the system
+- [x] Token management：System user online status detection, supports kicking user offline
 - [x] Code generation: back-end code is automatically generated, supporting preview, write and download.
 - [x] Operation log: logging and querying of normal and abnormal system operations.
 - [x] Login authentication: graphical captcha backend authentication login

README.zh-CN.md

@@ -43,16 +43,6 @@ mvc 架构作为常规设计模式，在 python web 中也很常见，但是三
 | 数据访问 | dao / mapper   | crud                      |
 | 模型   | model / entity | model                     |
 
-## 在线预览
-
-你可以在 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 中查看部分预览截图
-
-演示入口请查看 [官方文档](https://fastapi-practices.github.io/fastapi_best_architecture_docs/)
-
-> 测试员：tester / 123456
->
-> 管理员：admin / 123456
-
 ## 特征
 
 - [x] 使用 FastAPI PEP 593 Annotated 参数设计
@@ -75,6 +65,7 @@ mvc 架构作为常规设计模式，在 python web 中也很常见，但是三
 - [x] 菜单管理：配置系统菜单，用户菜单，按钮权限标识
 - [x] 角色管理：角色菜单权限分配，角色路由权限分配
 - [x] 字典管理：维护系统内部常用固定数据或参数
+- [x] 令牌管理：系统用户在线状态检测，支持踢人下线
 - [x] 代码生成：后端代码自动生成，支持预览，写入及下载
 - [x] 操作日志：系统正常和异常操作的日志记录与查询
 - [x] 登录认证：图形验证码后台认证登录

backend/.ruff.toml

@@ -9,7 +9,7 @@ select = [
     "E",
     "F",
     "I",
-    "TCH",
+    "TC",
     # W
     "W505",
     # PT
@@ -43,8 +43,8 @@ lines-between-types = 1
 order-by-type = true
 
 [lint.per-file-ignores]
-"**/api/v1/*.py" = ["TCH"]
-"**/model/*.py" = ["TCH003"]
+"**/api/v1/*.py" = ["TC"]
+"**/model/*.py" = ["TC003"]
 "**/model/__init__.py" = ["F401"]
 "**/tests/*.py" = ["E402"]
 

backend/alembic/env.py

@@ -16,11 +16,20 @@
 from backend.common.model import MappedBase
 from backend.core import path_conf
 from backend.database.db import SQLALCHEMY_DATABASE_URL
+from backend.plugin.tools import get_plugin_models
 
 # import your new model here
 from backend.app.admin.model import *  # noqa: F401
 from backend.app.generator.model import *  # noqa: F401
 
+# import plugin model
+for cls in get_plugin_models():
+    class_name = cls.__name__
+    if class_name in globals():
+        print(f'\nWarning: Class "{class_name}" already exists in global namespace.')
+    else:
+        globals()[class_name] = cls
+
 if not os.path.exists(path_conf.ALEMBIC_VERSION_DIR):
     os.makedirs(path_conf.ALEMBIC_VERSION_DIR)
 

backend/app/admin/api/v1/auth/auth.py

@@ -7,10 +7,10 @@
 from fastapi_limiter.depends import RateLimiter
 from starlette.background import BackgroundTasks
 
-from backend.app.admin.schema.token import GetSwaggerToken
+from backend.app.admin.schema.token import GetLoginToken, GetNewToken, GetSwaggerToken
 from backend.app.admin.schema.user import AuthLoginParam
 from backend.app.admin.service.auth_service import auth_service
-from backend.common.response.response_schema import ResponseModel, response_base
+from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
 from backend.common.security.jwt import DependsJwtAuth
 
 router = APIRouter()
@@ -30,13 +30,13 @@ async def swagger_login(obj: Annotated[HTTPBasicCredentials, Depends()]) -> GetS
 )
 async def user_login(
     request: Request, response: Response, obj: AuthLoginParam, background_tasks: BackgroundTasks
-) -> ResponseModel:
+) -> ResponseSchemaModel[GetLoginToken]:
     data = await auth_service.login(request=request, response=response, obj=obj, background_tasks=background_tasks)
     return response_base.success(data=data)
 
 
 @router.post('/token/new', summary='创建新 token', dependencies=[DependsJwtAuth])
-async def create_new_token(request: Request, response: Response) -> ResponseModel:
+async def create_new_token(request: Request, response: Response) -> ResponseSchemaModel[GetNewToken]:
     data = await auth_service.new_token(request=request, response=response)
     return response_base.success(data=data)
 

backend/app/admin/api/v1/auth/captcha.py

@@ -6,7 +6,8 @@
 from starlette.concurrency import run_in_threadpool
 
 from backend.app.admin.conf import admin_settings
-from backend.common.response.response_schema import ResponseModel, response_base
+from backend.app.admin.schema.captcha import GetCaptchaDetail
+from backend.common.response.response_schema import ResponseSchemaModel, response_base
 from backend.database.redis import redis_client
 
 router = APIRouter()
@@ -17,14 +18,17 @@
     summary='获取登录验证码',
     dependencies=[Depends(RateLimiter(times=5, seconds=10))],
 )
-async def get_captcha(request: Request) -> ResponseModel:
+async def get_captcha(request: Request) -> ResponseSchemaModel[GetCaptchaDetail]:
     """
     此接口可能存在性能损耗，尽管是异步接口，但是验证码生成是IO密集型任务，使用线程池尽量减少性能损耗
     """
     img_type: str = 'base64'
     img, code = await run_in_threadpool(img_captcha, img_byte=img_type)
     ip = request.state.ip
     await redis_client.set(
-        f'{admin_settings.CAPTCHA_LOGIN_REDIS_PREFIX}:{ip}', code, ex=admin_settings.CAPTCHA_LOGIN_EXPIRE_SECONDS
+        f'{admin_settings.CAPTCHA_LOGIN_REDIS_PREFIX}:{ip}',
+        code,
+        ex=admin_settings.CAPTCHA_LOGIN_EXPIRE_SECONDS,
     )
-    return response_base.success(data={'image_type': img_type, 'image': img})
+    data = GetCaptchaDetail(image_type=img_type, image=img)
+    return response_base.success(data=data)

backend/app/admin/api/v1/log/login_log.py

@@ -4,10 +4,10 @@
 
 from fastapi import APIRouter, Depends, Query
 
-from backend.app.admin.schema.login_log import GetLoginLogListDetails
+from backend.app.admin.schema.login_log import GetLoginLogDetail
 from backend.app.admin.service.login_log_service import login_log_service
-from backend.common.pagination import DependsPagination, paging_data
-from backend.common.response.response_schema import ResponseModel, response_base
+from backend.common.pagination import DependsPagination, PageData, paging_data
+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
@@ -29,9 +29,9 @@ async def get_pagination_login_logs(
     username: Annotated[str | None, Query()] = None,
     status: Annotated[int | None, Query()] = None,
     ip: Annotated[str | None, Query()] = None,
-) -> ResponseModel:
+) -> ResponseSchemaModel[PageData[GetLoginLogDetail]]:
     log_select = await login_log_service.get_select(username=username, status=status, ip=ip)
-    page_data = await paging_data(db, log_select, GetLoginLogListDetails)
+    page_data = await paging_data(db, log_select)
     return response_base.success(data=page_data)
 
 

backend/app/admin/api/v1/log/opera_log.py

@@ -4,10 +4,10 @@
 
 from fastapi import APIRouter, Depends, Query
 
-from backend.app.admin.schema.opera_log import GetOperaLogListDetails
+from backend.app.admin.schema.opera_log import GetOperaLogDetail
 from backend.app.admin.service.opera_log_service import opera_log_service
-from backend.common.pagination import DependsPagination, paging_data
-from backend.common.response.response_schema import ResponseModel, response_base
+from backend.common.pagination import DependsPagination, PageData, paging_data
+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
@@ -29,9 +29,9 @@ async def get_pagination_opera_logs(
     username: Annotated[str | None, Query()] = None,
     status: Annotated[int | None, Query()] = None,
     ip: Annotated[str | None, Query()] = None,
-) -> ResponseModel:
+) -> ResponseSchemaModel[PageData[GetOperaLogDetail]]:
     log_select = await opera_log_service.get_select(username=username, status=status, ip=ip)
-    page_data = await paging_data(db, log_select, GetOperaLogListDetails)
+    page_data = await paging_data(db, log_select)
     return response_base.success(data=page_data)
 
 

backend/app/admin/api/v1/oauth2/github.py

@@ -8,7 +8,7 @@
 from backend.app.admin.conf import admin_settings
 from backend.app.admin.service.oauth2_service import oauth2_service
 from backend.common.enums import UserSocialType
-from backend.common.response.response_schema import ResponseModel, response_base
+from backend.common.response.response_schema import ResponseSchemaModel, response_base
 
 router = APIRouter()
 
@@ -17,7 +17,7 @@
 
 
 @router.get('', summary='获取 Github 授权链接')
-async def github_auth2() -> ResponseModel:
+async def github_auth2() -> ResponseSchemaModel[str]:
     auth_url = await _github_client.get_authorization_url(redirect_uri=admin_settings.OAUTH2_GITHUB_REDIRECT_URI)
     return response_base.success(data=auth_url)