refactor: format python backend code (#1132)

Co-authored-by: bytecii <bytecii@users.noreply.github.com>
Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>

Author: bytecii

.github/workflows/pre-commit.yml

@@ -30,21 +30,31 @@ jobs:
         run: uv sync --group dev
 
       - name: Run pre-commit
-        run: >-
-          uv run pre-commit run --files
-          app/agent/README.md
-          app/agent/__init__.py
-          app/agent/factory/__init__.py
-          app/agent/factory/social_media.py
-          app/service/chat_service.py
-          app/service/task.py
-          app/utils/toolkit/google_calendar_toolkit.py
-          app/utils/toolkit/google_gmail_mcp_toolkit.py
-          app/utils/toolkit/linkedin_toolkit.py
-          app/utils/toolkit/reddit_toolkit.py
-          app/utils/toolkit/slack_toolkit.py
-          app/utils/toolkit/twitter_toolkit.py
-          app/utils/toolkit/whatsapp_toolkit.py
-          tests/app/agent/factory/test_social_media.py
+        run: |
+          uv run pre-commit run --files \
+            $(find \
+              app/agent \
+              app/controller \
+              app/exception \
+              app/middleware \
+              app/model \
+              app/service \
+              tests/app \
+              -type f ! -path '*__pycache__*') \
+            app/__init__.py \
+            app/router.py \
+            app/component/__init__.py \
+            app/component/pydantic/__init__.py \
+            app/utils/listen/__init__.py \
+            app/utils/server/__init__.py \
+            app/utils/toolkit/__init__.py \
+            app/utils/toolkit/google_calendar_toolkit.py \
+            app/utils/toolkit/google_gmail_mcp_toolkit.py \
+            app/utils/toolkit/linkedin_toolkit.py \
+            app/utils/toolkit/reddit_toolkit.py \
+            app/utils/toolkit/slack_toolkit.py \
+            app/utils/toolkit/twitter_toolkit.py \
+            app/utils/toolkit/whatsapp_toolkit.py \
+            tests/conftest.py
         env:
           SKIP: no-commit-to-branch

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: Test
+
+'on':
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  pytest:
+    name: Run Python Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: |
+          cd backend
+          uv sync
+
+      - name: Run unit tests
+        run: |
+          cd backend
+          uv run pytest tests/app -v

backend/app/__init__.py

@@ -20,5 +20,9 @@
 
 # Add CORS middleware
 api.add_middleware(
-    CORSMiddleware, allow_origins=["*"], allow_credentials=True, allow_methods=["*"], allow_headers=["*"]
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"]
 )

backend/app/agent/agent_model.py

@@ -19,21 +19,23 @@
 from threading import Lock
 from typing import Any, Callable
 
-from app.agent.listen_chat_agent import ListenChatAgent, logger
-from app.model.chat import AgentModelConfig, Chat
-from app.service.task import ActionCreateAgentData, Agents, get_task_lock
 from camel.messages import BaseMessage
 from camel.models import ModelFactory
 from camel.toolkits import FunctionTool, RegisteredAgentToolkit
 from camel.types import ModelPlatformType
 
+from app.agent.listen_chat_agent import ListenChatAgent, logger
+from app.model.chat import AgentModelConfig, Chat
+from app.service.task import ActionCreateAgentData, Agents, get_task_lock
+
 # Thread-safe reference to main event loop using contextvars
 # This ensures each request has its own event loop reference,
 # avoiding race conditions
 _main_event_loop_var: contextvars.ContextVar[asyncio.AbstractEventLoop
                                              | None] = contextvars.ContextVar(
                                                  "_main_event_loop",
-                                                 default=None)
+                                                 default=None
+                                             )
 
 # Global fallback for main event loop reference
 # Used when contextvars don't propagate to worker threads
@@ -77,10 +79,12 @@ def _schedule_async_task(coro):
             asyncio.run_coroutine_threadsafe(coro, main_loop)
         else:
             # This should not happen in normal operation - log error and skip
