glaip-sdk 0.0.0b99__py3-none-any.whl

glaip_sdk/registry/tool.py

@@ -0,0 +1,393 @@
+"""Tool registry for glaip_sdk.
+
+This module provides the ToolRegistry that caches deployed tools
+to avoid redundant API calls when deploying agents with tools.
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from glaip_sdk.registry.base import BaseRegistry
+
+if TYPE_CHECKING:
+    from glaip_sdk.tools import Tool
+
+logger = logging.getLogger(__name__)
+
+
+class ToolRegistry(BaseRegistry["Tool"]):
+    """Registry for tools.
+
+    Resolves tool references to glaip_sdk.models.Tool objects.
+    Caches results to avoid redundant API calls and duplicate uploads.
+
+    Handles:
+        - Tool classes (LangChain BaseTool subclasses) → upload, cache, return Tool
+        - glaip_sdk.models.Tool → return as-is (uses tool.id)
+        - String names → lookup on platform, cache, return Tool
+
+    Attributes:
+        _cache: Internal cache mapping names to Tool objects.
+
+    Example:
+        >>> registry = get_tool_registry()
+        >>> tool = registry.resolve(WebSearchTool)
+        >>> print(tool.id)
+    """
+
+    def _get_name_from_model_fields(self, ref: type) -> str | None:
+        """Extract name from Pydantic model_fields if available."""
+        model_fields = getattr(ref, "model_fields", {})
+        if "name" not in model_fields:
+            return None
+        field_info = model_fields["name"]
+        default = getattr(field_info, "default", None)
+        return default if isinstance(default, str) else None
+
+    def _get_string_attr(self, obj: Any, attr: str) -> str | None:
+        """Get attribute if it's a string, otherwise None."""
+        value = getattr(obj, attr, None)
+        return value if isinstance(value, str) else None
+
+    def _extract_name_from_instance(self, ref: Any) -> str | None:
+        """Extract name from a non-type instance.
+
+        Args:
+            ref: The instance to extract name from.
+
+        Returns:
+            The extracted name, or None if not found.
+        """
+        if isinstance(ref, type):
+            return None
+        return self._get_string_attr(ref, "name")
+
+    def _extract_name_from_class(self, ref: Any) -> str | None:
+        """Extract name from a class.
+
+        Args:
+            ref: The class to extract name from.
+
+        Returns:
+            The extracted name, or None if not found.
+        """
+        if not isinstance(ref, type):
+            return None
+        return self._get_string_attr(ref, "name") or self._get_name_from_model_fields(ref)
+
+    def _extract_name(self, ref: Any) -> str:
+        """Extract tool name from a reference.
+
+        Args:
+            ref: A tool class, instance, dict, or string name.
+
+        Returns:
+            The extracted tool name.
+
+        Raises:
+            ValueError: If name cannot be extracted from the reference.
+        """
+        # Lazy import to avoid circular dependency
+        from glaip_sdk.tools.base import Tool  # noqa: PLC0415
+
+        if isinstance(ref, str):
+            return ref
+
+        # Tool instance (from Tool.from_langchain() or Tool.from_native())
+        if isinstance(ref, Tool):
+            return ref.get_name()
+
+        # Dict from API response - extract name or id
+        if isinstance(ref, dict):
+            return ref.get("name") or ref.get("id") or ""
+
+        # Tool instance (not a class) with name attribute
+        name = self._extract_name_from_instance(ref)
+        if name:
+            return name
+
+        # Tool class - try direct attribute first, then model_fields
+        name = self._extract_name_from_class(ref)
+        if name:
+            return name
+
+        raise ValueError(f"Cannot extract name from: {ref}")
+
+    def _cache_tool(self, tool: Tool, name: str) -> None:
+        """Cache a tool by name and ID if available.
+
+        Args:
+            tool: The tool to cache.
+            name: The tool name.
+        """
+        self._cache[name] = tool
+        if hasattr(tool, "id") and tool.id:
+            self._cache[tool.id] = tool
+
+    def _resolve_tool_instance(self, ref: Any, name: str) -> Tool | None:
+        """Resolve a ToolClass instance.
+
+        Args:
+            ref: The ToolClass instance to resolve.
+            name: The extracted tool name.
+
+        Returns:
+            The resolved tool, or None if not a ToolClass instance.
+        """
+        # Lazy imports to avoid circular dependency
+        from glaip_sdk.tools.base import Tool as ToolClass  # noqa: PLC0415
+        from glaip_sdk.tools.base import ToolType  # noqa: PLC0415
+        from glaip_sdk.utils.discovery import find_tool  # noqa: PLC0415
+        from glaip_sdk.utils.sync import update_or_create_tool  # noqa: PLC0415
+
+        # Use try/except to handle mocked Tool class in tests
+        try:
+            is_tool_instance = isinstance(ref, ToolClass)
+        except TypeError:
+            return None
+
+        if not is_tool_instance:
+            return None
+
+        # If Tool has an ID, it's already deployed - return as-is
+        if ref.id is not None:
+            logger.debug("Caching already deployed tool: %s", name)
+            self._cache_tool(ref, name)
+            return ref
+
+        # Tool.from_native() - look up on platform
+        if ref.tool_type == ToolType.NATIVE:
+            logger.info("Looking up native tool: %s", name)
+            tool = find_tool(name)
+            if tool:
+                self._cache[name] = tool
+                return tool
+            raise ValueError(f"Native tool not found on platform: {name}")
+
+        # Tool.from_langchain() - upload the tool_class
+        if ref.tool_class is not None:
+            logger.info("Uploading custom tool: %s", name)
+            tool = update_or_create_tool(ref.tool_class)
+            self._cache_tool(tool, name)
+            return tool
+
+        # Unresolvable Tool instance - neither native nor has tool_class
+        raise ValueError(
+            f"Cannot resolve Tool instance: {ref}. "
+            f"Tool has no id, is not NATIVE type, and has no tool_class. "
+            f"Ensure Tool is created via Tool.from_native() or Tool.from_langchain()."
+        )
+
+    def _resolve_deployed_tool(self, ref: Any, name: str) -> Tool | None:
+        """Resolve an already deployed tool (has id/name attributes).
+
+        Args:
+            ref: The tool reference to resolve.
+            name: The extracted tool name.
+
+        Returns:
+            The resolved tool, or None if not a deployed tool.
+        """
+        from glaip_sdk.utils.discovery import find_tool  # noqa: PLC0415
+
+        # Already deployed tool (not a ToolClass, but has id/name)
+        # This handles API response objects and backward compatibility
+        if not (hasattr(ref, "id") and hasattr(ref, "name") and not isinstance(ref, type)):
+            return None
+
+        if ref.id is not None:
+            logger.debug("Caching already deployed tool: %s", name)
+            # Use _cache_tool to cache by both name and ID for consistency
+            self._cache_tool(ref, name)
+            return ref
+
+        # Tool without ID (backward compatibility) - look up on platform
+        logger.info("Looking up native tool: %s", name)
+        tool = find_tool(name)
+        if tool:
+            # Use _cache_tool to cache by both name and ID if available
+            self._cache_tool(tool, name)
+            return tool
+        raise ValueError(f"Native tool not found on platform: {name}")
+
+    def _resolve_custom_tool(self, ref: Any, name: str) -> Tool | None:
+        """Resolve a custom tool class.
+
+        Args:
+            ref: The tool reference to resolve.
+            name: The extracted tool name.
+
+        Returns:
+            The resolved tool, or None if not a custom tool.
+        """
+        from glaip_sdk.utils.sync import update_or_create_tool  # noqa: PLC0415
+
+        if not self._is_custom_tool(ref):
+            return None
+
+        logger.info("Uploading custom tool: %s", name)
+        tool = update_or_create_tool(ref)
+        self._cache_tool(tool, name)
+        return tool
+
+    def _resolve_dict_tool(self, ref: Any, name: str) -> Tool | None:
+        """Resolve a tool from a dict (API response).
+
+        Args:
+            ref: The dict to resolve.
+            name: The extracted tool name.
+
+        Returns:
+            The resolved tool, or None if not a dict.
+        """
+        from glaip_sdk.tools.base import Tool as ToolClass  # noqa: PLC0415
+
+        if not isinstance(ref, dict):
+            return None
+
+        tool_id = ref.get("id")
+        if tool_id:
+            tool = ToolClass(id=tool_id, name=ref.get("name", ""))
+            # Use _cache_tool to cache by both name and ID for consistency
+            self._cache_tool(tool, name)
+            return tool
+        raise ValueError(f"Tool dict missing 'id': {ref}")
+
+    def _resolve_string_tool(self, ref: Any, name: str) -> Tool | None:
+        """Resolve a tool from a string name.
+
+        Args:
+            ref: The string to resolve.
+            name: The extracted tool name.
+
+        Returns:
+            The resolved tool, or None if not a string.
+        """
+        from glaip_sdk.utils.discovery import find_tool  # noqa: PLC0415
+
+        if not isinstance(ref, str):
+            return None
+
+        logger.info("Looking up tool by name: %s", name)
+        tool = find_tool(name)
+        if tool:
+            # Use _cache_tool to cache by both name and ID for consistency
+            self._cache_tool(tool, name)
+            return tool
+        raise ValueError(f"Tool not found on platform: {name}")
+
+    def _resolve_and_cache(self, ref: Any, name: str) -> Tool:
+        """Resolve tool reference - upload if class, find if string/native.
+
+        Args:
+            ref: The tool reference to resolve.
+            name: The extracted tool name.
+
+        Returns:
+            The resolved glaip_sdk.models.Tool object.
+
+        Raises:
+            ValueError: If the tool cannot be resolved.
+        """
+        # Try each resolution strategy in order
+        resolvers = [
+            self._resolve_tool_instance,
+            self._resolve_deployed_tool,
+            self._resolve_custom_tool,
+            self._resolve_dict_tool,
+            self._resolve_string_tool,
+        ]
+
+        for resolver in resolvers:
+            result = resolver(ref, name)
+            if result is not None:
+                return result
+
+        raise ValueError(f"Could not resolve tool reference: {ref}")
+
+    def _is_custom_tool(self, ref: Any) -> bool:
+        """Check if reference is a custom tool class/instance.
+
+        Args:
+            ref: The reference to check.
+
+        Returns:
+            True if ref is a custom tool that needs uploading.
+        """
+        try:
+            from glaip_sdk.utils.tool_detection import (  # noqa: PLC0415
+                is_langchain_tool,
+            )
+        except ImportError:
+            return False
+
+        return is_langchain_tool(ref)
+
+    def resolve(self, ref: Any) -> Tool:
+        """Resolve a tool reference to a platform Tool object.
+
+        Overrides base resolve to handle SDK tools differently.
+
+        Args:
+            ref: The tool reference to resolve.
+
+        Returns:
+            The resolved glaip_sdk.models.Tool object.
+        """
+        # Check if it's a Tool instance (not a class)
+        if hasattr(ref, "id") and hasattr(ref, "name") and not isinstance(ref, type):
+            # If Tool has an ID, it's already deployed - return as-is
+            if ref.id is not None:
+                name = self._extract_name(ref)
+                if name not in self._cache:
+                    # Use _cache_tool to cache by both name and ID for consistency
+                    self._cache_tool(ref, name)
+                return ref
+
+            # Tool without ID (e.g., from Tool.from_native()) - needs platform lookup
+            # Fall through to normal resolution
+
+        return super().resolve(ref)
+
+
+class _ToolRegistrySingleton:
+    """Singleton holder for ToolRegistry to avoid global statement."""
+
+    _instance: ToolRegistry | None = None
+
+    @classmethod
+    def get_instance(cls) -> ToolRegistry:
+        """Get or create the singleton instance.
+
+        Returns:
+            The global ToolRegistry instance.
+        """
+        if cls._instance is None:
+            cls._instance = ToolRegistry()
+        return cls._instance
+
+    @classmethod
+    def reset(cls) -> None:
+        """Reset the singleton instance (for testing)."""
+        cls._instance = None
+
+
+def get_tool_registry() -> ToolRegistry:
+    """Get the singleton ToolRegistry instance.
+
+    Returns a global ToolRegistry that caches tools across the session.
+
+    Returns:
+        The global ToolRegistry instance.
+
+    Example:
+        >>> from glaip_sdk.registry import get_tool_registry
+        >>> registry = get_tool_registry()
+        >>> tool = registry.resolve("web_search")
+    """
+    return _ToolRegistrySingleton.get_instance()

