sapiopycommons 2025.9.8a728__py3-none-any.whl → 2025.9.8a731__py3-none-any.whl

sapiopycommons/ai/server.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import asyncio
+from argparse import ArgumentParser
 from typing import Any
 
 import grpc
@@ -16,12 +19,30 @@ class SapioGrpcServer:
     """
     port: int
     options: list[tuple[str, Any]]
+    debug_mode: bool
     _converter_services: list[ConverterServiceServicer]
     _script_services: list[ScriptServiceServicer]
     _tool_services: list[ToolServiceServicer]
 
-    def __init__(self, port: int = 50051, message_mb_size: int = 1024, options: list[tuple[str, Any]] | None = None) \
-            -> None:
+    @staticmethod
+    def args_parser() -> ArgumentParser:
+        """
+        Create an argument parser for the gRPC server.
+
+        :return: The argument parser.
+        """
+        parser = ArgumentParser()
+        parser.add_argument("--debug_mode", "-d", action="store_true")
+        parser.add_argument("--port", "-p", default=50051, type=int)
+        parser.add_argument("--message_mb_size", "-s", default=1024, type=int)
+        return parser
+
+    @staticmethod
+    def from_args(options: list[tuple[str, Any]] | None = None) -> SapioGrpcServer:
+        return SapioGrpcServer(options=options, **vars(SapioGrpcServer.args_parser().parse_args()))
+
+    def __init__(self, port: int = 50051, message_mb_size: int = 1024, debug_mode: bool = False,
+                 options: list[tuple[str, Any]] | None = None) -> None:
         """
         Initialize the gRPC server with the specified port and message size.
 
@@ -29,6 +50,7 @@ class SapioGrpcServer:
         :param message_mb_size: The maximum size of a message in megabytes.
         :param options: Additional gRPC server options to set. This should be a list of tuples where the first item is
             the option name and the second item is the option value.
+        :param debug_mode: Sets the debug mode for services.
         """
         if isinstance(port, str):
             port = int(port)
@@ -39,6 +61,9 @@ class SapioGrpcServer:
         ]
         if options:
             self.options.extend(options)
+        self.debug_mode = debug_mode
+        if debug_mode:
+            print("Debug mode is enabled.")
         self._converter_services = []
         self._script_services = []
         self._tool_services = []
@@ -65,6 +90,7 @@ class SapioGrpcServer:
 
         :param service: The tool service to register with the server.
         """
+        service.debug_mode = self.debug_mode
         self._tool_services.append(service)
 
     def start(self) -> None:

sapiopycommons/ai/tool_service_base.py

@@ -217,6 +217,8 @@ class ToolServiceBase(ToolServiceServicer, ABC):
     A base class for implementing a tool service. Subclasses should implement the register_tools method to register
     their tools with the service.
     """
+    debug_mode: bool = False
+
     def GetToolDetails(self, request: ToolDetailsRequestPbo, context: ServicerContext) -> ToolDetailsResponsePbo:
         try:
             # Get the tool details from the registered tools.
@@ -327,7 +329,7 @@ class ToolServiceBase(ToolServiceServicer, ABC):
         tool: ToolBase = registered_tools[find_tool]()
         try:
             # Setup the tool with details from the request.
-            tool.setup(user, request, context)
+            tool.setup(user, request, context, self.debug_mode)
             # Validate that the provided inputs match the tool's expected inputs.
             if len(request.input) != len(tool.input_configs):
                 msg: str = (f"Expected {len(tool.input_configs)} inputs for this tool, but got {len(request.input)} "
@@ -350,8 +352,16 @@ class ToolServiceBase(ToolServiceServicer, ABC):
             tool.log_exception("Exception occurred during tool execution.", e)
             return False, str(e), [], tool.logs
         finally:
-            # Clean up any temporary files created by the tool.
-            tool.temp_data.cleanup()
+            # Clean up any temporary files created by the tool. If in debug mode, then log the files instead
+            # so that they can be manually inspected.
+            if self.debug_mode:
+                print("Temporary files/directories created during tool execution:")
+                for directory in tool.temp_data.directories:
+                    print(f"\tDirectory: {directory}")
+                for file in tool.temp_data.files:
+                    print(f"\tFile: {file}")
+            else:
+                tool.temp_data.cleanup()
 
 
 class ToolBase(ABC):
@@ -370,6 +380,7 @@ class ToolBase(ABC):
     logs: list[str]
     logger: Logger
     verbose_logging: bool
+    debug_mode: bool
 
     temp_data: TempFileHandler
 
@@ -415,7 +426,7 @@ class ToolBase(ABC):
         self.logger = logging.getLogger(f"ToolBase.{self._name}")
         ensure_logger_initialized(self.logger)
 
-    def setup(self, user: SapioUser, request: ProcessStepRequestPbo, context: ServicerContext) -> None:
+    def setup(self, user: SapioUser, request: ProcessStepRequestPbo, context: ServicerContext, debug_mode: bool) -> None:
         """
         Setup the tool with the user, request, and context. This method can be overridden by subclasses to perform
         additional setup.