-            logging.error("No event loop available for async task "
-                          "scheduling, task skipped. Ensure "
-                          "set_main_event_loop() is called "
-                          "before parallel agent creation.")
+            logging.error(
+                "No event loop available for async task "
+                "scheduling, task skipped. Ensure "
+                "set_main_event_loop() is called "
+                "before parallel agent creation."
+            )
 
 
 def agent_model(
@@ -96,8 +100,10 @@ def agent_model(
 ):
     task_lock = get_task_lock(options.project_id)
     agent_id = str(uuid.uuid4())
-    logger.info(f"Creating agent: {agent_name} with id: {agent_id} "
-                f"for project: {options.project_id}")
+    logger.info(
+        f"Creating agent: {agent_name} with id: {agent_id} "
+        f"for project: {options.project_id}"
+    )
     # Use thread-safe scheduling to support parallel agent creation
     _schedule_async_task(
         task_lock.put_queue(
@@ -106,7 +112,10 @@ def agent_model(
                     "agent_name": agent_name,
                     "agent_id": agent_id,
                     "tools": tool_names or [],
-                })))
+                }
+            )
+        )
+    )
 
     # Determine model configuration - use custom config if provided,
     # otherwise use task defaults
@@ -117,11 +126,14 @@ def agent_model(
         for attr in config_attrs:
             effective_config[attr] = getattr(custom_model_config, attr,
                                              None) or getattr(options, attr)
-        extra_params = (custom_model_config.extra_params
-                        or options.extra_params or {})
-        logger.info(f"Agent {agent_name} using custom model config: "
-                    f"platform={effective_config['model_platform']}, "
-                    f"type={effective_config['model_type']}")
+        extra_params = (
+            custom_model_config.extra_params or options.extra_params or {}
+        )
+        logger.info(
+            f"Agent {agent_name} using custom model config: "
+            f"platform={effective_config['model_platform']}, "
+            f"type={effective_config['model_type']}"
+        )
     else:
         for attr in config_attrs:
             effective_config[attr] = getattr(options, attr)
@@ -163,13 +175,14 @@ def agent_model(
     if agent_name == Agents.browser_agent:
         try:
             model_platform_enum = ModelPlatformType(
-                effective_config["model_platform"].lower())
+                effective_config["model_platform"].lower()
+            )
             if model_platform_enum in {
-                    ModelPlatformType.OPENAI,
-                    ModelPlatformType.AZURE,
-                    ModelPlatformType.OPENAI_COMPATIBLE_MODEL,
-                    ModelPlatformType.LITELLM,
-                    ModelPlatformType.OPENROUTER,
+                ModelPlatformType.OPENAI,
+                ModelPlatformType.AZURE,
+                ModelPlatformType.OPENAI_COMPATIBLE_MODEL,
+                ModelPlatformType.LITELLM,
+                ModelPlatformType.OPENROUTER,
             }:
                 model_config["parallel_tool_calls"] = False
         except (ValueError, AttributeError):

backend/app/agent/factory/browser.py

@@ -15,6 +15,9 @@
 import platform
 import uuid
 
+from camel.messages import BaseMessage
+from camel.toolkits import ToolkitMessageIntegration
+
 from app.agent.agent_model import agent_model
 from app.agent.listen_chat_agent import logger
 from app.agent.prompt import BROWSER_SYS_PROMPT
@@ -25,21 +28,23 @@
 from app.utils.file_utils import get_working_directory
 from app.utils.toolkit.human_toolkit import HumanToolkit
 from app.utils.toolkit.hybrid_browser_toolkit import HybridBrowserToolkit
+
 # TODO: Remove NoteTakingToolkit and use TerminalToolkit instead
 from app.utils.toolkit.note_taking_toolkit import NoteTakingToolkit
 from app.utils.toolkit.search_toolkit import SearchToolkit
 from app.utils.toolkit.terminal_toolkit import TerminalToolkit
-from camel.messages import BaseMessage
-from camel.toolkits import ToolkitMessageIntegration
 
 
 def browser_agent(options: Chat):
     working_directory = get_working_directory(options)
-    logger.info(f"Creating browser agent for project: {options.project_id} "
-                f"in directory: {working_directory}")
+    logger.info(
+        f"Creating browser agent for project: {options.project_id} "
+        f"in directory: {working_directory}"
+    )
     message_integration = ToolkitMessageIntegration(
-        message_handler=HumanToolkit(
-            options.project_id, Agents.browser_agent).send_message_to_user)
+        message_handler=HumanToolkit(options.project_id, Agents.browser_agent
+                                     ).send_message_to_user
+    )
 
     web_toolkit_custom = HybridBrowserToolkit(
         options.project_id,
@@ -70,7 +75,8 @@ def browser_agent(options: Chat):
     # Save reference before registering for toolkits_to_register_agent
     web_toolkit_for_agent_registration = web_toolkit_custom
     web_toolkit_custom = message_integration.register_toolkits(
-        web_toolkit_custom)
+        web_toolkit_custom
+    )
 
     terminal_toolkit = TerminalToolkit(
         options.project_id,
@@ -80,11 +86,14 @@ def browser_agent(options: Chat):
         clone_current_env=True,
     )
     terminal_toolkit = message_integration.register_functions(
-        [terminal_toolkit.shell_exec])
+        [terminal_toolkit.shell_exec]
+    )
 
