optimizely-opal.opal-tools-sdk 0.1.2.dev0__py3-none-any.whl → 0.1.4.dev0__py3-none-any.whl

opal_tools_sdk/__init__.py

@@ -1,6 +1,7 @@
 from .service import ToolsService
 from .decorators import tool
 from .auth import requires_auth
+from .logging import register_logger_factory
 
 __version__ = "0.1.0"
-__all__ = ["ToolsService", "tool", "requires_auth"]
+__all__ = ["ToolsService", "tool", "requires_auth", "register_logger_factory"]

opal_tools_sdk/decorators.py

@@ -1,13 +1,14 @@
 import inspect
 import re
 import logging
-from typing import Callable, Any, List, Dict, Type, get_type_hints, Optional, Union
+from typing import Callable, Any, List, Dict, Type, get_origin, get_type_hints, Optional, Union
 from fastapi import APIRouter, Depends, Header, HTTPException
 from pydantic import BaseModel
 
 from .models import Parameter, ParameterType, AuthRequirement
+from .logging import get_logger
 
-logger = logging.getLogger("opal_tools_sdk")
+logger = get_logger(__name__)
 
 def tool(name: str, description: str, auth_requirements: Optional[List[Dict[str, Any]]] = None):
     """Decorator to register a function as an Opal tool.
@@ -69,9 +70,9 @@ def tool(name: str, description: str, auth_requirements: Optional[List[Dict[str,
                     param_type = ParameterType.number
                 elif field_type == bool:
                     param_type = ParameterType.boolean
-                elif field_type == list or field_type == List:
+                elif get_origin(field_type) is list:
                     param_type = ParameterType.list
-                elif field_type == dict or field_type == Dict:
+                elif get_origin(field_type) is dict:
                     param_type = ParameterType.dictionary
 
                 # Determine if required
@@ -95,9 +96,9 @@ def tool(name: str, description: str, auth_requirements: Optional[List[Dict[str,
                     required=required
                 ))
 
-                print(f"Registered parameter: {field_name} of type {param_type.value}, required: {required}")
+                logger.info(f"Registered parameter: {field_name} of type {param_type.value}, required: {required}")
         else:
-            print(f"Warning: No parameter model found for {name}")
+            logger.warning(f"Warning: No parameter model found for {name}")
 
         endpoint = f"/tools/{name}"
 
@@ -112,10 +113,10 @@ def tool(name: str, description: str, auth_requirements: Optional[List[Dict[str,
                     required=auth_req.get("required", True)
                 ))
 
-        print(f"Registering tool {name} with endpoint {endpoint}")
+        logger.info(f"Registering tool {name} with endpoint {endpoint}")
 
         if not _registry.services:
-            print("No services registered in registry! Make sure to create ToolsService before decorating functions.")
+            logger.warning("No services registered in registry! Make sure to create ToolsService before decorating functions.")
 
         for service in _registry.services:
             service.register_tool(

opal_tools_sdk/logging.py

@@ -0,0 +1,37 @@
+import logging
+import sys
+from typing import Optional, Callable
+
+# Type alias for a logger factory function
+type LoggerFactory = Callable[[Optional[str]], logging.Logger]
+
+# Internal variable to hold a custom logger factory
+_custom_logger_factory: Optional[LoggerFactory] = None
+
+def register_logger_factory(factory: LoggerFactory):
+    """
+    Register a custom logger factory function. This function should accept a name (str or None)
+    and return a logger instance (e.g., structlog or standard logger).
+    """
+    global _custom_logger_factory
+    _custom_logger_factory = factory
+
+def get_logger(name: str = None) -> logging.Logger:
+    """
+    Returns a logger configured to output to the console, or uses a registered custom logger factory.
+    If no name is provided, uses the root logger.
+    """
+    if _custom_logger_factory is not None:
+        return _custom_logger_factory(name)
+    logger = logging.getLogger(name)
+    if not logger.handlers:
+        handler = logging.StreamHandler(sys.stdout)
+        formatter = logging.Formatter(
+            fmt='%(asctime)s %(levelname)s [%(name)s] %(message)s',
+            datefmt='%Y-%m-%d %H:%M:%S'
+        )
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+    logger.setLevel(logging.INFO)
+    logger.propagate = False
+    return logger

opal_tools_sdk/models.py

@@ -8,7 +8,7 @@ class ParameterType(str, Enum):
     integer = "integer"
     number = "number"
     boolean = "boolean"
-    list = "list"  # Changed to match main service expectation
+    list = "array"  # Changed to match main service expectation
     dictionary = "object"  # Standard JSON schema type
 
 @dataclass
@@ -18,7 +18,7 @@ class Parameter:
     param_type: ParameterType
     description: str
     required: bool
-    
+
     def to_dict(self) -> Dict[str, Any]:
         """Convert to dictionary for the discovery endpoint."""
         return {
@@ -34,7 +34,7 @@ class AuthRequirement:
     provider: str  # e.g., "google", "microsoft"
     scope_bundle: str  # e.g., "calendar", "drive"
     required: bool = True
-    
+
     def to_dict(self) -> Dict[str, Any]:
         """Convert to dictionary for the discovery endpoint."""
         return {
@@ -52,7 +52,7 @@ class Function:
     endpoint: str
     auth_requirements: Optional[List[AuthRequirement]] = None
     http_method: str = "POST"
-    
+
     def to_dict(self) -> Dict[str, Any]:
         """Convert to dictionary for the discovery endpoint."""
         result = {
@@ -62,8 +62,8 @@ class Function:
             "endpoint": self.endpoint,
             "http_method": self.http_method
         }
-        
+
         if self.auth_requirements:
             result["auth_requirements"] = [auth.to_dict() for auth in self.auth_requirements]
-            
+
         return result

opal_tools_sdk/service.py

@@ -8,7 +8,7 @@ from pydantic import BaseModel, create_model
 from .models import Function, Parameter, ParameterType, AuthRequirement
 from . import _registry
 
-logger = logging.getLogger("opal_tools_sdk")
+logger = logging.getLogger(__name__)
 
 class ToolsService:
     """Main class for managing Opal tools."""
@@ -91,7 +91,7 @@ class ToolsService:
             endpoint: API endpoint for the tool
             auth_requirements: List of authentication requirements (optional)
         """
