From c745eaadad58c012e06d4a146d2e729eb8b8752e Mon Sep 17 00:00:00 2001
From: Jinfeng Sun <86536994+Tendo33@users.noreply.github.com>
Date: Fri, 10 Oct 2025 10:45:31 +0800
Subject: [PATCH] correct ruff command to include 'common' directory and 
 improve type annotations and imports for clarity (#243)

* fix(format.sh): correct ruff command to include 'common' directory

* refactor(llm.py): improve type annotations and imports for clarity
---
 backend/apps/ai_model/openai/llm.py | 50 +++++++++++++++++------------
 backend/scripts/format.sh           |  4 +--
 2 files changed, 32 insertions(+), 22 deletions(-)

diff --git a/backend/apps/ai_model/openai/llm.py b/backend/apps/ai_model/openai/llm.py
index 2224868d..ac1951ec 100644
--- a/backend/apps/ai_model/openai/llm.py
+++ b/backend/apps/ai_model/openai/llm.py
@@ -1,11 +1,20 @@
-from typing import Dict, Optional, Any, Iterator, cast, Mapping
+from collections.abc import Iterator, Mapping
+from typing import Any, cast
 
 from langchain_core.language_models import LanguageModelInput
-from langchain_core.messages import BaseMessage, BaseMessageChunk, HumanMessageChunk, AIMessageChunk, \
-    SystemMessageChunk, FunctionMessageChunk, ChatMessageChunk
+from langchain_core.messages import (
+    AIMessageChunk,
+    BaseMessage,
+    BaseMessageChunk,
+    ChatMessageChunk,
+    FunctionMessageChunk,
+    HumanMessageChunk,
+    SystemMessageChunk,
+)
 from langchain_core.messages.ai import UsageMetadata
-from langchain_core.messages.tool import tool_call_chunk, ToolMessageChunk
+from langchain_core.messages.tool import ToolMessageChunk, tool_call_chunk
 from langchain_core.outputs import ChatGenerationChunk
+from langchain_core.outputs.chat_generation import ChatGeneration
 from langchain_core.runnables import RunnableConfig, ensure_config
 from langchain_openai import ChatOpenAI
 from langchain_openai.chat_models.base import _create_usage_metadata
@@ -75,7 +84,7 @@ class BaseChatOpenAI(ChatOpenAI):
 
     # custom_get_token_ids = custom_get_token_ids
 
-    def get_last_generation_info(self) -> Optional[Dict[str, Any]]:
+    def get_last_generation_info(self) -> dict[str, Any] | None:
         return self.usage_metadata
 
     def _stream(self, *args: Any, **kwargs: Any) -> Iterator[ChatGenerationChunk]:
@@ -86,11 +95,11 @@ class BaseChatOpenAI(ChatOpenAI):
             yield chunk
 
     def _convert_chunk_to_generation_chunk(
-            self,
-            chunk: dict,
-            default_chunk_class: type,
-            base_generation_info: Optional[dict],
-    ) -> Optional[ChatGenerationChunk]:
+        self,
+        chunk: dict,
+        default_chunk_class: type,
+        base_generation_info: dict | None,
+    ) -> ChatGenerationChunk | None:
         if chunk.get("type") == "content.delta":  # from beta.chat.completions.stream
             return None
         token_usage = chunk.get("usage")
@@ -100,8 +109,10 @@ class BaseChatOpenAI(ChatOpenAI):
                 or chunk.get("chunk", {}).get("choices", [])
         )
 
-        usage_metadata: Optional[UsageMetadata] = (
-            _create_usage_metadata(token_usage) if token_usage and token_usage.get("prompt_tokens") else None
+        usage_metadata: UsageMetadata | None = (
+            _create_usage_metadata(token_usage)
+            if token_usage and token_usage.get("prompt_tokens")
+            else None
         )
         if len(choices) == 0:
             # logprobs is implicitly None
@@ -139,16 +150,16 @@ class BaseChatOpenAI(ChatOpenAI):
         return generation_chunk
 
     def invoke(
-            self,
-            input: LanguageModelInput,
-            config: Optional[RunnableConfig] = None,
-            *,
-            stop: Optional[list[str]] = None,
-            **kwargs: Any,
+        self,
+        input: LanguageModelInput,
+        config: RunnableConfig | None = None,
+        *,
+        stop: list[str] | None = None,
+        **kwargs: Any,
     ) -> BaseMessage:
         config = ensure_config(config)
         chat_result = cast(
-            "ChatGeneration",
+            ChatGeneration,
             self.generate_prompt(
                 [self._convert_input(input)],
                 stop=stop,
@@ -159,7 +170,6 @@ class BaseChatOpenAI(ChatOpenAI):
                 run_id=config.pop("run_id", None),
                 **kwargs,
             ).generations[0][0],
-
         ).message
 
         self.usage_metadata = chat_result.response_metadata[
diff --git a/backend/scripts/format.sh b/backend/scripts/format.sh
index 7be2f812..45063444 100755
--- a/backend/scripts/format.sh
+++ b/backend/scripts/format.sh
@@ -1,5 +1,5 @@
 #!/bin/sh -e
 set -x
 
-ruff check app scripts --fix
-ruff format app scripts
+ruff check apps scripts common --fix
+ruff format apps scripts common