refactor: reorder imports and improve code formatting in tool_workflow.py

Author: liuruibin

apps/tools/views/tool_workflow.py

@@ -1,20 +1,20 @@
 # coding=utf-8
 
-from django.utils.translation import gettext_lazy as _
-from drf_spectacular.utils import extend_schema
-from rest_framework.request import Request
-from rest_framework.views import APIView
-
 from application.api.application_api import SpeechToTextAPI
 from common.auth import TokenAuth
 from common.auth.authentication import has_permissions
-from common.constants.permission_constants import PermissionConstants, RoleConstants, ViewPermission, CompareConstants
+from common.constants.permission_constants import CompareConstants, PermissionConstants, RoleConstants, ViewPermission
 from common.log.log import log
-from common.result import result, DefaultResultSerializer
+from common.result import DefaultResultSerializer, result
+from django.utils.translation import gettext_lazy as _
+from drf_spectacular.utils import extend_schema
 from knowledge.api.knowledge_workflow import KnowledgeWorkflowApi
+from rest_framework.request import Request
+from rest_framework.views import APIView
+
 from tools.api.tool import GetInternalToolAPI
 from tools.api.tool_workflow import ToolWorkflowApi
-from tools.serializers.tool_workflow import ToolWorkflowSerializer, ToolWorkflowMcpSerializer, StoreToolWorkflow
+from tools.serializers.tool_workflow import StoreToolWorkflow, ToolWorkflowMcpSerializer, ToolWorkflowSerializer
 from tools.views import get_tool_operation_object
 
 
@@ -25,41 +25,53 @@ class Publish(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(
-            methods=['PUT'],
+            methods=["PUT"],
             description=_("Publishing an tool"),
             summary=_("Publishing an tool"),
             operation_id=_("Publishing an tool"),  # type: ignore
             parameters=ToolWorkflowApi.get_parameters(),
             request=None,
             responses=DefaultResultSerializer,
-            tags=[_('Tool')]  # type: ignore
+            tags=[_("Tool")],  # type: ignore
+        )
+        @has_permissions(
+            PermissionConstants.TOOL_PUBLISH.get_workspace_tool_permission(),
+            PermissionConstants.TOOL_PUBLISH.get_workspace_permission_workspace_manage_role(),
+            ViewPermission(
+                [RoleConstants.USER.get_workspace_role()],
+                [PermissionConstants.TOOL.get_workspace_tool_permission()],
+                CompareConstants.AND,
+            ),
+            RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
+        )
+        @log(
+            menu="Tool",
+            operate="Publishing an tool",
+            get_operation_object=lambda r, k: get_tool_operation_object(k.get("tool_id")),
         )
-        @has_permissions(PermissionConstants.TOOL_PUBLISH.get_workspace_tool_permission(),
-                         PermissionConstants.TOOL_PUBLISH.get_workspace_permission_workspace_manage_role(),
-                         ViewPermission([RoleConstants.USER.get_workspace_role()],
-                                        [PermissionConstants.TOOL.get_workspace_tool_permission()],
-                                        CompareConstants.AND),
-                         RoleConstants.WORKSPACE_MANAGE.get_workspace_role())
-        @log(menu='Tool', operate='Publishing an tool',
-             get_operation_object=lambda r, k: get_tool_operation_object(k.get('tool_id')))
         def put(self, request: Request, workspace_id: str, tool_id: str):
             return result.success(
                 ToolWorkflowSerializer.Operate(
-                    data={'tool_id': tool_id, 'user_id': request.user.id,
-                          'workspace_id': workspace_id, }).publish())
+                    data={
+                        "tool_id": tool_id,
+                        "user_id": request.user.id,
+                        "workspace_id": workspace_id,
+                    }
+                ).publish()
+            )
 
     class Operate(APIView):
         authentication_classes = [TokenAuth]
 
         @extend_schema(
-            methods=['PUT'],
-            description=_('Edit tool workflow'),
-            summary=_('Edit tool workflow'),
-            operation_id=_('Edit tool workflow'),  # type: ignore
+            methods=["PUT"],
+            description=_("Edit tool workflow"),
+            summary=_("Edit tool workflow"),
+            operation_id=_("Edit tool workflow"),  # type: ignore
             parameters=ToolWorkflowApi.get_parameters(),
             request=ToolWorkflowApi.get_request(),
             responses=ToolWorkflowApi.get_response(),
-            tags=[_('Tool')]  # type: ignore
+            tags=[_("Tool")],  # type: ignore
         )
         @has_permissions(
             PermissionConstants.TOOL_EDIT.get_workspace_tool_permission(),
@@ -68,26 +80,29 @@ class Operate(APIView):
             ViewPermission(
                 [RoleConstants.USER.get_workspace_role()],
                 [PermissionConstants.TOOL.get_workspace_tool_permission()],
-                CompareConstants.AND
-            )
+                CompareConstants.AND,
+            ),
         )
         @log(
-            menu='Tool', operate="Modify tool workflow",
-            get_operation_object=lambda r, k: get_tool_operation_object(k.get('tool_id')),
+            menu="Tool",
+            operate="Modify tool workflow",
+            get_operation_object=lambda r, k: get_tool_operation_object(k.get("tool_id")),
         )
         def put(self, request: Request, workspace_id: str, tool_id: str):
