ag2 0.9.7__py3-none-any.whl → 0.9.8.post1__py3-none-any.whl

autogen/tools/experimental/google/authentication/credentials_local_provider.py

@@ -25,7 +25,7 @@ class GoogleCredentialsLocalProvider(GoogleCredentialsProvider):
         self,
         client_secret_file: str,
         scopes: list[str],  # e.g. ['https://www.googleapis.com/auth/drive/readonly']
-        token_file: Optional[str] = None,
+        token_file: str | None = None,
         port: int = 8080,
     ) -> None:
         """A Google credentials provider that gets the credentials locally.

autogen/tools/experimental/google/drive/drive_functions.py

@@ -4,7 +4,7 @@
 
 import io
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any
 
 from .....import_utils import optional_import_block, require_optional_import
 from ..model import GoogleFileInfo
@@ -25,7 +25,7 @@ __all__ = [
     ],
     "google-api",
 )
-def list_files_and_folders(service: Any, page_size: int, folder_id: Optional[str]) -> list[GoogleFileInfo]:
+def list_files_and_folders(service: Any, page_size: int, folder_id: str | None) -> list[GoogleFileInfo]:
     kwargs = {
         "pageSize": page_size,
         "fields": "nextPageToken, files(id, name, mimeType)",
@@ -40,7 +40,7 @@ def list_files_and_folders(service: Any, page_size: int, folder_id: Optional[str
     return result
 
 
-def _get_file_extension(mime_type: str) -> Optional[str]:
+def _get_file_extension(mime_type: str) -> str | None:
     """Returns the correct file extension for a given MIME type."""
     mime_extensions = {
         "application/vnd.google-apps.document": "docx",  # Google Docs → Word
@@ -70,7 +70,7 @@ def download_file(
     file_name: str,
     mime_type: str,
     download_folder: Path,
-    subfolder_path: Optional[str] = None,
+    subfolder_path: str | None = None,
 ) -> str:
     """Download or export file based on its MIME type, optionally saving to a subfolder."""
     file_extension = _get_file_extension(mime_type)

autogen/tools/experimental/google/drive/toolkit.py

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 from pathlib import Path
-from typing import Annotated, Literal, Optional, Union
+from typing import Annotated, Literal
 
 from .....doc_utils import export_module
 from .....import_utils import optional_import_block
@@ -29,8 +29,8 @@ class GoogleDriveToolkit(Toolkit, GoogleToolkitProtocol):
         self,
         *,
         credentials: "Credentials",
-        download_folder: Union[Path, str],
-        exclude: Optional[list[Literal["list_drive_files_and_folders", "download_file_from_drive"]]] = None,
+        download_folder: Path | str,
+        exclude: list[Literal["list_drive_files_and_folders", "download_file_from_drive"]] | None = None,
         api_version: str = "v3",
     ) -> None:
         """Initialize the Google Drive tool map.
@@ -51,7 +51,7 @@ class GoogleDriveToolkit(Toolkit, GoogleToolkitProtocol):
         def list_drive_files_and_folders(
             page_size: Annotated[int, "The number of files to list per page."] = 10,
             folder_id: Annotated[
-                Optional[str],
+                str | None,
                 "The ID of the folder to list files from. If not provided, lists all files in the root folder.",
             ] = None,
         ) -> list[GoogleFileInfo]:
@@ -61,7 +61,7 @@ class GoogleDriveToolkit(Toolkit, GoogleToolkitProtocol):
         def download_file_from_drive(
             file_info: Annotated[GoogleFileInfo, "The file info to download."],
             subfolder_path: Annotated[
-                Optional[str],
+                str | None,
                 "The subfolder path to save the file in. If not provided, saves in the main download folder.",
             ] = None,
         ) -> str:

autogen/tools/experimental/google_search/google_search.py

@@ -4,7 +4,7 @@
 
 
 import logging
-from typing import Annotated, Any, Optional
+from typing import Annotated, Any
 
 from ....doc_utils import export_module
 from ....import_utils import optional_import_block, require_optional_import