-    note_toolkit = NoteTakingToolkit(options.project_id,
-                                     Agents.browser_agent,
-                                     working_directory=working_directory)
+    note_toolkit = NoteTakingToolkit(
+        options.project_id,
+        Agents.browser_agent,
+        working_directory=working_directory
+    )
     note_toolkit = message_integration.register_toolkits(note_toolkit)
 
     search_tools = SearchToolkit.get_can_use_tools(options.project_id)
@@ -94,8 +103,8 @@ def browser_agent(options: Chat):
         search_tools = []
 
     tools = [
-        *HumanToolkit.get_can_use_tools(options.project_id,
-                                        Agents.browser_agent),
+        *HumanToolkit.
+        get_can_use_tools(options.project_id, Agents.browser_agent),
         *web_toolkit_custom.get_tools(),
         *terminal_toolkit,
         *note_toolkit.get_tools(),

backend/app/agent/factory/developer.py

@@ -14,6 +14,9 @@
 
 import platform
 
+from camel.messages import BaseMessage
+from camel.toolkits import ToolkitMessageIntegration
+
 from app.agent.agent_model import agent_model
 from app.agent.listen_chat_agent import logger
 from app.agent.prompt import DEVELOPER_SYS_PROMPT
@@ -22,22 +25,25 @@
 from app.service.task import Agents
 from app.utils.file_utils import get_working_directory
 from app.utils.toolkit.human_toolkit import HumanToolkit
+
 # TODO: Remove NoteTakingToolkit and use TerminalToolkit instead
 from app.utils.toolkit.note_taking_toolkit import NoteTakingToolkit
 from app.utils.toolkit.screenshot_toolkit import ScreenshotToolkit
 from app.utils.toolkit.terminal_toolkit import TerminalToolkit
 from app.utils.toolkit.web_deploy_toolkit import WebDeployToolkit
-from camel.messages import BaseMessage
-from camel.toolkits import ToolkitMessageIntegration
 
 
 async def developer_agent(options: Chat):
     working_directory = get_working_directory(options)
-    logger.info(f"Creating developer agent for project: {options.project_id} "
-                f"in directory: {working_directory}")
+    logger.info(
+        f"Creating developer agent for project: {options.project_id} "
+        f"in directory: {working_directory}"
+    )
     message_integration = ToolkitMessageIntegration(
         message_handler=HumanToolkit(
-            options.project_id, Agents.developer_agent).send_message_to_user)
+            options.project_id, Agents.developer_agent
+        ).send_message_to_user
+    )
     note_toolkit = NoteTakingToolkit(
         api_task_id=options.project_id,
         agent_name=Agents.developer_agent,
@@ -46,11 +52,14 @@ async def developer_agent(options: Chat):
     note_toolkit = message_integration.register_toolkits(note_toolkit)
     web_deploy_toolkit = WebDeployToolkit(api_task_id=options.project_id)
     web_deploy_toolkit = message_integration.register_toolkits(
-        web_deploy_toolkit)
-    screenshot_toolkit = ScreenshotToolkit(options.project_id,
-                                           working_directory=working_directory)
+        web_deploy_toolkit
+    )
+    screenshot_toolkit = ScreenshotToolkit(
+        options.project_id, working_directory=working_directory
+    )
     screenshot_toolkit = message_integration.register_toolkits(
-        screenshot_toolkit)
+        screenshot_toolkit
+    )
 
     terminal_toolkit = TerminalToolkit(
         options.project_id,
@@ -62,8 +71,8 @@ async def developer_agent(options: Chat):
     terminal_toolkit = message_integration.register_toolkits(terminal_toolkit)
 
     tools = [
-        *HumanToolkit.get_can_use_tools(options.project_id,
-                                        Agents.developer_agent),
+        *HumanToolkit.
+        get_can_use_tools(options.project_id, Agents.developer_agent),
         *note_toolkit.get_tools(),
         *web_deploy_toolkit.get_tools(),
         *terminal_toolkit.get_tools(),