-            return result.success(ToolWorkflowSerializer.Operate(
-                data={'user_id': request.user.id, 'workspace_id': workspace_id, 'tool_id': tool_id}
-            ).edit(request.data))
+            return result.success(
+                ToolWorkflowSerializer.Operate(
+                    data={"user_id": request.user.id, "workspace_id": workspace_id, "tool_id": tool_id}
+                ).edit(request.data)
+            )
 
         @extend_schema(
-            methods=['GET'],
-            description=_('Get tool workflow'),
-            summary=_('Get tool workflow'),
-            operation_id=_('Get tool workflow'),  # type: ignore
+            methods=["GET"],
+            description=_("Get tool workflow"),
+            summary=_("Get tool workflow"),
+            operation_id=_("Get tool workflow"),  # type: ignore
             parameters=KnowledgeWorkflowApi.get_parameters(),
             responses=KnowledgeWorkflowApi.get_response(),
-            tags=[_('Tool')]  # type: ignore
+            tags=[_("Tool")],  # type: ignore
         )
         @has_permissions(
             PermissionConstants.TOOL_READ.get_workspace_tool_permission(),
@@ -96,26 +111,28 @@ def put(self, request: Request, workspace_id: str, tool_id: str):
             ViewPermission(
                 [RoleConstants.USER.get_workspace_role()],
                 [PermissionConstants.TOOL.get_workspace_tool_permission()],
-                CompareConstants.AND
+                CompareConstants.AND,
             ),
         )
         def get(self, request: Request, workspace_id: str, tool_id: str):