@@ -424,11 +435,14 @@ class ToolBase(ABC):
             system.
         :param request: The request object containing the input data.
         :param context: The gRPC context.
+        :param debug_mode: If true, the tool should run in debug mode, providing additional logging and not cleaning
+            up temporary files.
         """
         self.user = user
         self.request = request
         self.context = context
         self.verbose_logging = request.verbose_logging
+        self.debug_mode = debug_mode
 
     def add_input(self, container_type: ContainerType, content_type: str, display_name: str, description: str,
                   structure_example: str | bytes | None = None, validation: str | None = None,

{sapiopycommons-2025.9.8a728.dist-info → sapiopycommons-2025.9.8a731.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.9.8a728
+Version: 2025.9.8a731
 Summary: Official Sapio Python API Utilities Package
 Project-URL: Homepage, https://github.com/sapiosciences
 Author-email: Jonathan Steck <jsteck@sapiosciences.com>, Yechen Qiao <yqiao@sapiosciences.com>

{sapiopycommons-2025.9.8a728.dist-info → sapiopycommons-2025.9.8a731.dist-info}/RECORD

@@ -2,9 +2,9 @@ sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/converter_service_base.py,sha256=TMSyEekbbqMk9dRuAtLlSJ1sA1H8KpyCDlSOeqGFMWI,5115
 sapiopycommons/ai/protobuf_utils.py,sha256=cBjbxoFAwU02kNUxEce95WnMU2CMuDD-qFaeWgvQJMQ,24599
-sapiopycommons/ai/server.py,sha256=jvmAcs4y8qp0d483wCAUgPlSBSoUUQvCjv_OvQXEGUs,4274
+sapiopycommons/ai/server.py,sha256=jy81xjtt7uCY3sHG9iL_-0dy8st5J4fWSZ5Pwq3L1_s,5262
 sapiopycommons/ai/test_client.py,sha256=iPhn7cvKNLmDAXrjpmIkZpW2pDWlUhJZHDLHJbEoWsg,15673
-sapiopycommons/ai/tool_service_base.py,sha256=AVW6Yf0l_l4x__dosIZyAJun4UmZAZaBJRYzNru_fD4,45806
+sapiopycommons/ai/tool_service_base.py,sha256=s6NJaOLUN3Ewkn1yoByKqHn7jn40yopD0ohySnKaOB0,46526
 sapiopycommons/ai/protoapi/fielddefinitions/fields_pb2.py,sha256=8tKXwLXcqFGdQHHSEBSi6Fd7dcaCFoOqmhjzqhenb_M,2372
 sapiopycommons/ai/protoapi/fielddefinitions/fields_pb2.pyi,sha256=FwtXmNAf7iYGEFm4kbqb04v77jNHbZg18ZmEDhle_bU,1444
 sapiopycommons/ai/protoapi/fielddefinitions/fields_pb2_grpc.py,sha256=uO25bcnfGqXpP4ggUur54Nr73Wj-DGWftExzLNcxdHI,931
@@ -99,7 +99,7 @@ sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 sapiopycommons/webhook/webhook_context.py,sha256=D793uLsb1691SalaPnBUk3rOSxn_hYLhdvkaIxjNXss,1909
 sapiopycommons/webhook/webhook_handlers.py,sha256=7o_wXOruhT9auNh8OfhJAh4WhhiPKij67FMBSpGPICc,39939
 sapiopycommons/webhook/webservice_handlers.py,sha256=cvW6Mk_110BzYqkbk63Kg7jWrltBCDALOlkJRu8h4VQ,14300
-sapiopycommons-2025.9.8a728.dist-info/METADATA,sha256=6IMqQ6KDSTEcXMpbfbwpBSC_eGnhn-336JCdZkvNmR0,3142
-sapiopycommons-2025.9.8a728.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.9.8a728.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.9.8a728.dist-info/RECORD,,
+sapiopycommons-2025.9.8a731.dist-info/METADATA,sha256=pe2sML9LAOWEXV-Hd8RtSS9VgCoorYA-aVG7_a9_f1Y,3142
+sapiopycommons-2025.9.8a731.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.9.8a731.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.9.8a731.dist-info/RECORD,,