glaip_sdk/rich_components.py

@@ -0,0 +1,125 @@
+"""Custom Rich components with copy-friendly defaults.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+"""
+
+from __future__ import annotations
+
+from rich import box
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+
+
+class AIPPanel(Panel):
+    """Rich Panel configured without vertical borders by default."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize AIPPanel with default settings for horizontal borders and padding.
+
+        Args:
+            *args: Positional arguments passed to Panel
+            **kwargs: Keyword arguments passed to Panel
+        """
+        kwargs.setdefault("box", box.HORIZONTALS)
+        kwargs.setdefault("padding", (0, 1))
+        super().__init__(*args, **kwargs)
+
+
+class AIPTable(Table):
+    """Rich Table configured without vertical borders by default."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize AIPTable with default settings for horizontal borders and no edge padding.
+
+        Args:
+            *args: Positional arguments passed to Table
+            **kwargs: Keyword arguments passed to Table
+        """
+        kwargs.setdefault("box", box.HORIZONTALS)
+        kwargs.setdefault("show_edge", False)
+        kwargs.setdefault("pad_edge", False)
+        super().__init__(*args, **kwargs)
+
+
+class AIPGrid(Table):
+    """Table-based grid with GL AIP defaults for layout blocks."""
+
+    def __init__(
+        self,
+        *,
+        expand: bool = True,
+        padding: tuple[int, int] = (0, 1),
+        collapse_padding: bool = True,
+    ):
+        """Initialize AIPGrid with zero-edge borders and optional expansion.
+
+        Args:
+            expand: Whether the grid should expand to fill available width.
+            padding: Cell padding for the grid (row, column).
+            collapse_padding: Collapse padding between renderables.
+        """
+        super().__init__(
+            show_header=False,
+            show_edge=False,
+            pad_edge=False,
+            box=None,
+            expand=expand,
+            padding=padding,
+            collapse_padding=collapse_padding,
+        )
+
+
+class RemoteRunsTable(AIPTable):
+    """Rich Table for displaying remote agent runs with pagination support."""
+
+    def __init__(self, *args, **kwargs):
+        """Initialize RemoteRunsTable with columns for run display.
+
+        Args:
+            *args: Positional arguments passed to AIPTable
+            **kwargs: Keyword arguments passed to AIPTable
+        """
+        kwargs.setdefault("row_styles", ("dim", "none"))
+        kwargs.setdefault("show_header", True)
+        super().__init__(*args, **kwargs)
+        # Add columns for run display
+        self.add_column("", width=2, no_wrap=True)  # Selection gutter
+        self.add_column("Run UUID", style="cyan", width=36, no_wrap=True)
+        self.add_column("Type", style="yellow", width=8, no_wrap=True)
+        self.add_column("Status", style="magenta", width=12, no_wrap=True)
+        self.add_column("Started (UTC)", style="dim", width=20, no_wrap=True)
+        self.add_column("Completed (UTC)", style="dim", width=20, no_wrap=True)
+        self.add_column("Duration", style="green", width=10, no_wrap=True)
+        self.add_column("Input Preview", style="white", width=40, overflow="ellipsis")
+
+    def add_run_row(
+        self,
+        run_uuid: str,
+        run_type: str,
+        status: str,
+        started: str,
+        completed: str,
+        duration: str,
+        preview: str,
+        *,
+        selected: bool = False,
+    ) -> None:
+        """Append a run row with optional selection styling."""
+        gutter = Text("› ", style="bold bright_cyan") if selected else Text("  ")
+        row_style = "reverse" if selected else None
+        self.add_row(
+            gutter,
+            run_uuid,
+            run_type,
+            status,
+            started,
+            completed,
+            duration,
+            preview,
+            style=row_style,
+        )
+
+
+__all__ = ["AIPPanel", "AIPTable", "AIPGrid", "RemoteRunsTable"]

