mirror of
https://github.com/EvolutionAPI/adk-python.git
synced 2025-07-14 01:41:25 -06:00
117 lines
3.6 KiB
Python
117 lines
3.6 KiB
Python
# Copyright 2025 Google LLC
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
|
|
import inspect
|
|
from typing import Any
|
|
from typing import Callable
|
|
from typing import Optional
|
|
|
|
from google.oauth2.credentials import Credentials
|
|
from typing_extensions import override
|
|
|
|
from ..function_tool import FunctionTool
|
|
from ..tool_context import ToolContext
|
|
from .bigquery_credentials import BigQueryCredentialsConfig
|
|
from .bigquery_credentials import BigQueryCredentialsManager
|
|
|
|
|
|
class BigQueryTool(FunctionTool):
|
|
"""GoogleApiTool class for tools that call Google APIs.
|
|
|
|
This class is for developers to handcraft customized Google API tools rather
|
|
than auto generate Google API tools based on API specs.
|
|
|
|
This class handles all the OAuth complexity, credential management,
|
|
and common Google API patterns so subclasses can focus on their
|
|
specific functionality.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
func: Callable[..., Any],
|
|
credentials: Optional[BigQueryCredentialsConfig] = None,
|
|
):
|
|
"""Initialize the Google API tool.
|
|
|
|
Args:
|
|
func: callable that impelments the tool's logic, can accept one
|
|
'credential" parameter
|
|
credentials: credentials used to call Google API. If None, then we don't
|
|
hanlde the auth logic
|
|
"""
|
|
super().__init__(func=func)
|
|
self._ignore_params.append("credentials")
|
|
self.credentials_manager = (
|
|
BigQueryCredentialsManager(credentials) if credentials else None
|
|
)
|
|
|
|
@override
|
|
async def run_async(
|
|
self, *, args: dict[str, Any], tool_context: ToolContext
|
|
) -> Any:
|
|
"""Main entry point for tool execution with credential handling.
|
|
|
|
This method handles all the OAuth complexity and then delegates
|
|
to the subclass's run_async_with_credential method.
|
|
"""
|
|
try:
|
|
# Get valid credentials
|
|
credentials = (
|
|
await self.credentials_manager.get_valid_credentials(tool_context)
|
|
if self.credentials_manager
|
|
else None
|
|
)
|
|
|
|
if credentials is None and self.credentials_manager:
|
|
# OAuth flow in progress
|
|
return (
|
|
"User authorization is required to access Google services for"
|
|
f" {self.name}. Please complete the authorization flow."
|
|
)
|
|
|
|
# Execute the tool's specific logic with valid credentials
|
|
|
|
return await self._run_async_with_credential(
|
|
credentials, args, tool_context
|
|
)
|
|
|
|
except Exception as ex:
|
|
return {
|
|
"status": "ERROR",
|
|
"error_details": str(ex),
|
|
}
|
|
|
|
async def _run_async_with_credential(
|
|
self,
|
|
credentials: Credentials,
|
|
args: dict[str, Any],
|
|
tool_context: ToolContext,
|
|
) -> Any:
|
|
"""Execute the tool's specific logic with valid credentials.
|
|
|
|
Args:
|
|
credentials: Valid Google OAuth credentials
|
|
args: Arguments passed to the tool
|
|
tool_context: Tool execution context
|
|
|
|
Returns:
|
|
The result of the tool execution
|
|
"""
|
|
args_to_call = args.copy()
|
|
signature = inspect.signature(self.func)
|
|
if "credentials" in signature.parameters:
|
|
args_to_call["credentials"] = credentials
|
|
return await super().run_async(args=args_to_call, tool_context=tool_context)
|