@@ -49,8 +49,8 @@ class GoogleSearchTool(Tool):
     def __init__(
         self,
         *,
-        search_api_key: Optional[str] = None,
-        search_engine_id: Optional[str] = None,
+        search_api_key: str | None = None,
+        search_engine_id: str | None = None,
         use_internal_llm_tool_if_available: bool = True,
     ):
         """GoogleSearchTool is a tool that uses the Google Search API to perform a search.
@@ -74,8 +74,8 @@ class GoogleSearchTool(Tool):
 
         def google_search(
             query: Annotated[str, "The search query."],
-            search_api_key: Annotated[Optional[str], Depends(on(search_api_key))],
-            search_engine_id: Annotated[Optional[str], Depends(on(search_engine_id))],
+            search_api_key: Annotated[str | None, Depends(on(search_api_key))],
+            search_engine_id: Annotated[str | None, Depends(on(search_engine_id))],
             num_results: Annotated[int, "The number of results to return."] = 10,
         ) -> list[dict[str, Any]]:
             if search_api_key is None or search_engine_id is None:

autogen/tools/experimental/google_search/youtube_search.py

@@ -4,7 +4,7 @@
 
 
 import logging
-from typing import Annotated, Any, Dict, List, Optional
+from typing import Annotated, Any
 
 from ....doc_utils import export_module
 from ....import_utils import optional_import_block, require_optional_import
@@ -48,7 +48,7 @@ def _execute_search_query(query: str, youtube_api_key: str, max_results: int) ->
     ["googleapiclient"],
     "google-search",
 )
-def _get_video_details(video_ids: List[str], youtube_api_key: str) -> Any:
+def _get_video_details(video_ids: list[str], youtube_api_key: str) -> Any:
     """Get detailed information about specific YouTube videos.
 
     Args:
@@ -79,7 +79,7 @@ def _youtube_search(
     youtube_api_key: str,
     max_results: int,
     include_video_details: bool = True,
-) -> List[Dict[str, Any]]:
+) -> list[dict[str, Any]]:
     """Search YouTube videos based on a query.
 
     Args:
@@ -140,7 +140,7 @@ class YoutubeSearchTool(Tool):
     def __init__(
         self,
         *,
-        youtube_api_key: Optional[str] = None,
+        youtube_api_key: str | None = None,
     ):
         """Initialize a YouTube search tool.
 
@@ -157,7 +157,7 @@ class YoutubeSearchTool(Tool):
             youtube_api_key: Annotated[str, Depends(on(youtube_api_key))],
             max_results: Annotated[int, "The maximum number of results to return."] = 5,
             include_video_details: Annotated[bool, "Whether to include detailed video information."] = True,