-            return result.success(ToolWorkflowSerializer.Operate(
-                data={'user_id': request.user.id, 'workspace_id': workspace_id, 'tool_id': tool_id}
-            ).one())
+            return result.success(
+                ToolWorkflowSerializer.Operate(
+                    data={"user_id": request.user.id, "workspace_id": workspace_id, "tool_id": tool_id}
+                ).one()
+            )
 
 
 class ToolWorkflowDebugView(APIView):
     authentication_classes = [TokenAuth]
 
     @extend_schema(
-        methods=['POST'],
-        description=_('tool workflow debug'),
-        summary=_('tool workflow debug'),
-        operation_id=_('tool workflow debug'),  # type: ignore
+        methods=["POST"],
+        description=_("tool workflow debug"),
+        summary=_("tool workflow debug"),
+        operation_id=_("tool workflow debug"),  # type: ignore
         parameters=ToolWorkflowApi.get_parameters(),
         responses=ToolWorkflowApi.get_response(),
-        tags=[_('Tool')]  # type: ignore
+        tags=[_("Tool")],  # type: ignore
     )
     @has_permissions(
         PermissionConstants.TOOL_EDIT.get_workspace_tool_permission(),
@@ -124,56 +141,68 @@ class ToolWorkflowDebugView(APIView):
         ViewPermission(
             [RoleConstants.USER.get_workspace_role()],
             [PermissionConstants.TOOL.get_workspace_tool_permission()],
-            CompareConstants.AND
+            CompareConstants.AND,
         ),
     )
     def post(self, request: Request, workspace_id: str, tool_id: str):
         return ToolWorkflowSerializer.Operate(
-            data={'workspace_id': workspace_id, 'tool_id': tool_id, 'user_id': request.user.id}).debug(
-            request.data,
-            request.user,
-            True)
+            data={"workspace_id": workspace_id, "tool_id": tool_id, "user_id": request.user.id}
+        ).debug(request.data, request.user, True)
 
 
 class McpServers(APIView):
     authentication_classes = [TokenAuth]
 
     @extend_schema(
-        methods=['GET'],
+        methods=["GET"],
         description=_("Get the list of MCP tools"),
         summary=_("Get the list of MCP tools"),
         operation_id=_("Get the list of MCP tools"),  # type: ignore
         parameters=SpeechToTextAPI.get_parameters(),
         request=SpeechToTextAPI.get_request(),
         responses=SpeechToTextAPI.get_response(),
-        tags=[_('Tool')]  # type: ignore
+        tags=[_("Tool")],  # type: ignore
+    )
+    @has_permissions(
+        PermissionConstants.TOOL_READ.get_workspace_tool_permission(),
+        PermissionConstants.TOOL_READ.get_workspace_permission_workspace_manage_role(),
+        ViewPermission(
+            [RoleConstants.USER.get_workspace_role()],
+            [PermissionConstants.TOOL.get_workspace_tool_permission()],
+            CompareConstants.AND,
+        ),
+        RoleConstants.WORKSPACE_MANAGE.get_workspace_role(),
     )
-    @has_permissions(PermissionConstants.TOOL_READ.get_workspace_tool_permission(),
-                     PermissionConstants.TOOL_READ.get_workspace_permission_workspace_manage_role(),
-                     ViewPermission([RoleConstants.USER.get_workspace_role()],
-                                    [PermissionConstants.TOOL.get_workspace_tool_permission()],
-                                    CompareConstants.AND),
-                     RoleConstants.WORKSPACE_MANAGE.get_workspace_role())
     def post(self, request: Request, workspace_id, tool_id: str):
-        return result.success(ToolWorkflowMcpSerializer(
-            data={'mcp_servers': request.query_params.get('mcp_servers'), 'workspace_id': workspace_id,
-                  'user_id': request.user.id,
-                  'tool_id': tool_id}).get_mcp_servers(request.data))
+        return result.success(
+            ToolWorkflowMcpSerializer(
+                data={
+                    "mcp_servers": request.query_params.get("mcp_servers"),
+                    "workspace_id": workspace_id,
+                    "user_id": request.user.id,
+                    "tool_id": tool_id,
+                }
+            ).get_mcp_servers(request.data)
+        )
 
 
 class StoreToolWorkflowView(APIView):
     authentication_classes = [TokenAuth]
 
     @extend_schema(
-        methods=['GET'],
+        methods=["GET"],
         description=_("Get Appstore tools"),
         summary=_("Get Appstore tools"),
         operation_id=_("Get Appstore tools"),  # type: ignore
         responses=GetInternalToolAPI.get_response(),
-        tags=[_("Tool")]  # type: ignore
+        tags=[_("Tool")],  # type: ignore
     )
     def get(self, request: Request):
-        return result.success(StoreToolWorkflow(data={
-            'user_id': request.user.id,
-            'name': request.query_params.get('name', ''),
-        }).get_appstore_templates())
+        return result.success(
+            StoreToolWorkflow(
+                data={
+                    "user_id": request.user.id,
+                    "name": request.query_params.get("name", ""),
+                }
+            ).get_appstore_templates()
+        )