-        print(f"Registering tool: {name} with endpoint: {endpoint}")
+        logger.info(f"Registering tool: {name} with endpoint: {endpoint}")
 
         # Extract auth requirements from handler if decorated with @requires_auth
         handler_auth_requirements = self._extract_auth_requirements(handler)
@@ -116,7 +116,7 @@ class ToolsService:
             try:
                 # Parse JSON body
                 body = await request.json()
-                print(f"Received request for {endpoint} with body: {body}")
+                logger.info(f"Received request for {endpoint} with body: {body}")
 
                 # Parameters should be in the "parameters" key according to the spec
                 # This matches how the tools-mgmt-service calls tools
@@ -124,20 +124,20 @@ class ToolsService:
                     params = body["parameters"]
                 else:
                     # For backward compatibility with direct test calls
-                    print(f"Warning: 'parameters' key not found in request body. Using body directly.")
+                    logger.warning(f"Warning: 'parameters' key not found in request body. Using body directly.")
                     params = body
 
                 # Extract auth data if available
                 auth_data = body.get("auth")
                 if auth_data:
-                    print(f"Auth data provided for provider: {auth_data.get('provider', 'unknown')}")
+                    logger.info(f"Auth data provided for provider: {auth_data.get('provider', 'unknown')}")
 
                 # Extract environment data if available
                 environment = body.get("environment", {})
                 if environment:
-                    print(f"Environment data provided: {environment}")
+                    logger.info(f"Environment data provided: {environment}")
 
-                print(f"Extracted parameters: {params}")
+                logger.info(f"Extracted parameters: {params}")
 
                 # Get the parameter model from handler's signature
                 sig = inspect.signature(handler)
@@ -166,12 +166,12 @@ class ToolsService:
 
                 result = await handler(*args, **kwargs)
 
-                print(f"Tool {name} returned: {result}")
+                logger.info(f"Tool {name} returned: {result}")
                 return result
             except Exception as e:
                 import traceback