-        ) -> List[Dict[str, Any]]:
+        ) -> list[dict[str, Any]]:
             """Search for YouTube videos based on a query.
 
             Args:

autogen/tools/experimental/messageplatform/discord/discord.py

@@ -4,7 +4,7 @@
 
 import asyncio
 from datetime import datetime, timezone
-from typing import Annotated, Any, Union
+from typing import Annotated, Any
 
 from .....doc_utils import export_module
 from .....import_utils import optional_import_block, require_optional_import
@@ -26,8 +26,7 @@ class DiscordSendTool(Tool):
     """Sends a message to a Discord channel."""
 
     def __init__(self, *, bot_token: str, channel_name: str, guild_name: str) -> None:
-        """
-        Initialize the DiscordSendTool.
+        """Initialize the DiscordSendTool.
 
         Args:
             bot_token: The bot token to use for sending messages.
@@ -42,8 +41,7 @@ class DiscordSendTool(Tool):
             guild_name: Annotated[str, Depends(on(guild_name))],
             channel_name: Annotated[str, Depends(on(channel_name))],
         ) -> Any:
-            """
-            Sends a message to a Discord channel.
+            """Sends a message to a Discord channel.
 
             Args:
                 message: The message to send to the channel.
@@ -123,8 +121,7 @@ class DiscordRetrieveTool(Tool):
     """Retrieves messages from a Discord channel."""
 
     def __init__(self, *, bot_token: str, channel_name: str, guild_name: str) -> None:
-        """
-        Initialize the DiscordRetrieveTool.
+        """Initialize the DiscordRetrieveTool.
 
         Args:
             bot_token: The bot token to use for retrieving messages.
@@ -137,15 +134,14 @@ class DiscordRetrieveTool(Tool):
             guild_name: Annotated[str, Depends(on(guild_name))],
             channel_name: Annotated[str, Depends(on(channel_name))],
             messages_since: Annotated[
-                Union[str, None],
+                str | None,
                 "Date to retrieve messages from (ISO format) OR Discord snowflake ID. If None, retrieves latest messages.",
             ] = None,
             maximum_messages: Annotated[
-                Union[int, None], "Maximum number of messages to retrieve. If None, retrieves all messages since date."
+                int | None, "Maximum number of messages to retrieve. If None, retrieves all messages since date."
             ] = None,
         ) -> Any:
-            """
-            Retrieves messages from a Discord channel.
+            """Retrieves messages from a Discord channel.
 
             Args:
                 bot_token: The bot token to use for Discord. (uses dependency injection)
@@ -162,7 +158,7 @@ class DiscordRetrieveTool(Tool):
             client = Client(intents=intents)
             result_future: asyncio.Future[list[dict[str, Any]]] = asyncio.Future()
 
-            messages_since_date: Union[str, None] = None
+            messages_since_date: str | None = None
             if messages_since is not None:
                 if DiscordRetrieveTool._is_snowflake(messages_since):
                     messages_since_date = DiscordRetrieveTool._snowflake_to_iso(messages_since)

autogen/tools/experimental/messageplatform/slack/slack.py

@@ -4,7 +4,7 @@
 
 import asyncio
 from datetime import datetime, timedelta
-from typing import Annotated, Any, Optional, Tuple, Union
+from typing import Annotated, Any
 
 from .....doc_utils import export_module
 from .....import_utils import optional_import_block, require_optional_import
@@ -26,8 +26,7 @@ class SlackSendTool(Tool):
     """Sends a message to a Slack channel."""
 
     def __init__(self, *, bot_token: str, channel_id: str) -> None:
-        """
-        Initialize the SlackSendTool.
+        """Initialize the SlackSendTool.
 
         Args:
             bot_token: Bot User OAuth Token starting with "xoxb-".
@@ -40,8 +39,7 @@ class SlackSendTool(Tool):
             bot_token: Annotated[str, Depends(on(bot_token))],
             channel_id: Annotated[str, Depends(on(channel_id))],
         ) -> Any:
-            """
-            Sends a message to a Slack channel.
+            """Sends a message to a Slack channel.
 
             Args:
                 message: The message to send to the channel.
@@ -93,8 +91,7 @@ class SlackRetrieveTool(Tool):
     """Retrieves messages from a Slack channel."""
 
     def __init__(self, *, bot_token: str, channel_id: str) -> None:
-        """
-        Initialize the SlackRetrieveTool.
+        """Initialize the SlackRetrieveTool.
 
         Args:
             bot_token: Bot User OAuth Token starting with "xoxb-".
@@ -105,15 +102,14 @@ class SlackRetrieveTool(Tool):
             bot_token: Annotated[str, Depends(on(bot_token))],
             channel_id: Annotated[str, Depends(on(channel_id))],
             messages_since: Annotated[
-                Union[str, None],
+                str | None,
                 "Date to retrieve messages from (ISO format) OR Slack message ID. If None, retrieves latest messages.",
             ] = None,
             maximum_messages: Annotated[
-                Union[int, None], "Maximum number of messages to retrieve. If None, retrieves all messages since date."
+                int | None, "Maximum number of messages to retrieve. If None, retrieves all messages since date."
             ] = None,
         ) -> Any:
-            """
-            Retrieves messages from a Discord channel.
+            """Retrieves messages from a Discord channel.
 
             Args:
                 bot_token: The bot token to use for Discord. (uses dependency injection)
@@ -198,8 +194,7 @@ class SlackRetrieveRepliesTool(Tool):
     """Retrieves replies to a specific Slack message from both threads and the channel."""
 
     def __init__(self, *, bot_token: str, channel_id: str) -> None:
-        """
-        Initialize the SlackRetrieveRepliesTool.
+        """Initialize the SlackRetrieveRepliesTool.
 
         Args:
             bot_token: Bot User OAuth Token starting with "xoxb-".
@@ -211,7 +206,7 @@ class SlackRetrieveRepliesTool(Tool):
             bot_token: Annotated[str, Depends(on(bot_token))],
             channel_id: Annotated[str, Depends(on(channel_id))],
             min_replies: Annotated[
-                Optional[int],
+                int | None,
                 "Minimum number of replies to wait for before returning (thread + channel). If None, returns immediately.",
             ] = None,
             timeout_seconds: Annotated[
@@ -222,8 +217,7 @@ class SlackRetrieveRepliesTool(Tool):
                 bool, "Whether to include messages in the channel after the original message."
             ] = True,
         ) -> Any:
-            """
-            Retrieves replies to a specific Slack message, from both threads and the main channel.
+            """Retrieves replies to a specific Slack message, from both threads and the main channel.
 
             Args:
                 message_ts: The timestamp (ts) identifier of the parent message.
@@ -238,7 +232,7 @@ class SlackRetrieveRepliesTool(Tool):
                 web_client = WebClient(token=bot_token)
 
                 # Function to get current thread replies
-                async def get_thread_replies() -> tuple[Optional[list[dict[str, Any]]], Optional[str]]:
+                async def get_thread_replies() -> tuple[list[dict[str, Any]] | None, str | None]:
                     try:
                         response = web_client.conversations_replies(
                             channel=channel_id,
@@ -258,7 +252,7 @@ class SlackRetrieveRepliesTool(Tool):
                         return None, f"Thread reply retrieval failed, exception: {e}"
 
                 # Function to get messages in the channel after the original message
-                async def get_channel_messages() -> Tuple[Optional[list[dict[str, Any]]], Optional[str]]:
+                async def get_channel_messages() -> tuple[list[dict[str, Any]] | None, str | None]:
                     try:
                         response = web_client.conversations_history(
                             channel=channel_id,
@@ -286,8 +280,8 @@ class SlackRetrieveRepliesTool(Tool):
                         return None, f"Channel message retrieval failed, exception: {e}"
 
                 # Function to get all replies (both thread and channel)
-                async def get_all_replies() -> Tuple[
-                    Optional[list[dict[str, Any]]], Optional[list[dict[str, Any]]], Optional[str]
+                async def get_all_replies() -> tuple[
+                    list[dict[str, Any]] | None, list[dict[str, Any]] | None, str | None
                 ]:
                     thread_replies, thread_error = await get_thread_replies()
                     if thread_error:

autogen/tools/experimental/messageplatform/telegram/telegram.py

@@ -92,8 +92,7 @@ class TelegramSendTool(BaseTelegramTool, Tool):
     """Sends a message to a Telegram channel, group, or user."""
 
     def __init__(self, *, api_id: str, api_hash: str, chat_id: str) -> None:
-        """
-        Initialize the TelegramSendTool.
+        """Initialize the TelegramSendTool.
 
         Args:
             api_id: Telegram API ID from https://my.telegram.org/apps.
@@ -106,8 +105,7 @@ class TelegramSendTool(BaseTelegramTool, Tool):
             message: Annotated[str, "Message to send to the chat."],
             chat_id: Annotated[str, Depends(on(chat_id))],
         ) -> Any:
-            """
-            Sends a message to a Telegram chat.
+            """Sends a message to a Telegram chat.
 
             Args:
                 message: The message to send.
@@ -124,7 +122,7 @@ class TelegramSendTool(BaseTelegramTool, Tool):
                             message[i : i + (MAX_MESSAGE_LENGTH - 1)]
                             for i in range(0, len(message), (MAX_MESSAGE_LENGTH - 1))
                         ]
-                        first_message: Union[Message, None] = None  # type: ignore[no-any-unimported]
+                        first_message: Message | None = None  # type: ignore[no-any-unimported]
 
                         for i, chunk in enumerate(chunks):
                             sent = await client.send_message(
@@ -163,8 +161,7 @@ class TelegramRetrieveTool(BaseTelegramTool, Tool):
     """Retrieves messages from a Telegram channel."""
 
     def __init__(self, *, api_id: str, api_hash: str, chat_id: str) -> None:
-        """
-        Initialize the TelegramRetrieveTool.
+        """Initialize the TelegramRetrieveTool.
 
         Args:
             api_id: Telegram API ID from https://my.telegram.org/apps.
@@ -177,16 +174,15 @@ class TelegramRetrieveTool(BaseTelegramTool, Tool):
         async def telegram_retrieve_messages(
             chat_id: Annotated[str, Depends(on(chat_id))],
             messages_since: Annotated[
-                Union[str, None],
+                str | None,
                 "Date to retrieve messages from (ISO format) OR message ID. If None, retrieves latest messages.",
             ] = None,
             maximum_messages: Annotated[
-                Union[int, None], "Maximum number of messages to retrieve. If None, retrieves all messages since date."
+                int | None, "Maximum number of messages to retrieve. If None, retrieves all messages since date."
             ] = None,
-            search: Annotated[Union[str, None], "Optional string to search for in messages."] = None,
+            search: Annotated[str | None, "Optional string to search for in messages."] = None,
         ) -> Any:
-            """
-            Retrieves messages from a Telegram chat.
+            """Retrieves messages from a Telegram chat.
 
             Args:
                 chat_id: The ID of the chat. (uses dependency injection)

autogen/tools/experimental/perplexity/perplexity_search.py

@@ -1,5 +1,4 @@
-"""
-Module: perplexity_search_tool
+"""Module: perplexity_search_tool
 Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
 SPDX-License-Identifier: Apache-2.0
 
@@ -9,7 +8,7 @@ It defines data models for responses and a tool for executing web and conversati
 
 import json
 import os
-from typing import Any, Optional, Union
+from typing import Any
 
 import requests
 from pydantic import BaseModel, ValidationError
@@ -18,8 +17,7 @@ from autogen.tools import Tool
 
 
 class Message(BaseModel):
-    """
-    Represents a message in the chat conversation.
+    """Represents a message in the chat conversation.
 
     Attributes:
         role (str): The role of the message sender (e.g., "system", "user").
@@ -31,8 +29,7 @@ class Message(BaseModel):
 
 
 class Usage(BaseModel):
-    """
-    Model representing token usage details.
+    """Model representing token usage details.
 
     Attributes:
         prompt_tokens (int): The number of tokens used for the prompt.
@@ -48,8 +45,7 @@ class Usage(BaseModel):
 
 
 class Choice(BaseModel):
-    """
-    Represents one choice in the response from the Perplexity API.
+    """Represents one choice in the response from the Perplexity API.
 
     Attributes:
         index (int): The index of this choice.
@@ -63,8 +59,7 @@ class Choice(BaseModel):
 
 
 class PerplexityChatCompletionResponse(BaseModel):
-    """
-    Represents the full chat completion response from the Perplexity API.
+    """Represents the full chat completion response from the Perplexity API.
 
     Attributes:
         id (str): Unique identifier for the response.
@@ -86,8 +81,7 @@ class PerplexityChatCompletionResponse(BaseModel):
 
 
 class SearchResponse(BaseModel):
-    """
-    Represents the response from a search query.
+    """Represents the response from a search query.
 
     Attributes:
         content (Optional[str]): The textual content returned from the search.
@@ -95,14 +89,13 @@ class SearchResponse(BaseModel):
         error (Optional[str]): An error message if the search failed.
     """
 
