sapiopycommons 2025.7.21a630__py3-none-any.whl → 2025.7.22a637__py3-none-any.whl

sapiopycommons/ai/test_client.py

@@ -1,7 +1,9 @@
+import base64
 import json
 from typing import Mapping, Any
 
 import grpc
+from sapiopylib.rest.User import SapioUser
 
 from sapiopycommons.ai.api.fielddefinitions.proto.fields_pb2 import FieldValuePbo
 from sapiopycommons.ai.api.plan.tool.proto.entry_pb2 import DataTypePbo, StepBinaryContainerPbo, StepCsvRowPbo, \
@@ -77,35 +79,41 @@ class TestClient:
     A client for testing a ToolService. This client can be used to send requests to a tool and receive
     responses.
     """
-    server_url: str
+    grpc_server_url: str
     connection: SapioConnectionInfoPbo
     _request_inputs: list[Any]
     _config_fields: dict[str, Any]
 
-    def __init__(self, server_url: str):
+    def __init__(self, grpc_server_url: str, user: SapioUser | None = None):
         """
-        :param server_url: The URL of the gRPC server to connect to.
+        :param grpc_server_url: The URL of the gRPC server to connect to.
+        :param user: Optional SapioUser object to use for the connection. If not provided, a default connection
+            will be created with test credentials.
         """
-        self.create_user()
-        self.server_url = server_url
+        self.grpc_server_url = grpc_server_url
+        self._create_connection(user)
         self._request_inputs = []
         self._config_fields = {}
 
-    def create_user(self):
+    def _create_connection(self, user: SapioUser | None = None):
         """
         Create a SapioConnectionInfoPbo object with test credentials. This method can be overridden to
         create a user with specific credentials for testing.
         """
         self.connection = SapioConnectionInfoPbo()
-        self.connection.username = "Testing"
-        self.connection.webservice_url = "https://localhost:8080/webservice/api"
-        self.connection.app_guid = "1234567890"
-        self.connection.secret_type = SapioUserSecretTypePbo.PASSWORD
+        self.connection.username = user.username if user else "Testing"
+        self.connection.webservice_url = user.url if user else "https://localhost:8080/webservice/api"
+        self.connection.app_guid = user.guid if user else "1234567890"
         self.connection.rmi_host.append("Testing")
         self.connection.rmi_port = 9001
-        self.connection.secret = "password"
-
-    def add_input_input(self, input_data: list[bytes]) -> None:
+        if user and user.password:
+            self.connection.secret_type = SapioUserSecretTypePbo.PASSWORD
+            self.connection.secret = "Basic " + base64.b64encode(f'{user.username}:{user.password}'.encode()).decode()
+        else:
+            self.connection.secret_type = SapioUserSecretTypePbo.API_TOKEN
+            self.connection.secret = user.api_token if user and user.api_token else "test_api_token"
+
+    def add_binary_input(self, input_data: list[bytes]) -> None:
         """
         Add a binary input to the the next request.
         """
@@ -203,7 +211,7 @@ class TestClient:
 
         :return: A ToolDetailsResponsePbo object containing the details of the tool service.
         """
-        with grpc.insecure_channel(self.server_url) as channel:
+        with grpc.insecure_channel(self.grpc_server_url) as channel:
             stub = ToolServiceStub(channel)
             return stub.GetToolDetails(ToolDetailsRequestPbo(sapio_conn_info=self.connection))
 