-                print(f"Error in tool {name}: {str(e)}")
-                print(traceback.format_exc())
+                logger.error(f"Error in tool {name}: {str(e)}")
+                logger.error(traceback.format_exc())
                 raise HTTPException(status_code=500, detail=str(e))
 
         # Update the route function name and docstring

{optimizely_opal_opal_tools_sdk-0.1.2.dev0.dist-info → optimizely_opal_opal_tools_sdk-0.1.4.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.2.dev0
+Version: 0.1.4.dev0
 Summary: SDK for creating Opal-compatible tools services
 Home-page: https://github.com/optimizely/opal-tools-sdk
 Author: Optimizely

optimizely_opal_opal_tools_sdk-0.1.4.dev0.dist-info/RECORD

@@ -0,0 +1,11 @@
+opal_tools_sdk/__init__.py,sha256=riYZkv0C1Pgwd3SpE9Zwxs3a1eXa26wrGfY1N1Tdjb4,242
+opal_tools_sdk/_registry.py,sha256=YE3eD4kcS09QDe4RccBYAzXPo9znEU7fblrsB-g3o-Y,67
+opal_tools_sdk/auth.py,sha256=9aMiZv6n6_iu7hQA0sKg4hgNr5DzYFFuP0SWUoZf_Vw,1520
+opal_tools_sdk/decorators.py,sha256=iHal7RElOSCWjqKHIK-Hc4GKOsjuGyUg0_lsQKVQShg,5315
+opal_tools_sdk/logging.py,sha256=krvkhdql2GWh0aCWj5gfqyn5plsyLJ773WzIirK7tkU,1325
+opal_tools_sdk/models.py,sha256=lVumBjEWbKtkRBzwXt7m5uagqinJ6Y96K9a5Uw39yaM,2092
+opal_tools_sdk/service.py,sha256=wVYe40zEZc1ynIkvowD9APU8BFHQ5fdy3j8qlsdZB1U,6965
+optimizely_opal_opal_tools_sdk-0.1.4.dev0.dist-info/METADATA,sha256=3uy9B3LYQM6kJj-D_mtfrTYqCmpogXeKT-cMWE8IySU,4115
+optimizely_opal_opal_tools_sdk-0.1.4.dev0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+optimizely_opal_opal_tools_sdk-0.1.4.dev0.dist-info/top_level.txt,sha256=nCJ5PxF0rgoV6yNJvvuUaZPx4D3EWkl7gpu-6xafH1E,15
+optimizely_opal_opal_tools_sdk-0.1.4.dev0.dist-info/RECORD,,

optimizely_opal_opal_tools_sdk-0.1.2.dev0.dist-info/RECORD

@@ -1,10 +0,0 @@
-opal_tools_sdk/__init__.py,sha256=Eu141xM3QVq1O_BLGZS9m_asU1b_KaOApFtwvaYll6E,170
-opal_tools_sdk/_registry.py,sha256=YE3eD4kcS09QDe4RccBYAzXPo9znEU7fblrsB-g3o-Y,67
-opal_tools_sdk/auth.py,sha256=9aMiZv6n6_iu7hQA0sKg4hgNr5DzYFFuP0SWUoZf_Vw,1520
-opal_tools_sdk/decorators.py,sha256=uZ11AY5QUxhi61vfZ3iJTtFoXg-uA0cknx4EWTdDTCo,5276
-opal_tools_sdk/models.py,sha256=fa2hhnZ2GTz6xqhGTNyqyIQj_rBE1UFQxsJ4KfApCiU,2123
-opal_tools_sdk/service.py,sha256=KBqdBHYJ5wgxky0mSv0NJPbbzVhq4YSafgaTbsndTrE,6914
-optimizely_opal_opal_tools_sdk-0.1.2.dev0.dist-info/METADATA,sha256=M7L5-Pegr5M7UpvXKjLvOMQPz9nBjMTQScWkB7Waqs0,4115
-optimizely_opal_opal_tools_sdk-0.1.2.dev0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-optimizely_opal_opal_tools_sdk-0.1.2.dev0.dist-info/top_level.txt,sha256=nCJ5PxF0rgoV6yNJvvuUaZPx4D3EWkl7gpu-6xafH1E,15
-optimizely_opal_opal_tools_sdk-0.1.2.dev0.dist-info/RECORD,,