glaip_sdk/runner/__init__.py

@@ -0,0 +1,59 @@
+"""Local agent execution runners.
+
+This module provides runners for executing glaip-sdk agents locally
+without requiring the AIP backend server. The primary runner is
+LangGraphRunner which uses the aip-agents library.
+
+To use local execution, install with the [local] extra:
+    pip install "glaip-sdk[local]"
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+
+Example:
+    >>> from glaip_sdk.runner import get_default_runner
+    >>> from glaip_sdk.agents import Agent
+    >>>
+    >>> agent = Agent(name="my-agent", instruction="You are helpful.")
+    >>> runner = get_default_runner()
+    >>> result = runner.run(agent, "Hello!")
+"""
+
+from glaip_sdk.runner.deps import (
+    LOCAL_RUNTIME_AVAILABLE,
+    check_local_runtime_available,
+    get_local_runtime_missing_message,
+)
+from glaip_sdk.runner.langgraph import LangGraphRunner
+
+# Default runner instance
+_default_runner: LangGraphRunner | None = None
+
+
+def get_default_runner() -> LangGraphRunner:
+    """Get the default runner instance for local agent execution.
+
+    Returns:
+        The default LangGraphRunner instance.
+
+    Raises:
+        RuntimeError: If local runtime dependencies are not available.
+    """
+    global _default_runner
+
+    if not check_local_runtime_available():
+        raise RuntimeError(get_local_runtime_missing_message())
+
+    if _default_runner is None:
+        _default_runner = LangGraphRunner()
+
+    return _default_runner
+
+
+__all__ = [
+    "LOCAL_RUNTIME_AVAILABLE",
+    "LangGraphRunner",
+    "check_local_runtime_available",
+    "get_default_runner",
+    "get_local_runtime_missing_message",
+]