-    content: Union[str, None]
-    citations: Union[list[str], None]
-    error: Union[str, None]
+    content: str | None
+    citations: list[str] | None
+    error: str | None
 
 
 class PerplexitySearchTool(Tool):
-    """
-    Tool for interacting with the Perplexity AI search API.
+    """Tool for interacting with the Perplexity AI search API.
 
     This tool uses the Perplexity API to perform web search, news search,
     and conversational search, returning concise and precise responses.
@@ -118,12 +111,11 @@ class PerplexitySearchTool(Tool):
     def __init__(
         self,
         model: str = "sonar",
-        api_key: Optional[str] = None,
+        api_key: str | None = None,
         max_tokens: int = 1000,
-        search_domain_filter: Optional[list[str]] = None,
+        search_domain_filter: list[str] | None = None,
     ):
-        """
-        Initializes a new instance of the PerplexitySearchTool.
+        """Initializes a new instance of the PerplexitySearchTool.
 
         Args:
             model (str, optional): The model to use. Defaults to "sonar".
@@ -150,10 +142,9 @@ class PerplexitySearchTool(Tool):
 
     @staticmethod
     def _validate_tool_config(
-        model: str, api_key: Union[str, None], max_tokens: int, search_domain_filter: Union[list[str], None]
+        model: str, api_key: str | None, max_tokens: int, search_domain_filter: list[str] | None
     ) -> None:
-        """
-        Validates the configuration parameters for the search tool.
+        """Validates the configuration parameters for the search tool.
 
         Args:
             model (str): The model to use.
@@ -175,8 +166,7 @@ class PerplexitySearchTool(Tool):
             raise ValueError("search_domain_filter must be a list")
 
     def _execute_query(self, payload: dict[str, Any]) -> "PerplexityChatCompletionResponse":
-        """
-        Executes a query by sending a POST request to the Perplexity API.
+        """Executes a query by sending a POST request to the Perplexity API.
 
         Args:
             payload (dict[str, Any]): The payload to send in the API request.
@@ -223,8 +213,7 @@ class PerplexitySearchTool(Tool):
         return perp_resp
 
     def search(self, query: str) -> "SearchResponse":
-        """
-        Perform a search query using the Perplexity AI API.
+        """Perform a search query using the Perplexity AI API.
 
         Constructs the payload, executes the query, and parses the response to return
         a concise search result along with any provided citations.