3f7226709f
SDK support for tool secrets (stored and managed by the engine): - [x] New `requires_secrets=` option in the `@tool` decorator - [x] Internal plumbing in the catalog and `ToolContext` - [x] Full test coverage of all added code - [x] Bumped minor version (new feature) This PR can be merged without waiting for Engine changes, because it is additive only (no breaking changes). After this is merged, I will open another PR to update existing toolkits that will benefit from this feature!
74 lines
2.5 KiB
Python
74 lines
2.5 KiB
Python
import functools
|
|
import inspect
|
|
from typing import Any, Callable, TypeVar, Union
|
|
|
|
from arcade.core.utils import snake_to_pascal_case
|
|
from arcade.sdk.auth import ToolAuthorization
|
|
from arcade.sdk.errors import ToolExecutionError
|
|
|
|
T = TypeVar("T")
|
|
|
|
|
|
def tool(
|
|
func: Callable | None = None,
|
|
desc: str | None = None,
|
|
name: str | None = None,
|
|
requires_auth: Union[ToolAuthorization, None] = None,
|
|
requires_secrets: Union[list[str], None] = None,
|
|
) -> Callable:
|
|
def decorator(func: Callable) -> Callable:
|
|
func_name = str(getattr(func, "__name__", None))
|
|
tool_name = name or snake_to_pascal_case(func_name)
|
|
|
|
func.__tool_name__ = tool_name # type: ignore[attr-defined]
|
|
func.__tool_description__ = desc or inspect.cleandoc(func.__doc__ or "") # type: ignore[attr-defined]
|
|
func.__tool_requires_auth__ = requires_auth # type: ignore[attr-defined]
|
|
func.__tool_requires_secrets__ = requires_secrets # type: ignore[attr-defined]
|
|
|
|
if inspect.iscoroutinefunction(func):
|
|
|
|
@functools.wraps(func)
|
|
async def func_with_error_handling(*args: Any, **kwargs: Any) -> Any:
|
|
try:
|
|
return await func(*args, **kwargs)
|
|
|
|
# make sure developer raised ToolExecutionError is not
|
|
# reraised incorrectly.
|
|
except ToolExecutionError:
|
|
raise
|
|
except Exception as e:
|
|
raise ToolExecutionError(
|
|
message=f"Error in execution of {tool_name}",
|
|
developer_message=f"Error in {func_name}: {e!s}",
|
|
) from e
|
|
|
|
else:
|
|
|
|
@functools.wraps(func)
|
|
def func_with_error_handling(*args: Any, **kwargs: Any) -> Any:
|
|
try:
|
|
return func(*args, **kwargs)
|
|
except ToolExecutionError:
|
|
raise
|
|
except Exception as e:
|
|
raise ToolExecutionError(
|
|
message=f"Error in execution of {tool_name}",
|
|
developer_message=f"Error in {func_name}: {e!s}",
|
|
) from e
|
|
|
|
return func_with_error_handling
|
|
|
|
if func:
|
|
return decorator(func)
|
|
return decorator
|
|
|
|
|
|
def _tool_deprecated(message: str) -> Callable:
|
|
def decorator(func: Callable) -> Callable:
|
|
func.__tool_deprecation_message__ = message # type: ignore[attr-defined]
|
|
return func
|
|
|
|
return decorator
|
|
|
|
|
|
tool.deprecated = _tool_deprecated # type: ignore[attr-defined]
|