glaip_sdk/runner/base.py

@@ -0,0 +1,84 @@
+"""Abstract base class for agent execution runners.
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from glaip_sdk.agents.base import Agent
+
+
+class BaseRunner(ABC):
+    """Abstract base class for agent execution runners.
+
+    Runners are responsible for executing glaip-sdk Agent instances
+    and returning results. Different runner implementations may use
+    different execution backends (LangGraph, Google ADK, etc.).
+    """
+
+    @abstractmethod
+    def run(
+        self,
+        agent: Agent,
+        message: str,
+        verbose: bool = False,
+        runtime_config: dict[str, Any] | None = None,
+        chat_history: list[dict[str, str]] | None = None,
+        **kwargs: Any,
+    ) -> str:
+        """Execute agent synchronously and return final response text.
+
+        Args:
+            agent: The glaip_sdk Agent to execute.
+            message: The user message to send to the agent.
+            verbose: If True, emit debug trace output during execution.
+                Defaults to False.
+            runtime_config: Optional runtime configuration for tools, MCPs, etc.
+                Defaults to None.
+            chat_history: Optional list of prior conversation messages.
+                Defaults to None.
+            **kwargs: Additional keyword arguments passed to the backend.
+
+        Returns:
+            The final response text from the agent.
+
+        Raises:
+            RuntimeError: If execution fails.
+        """
+        ...
+
+    @abstractmethod
+    async def arun(
+        self,
+        agent: Agent,
+        message: str,
+        verbose: bool = False,
+        runtime_config: dict[str, Any] | None = None,
+        chat_history: list[dict[str, str]] | None = None,
+        **kwargs: Any,
+    ) -> str:
+        """Execute agent asynchronously and return final response text.
+
+        Args:
+            agent: The glaip_sdk Agent to execute.
+            message: The user message to send to the agent.
+            verbose: If True, emit debug trace output during execution.
+                Defaults to False.
+            runtime_config: Optional runtime configuration for tools, MCPs, etc.
+                Defaults to None.
+            chat_history: Optional list of prior conversation messages.
+                Defaults to None.
+            **kwargs: Additional keyword arguments passed to the backend.
+
+        Returns:
+            The final response text from the agent.
+
+        Raises:
+            RuntimeError: If execution fails.
+        """
+        ...