@@ -215,7 +223,7 @@ class TestClient:
         :param tool_name: The name of the tool to call on the server.
         :return: A ToolOutput object containing the results of the tool service call.
         """
-        with grpc.insecure_channel(self.server_url) as channel:
+        with grpc.insecure_channel(self.grpc_server_url) as channel:
             stub = ToolServiceStub(channel)
 
             response: ProcessStepResponsePbo = stub.ProcessData(

sapiopycommons/ai/tool_service_base.py

@@ -278,9 +278,6 @@ class ToolServiceBase(ToolServiceServicer, ABC):
         """
         return: Get instances of the tools registered with this service.
         """
-        # This is complaining about the name and description not being filled from ToolBase,
-        # but none of the provided tools should have any init parameters.
-        # noinspection PyArgumentList
         tools: list[ToolBase] = [x() for x in self.register_tools()]
         if not tools:
             raise Exception("No tools registered with this service.")
@@ -348,16 +345,35 @@ class ToolBase(ABC):
     request: ProcessStepRequestPbo
     context: ServicerContext
 
-    def __init__(self, name: str, description: str, data_type_name: str | None = None):
+    @staticmethod
+    @abstractmethod
+    def name() -> str:
+        """
+        :return: The name of the tool. This should be unique across all tools in the service.
+        """
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def description() -> str:
         """
-        :param name: The name of the tool.
-        :param description: A description of the tool.
-        :param data_type_name: The name of the output data type of this tool, if applicable. When this tool returns
+        :return: A description of the tool.
+        """
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def data_type_name() -> str | None:
+        """
+        :return: The name of the output data type of this tool, if applicable. When this tool returns
             FieldMapResult objects in its run method, this name will be used to set the data type of the output data.
         """
-        self.name = name
-        self.description = description
-        self.data_type_name = data_type_name
+        return None
+
+    def __init__(self):
+        self.name = self.name()
+        self.description = self.description()
+        self.data_type_name = self.data_type_name()
         self.inputs = []
         self.outputs = []
         self.configs = []

{sapiopycommons-2025.7.21a630.dist-info → sapiopycommons-2025.7.22a637.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.7.21a630
+Version: 2025.7.22a637
 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.7.21a630.dist-info → sapiopycommons-2025.7.22a637.dist-info}/RECORD

@@ -1,8 +1,8 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/protobuf_utils.py,sha256=8VYGhAdD731Ojy5PTy61PlTcvfEdydkIdX-4rOFPtxM,24911
-sapiopycommons/ai/test_client.py,sha256=PCc5s_-Uo8_CVsB1rpwvHtvXfHKa2iuZnC7VK-9cAoE,10457
-sapiopycommons/ai/tool_service_base.py,sha256=ezNXOEPN3-4_FFiDDJ80hBLj3ZhC_xsQKPZZHAhp4uQ,41802
+sapiopycommons/ai/test_client.py,sha256=C8yr4Zp4vflRxufD2oUD45PVmQnfra5hi6flKJ230Tg,11169
+sapiopycommons/ai/tool_service_base.py,sha256=r_QJHcN1z1umzet9av7N66Mk5tIVaWPfEHDQzveYzwc,41884
 sapiopycommons/ai/api/fielddefinitions/proto/fields_pb2.py,sha256=YcZjb_YM-XeLErM8hEC_S7vGMVGvcXAMGs2b-u5zvOE,2377
 sapiopycommons/ai/api/fielddefinitions/proto/fields_pb2.pyi,sha256=FwtXmNAf7iYGEFm4kbqb04v77jNHbZg18ZmEDhle_bU,1444
 sapiopycommons/ai/api/fielddefinitions/proto/fields_pb2_grpc.py,sha256=wPImJPdCUZNVEVoUWzsba9kGIXjEKPdUkawP5SnVyiU,932
@@ -90,7 +90,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=tyaYGG1-v_JJrJHZ6cy5mGCxX9z1foLw7pM4MDJlFxs,14297
-sapiopycommons-2025.7.21a630.dist-info/METADATA,sha256=UXQiQOApr9tU_aSyBOZ1U6dpWeB3jNwvl7WjBWFp2VE,3143
-sapiopycommons-2025.7.21a630.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.7.21a630.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.7.21a630.dist-info/RECORD,,
+sapiopycommons-2025.7.22a637.dist-info/METADATA,sha256=5XWnDlnBTpUOuqdFcZWfLf2Hcsvo3XBqsX0TbWvCAIY,3143
+sapiopycommons-2025.7.22a637.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.7.22a637.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.7.22a637.dist-info/RECORD,,