sapiopycommons 2025.10.10a779__py3-none-any.whl → 2025.10.15a782__py3-none-any.whl

sapiopycommons/ai/agent_service_base.py

@@ -908,7 +908,7 @@ class AgentBase(ABC):
         if len(matching_creds) > 1:
             raise ValueError(f"Multiple credentials found for category '{category}' and host '{host}'.")
 
-        return ExternalCredentials(matching_creds[0])
+        return ExternalCredentials.from_pbo(matching_creds[0])
 
     def call_subprocess(self,
                         args: str | bytes | PathLike[str] | PathLike[bytes] | Sequence[str | bytes | PathLike[str] | PathLike[bytes]],

sapiopycommons/ai/external_credentials.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from sapiopycommons.ai.protoapi.externalcredentials.external_credentials_pb2 import ExternalCredentialsPbo
 
 
@@ -5,26 +7,97 @@ class ExternalCredentials:
     """
     A class representing external credentials.
     """
-    id: str
-    display_name: str
-    description: str
-    category: str
-    url: str
-    username: str
-    password: str
-    token: str
-    custom_fields: dict[str, str]
-
-    def __init__(self, pbo: ExternalCredentialsPbo):
-        self.id = pbo.id
-        self.display_name = pbo.display_name
-        self.description = pbo.description
-        self.category = pbo.category
-        self.url = pbo.url
-        self.username = pbo.username
-        self.password = pbo.password
-        self.token = pbo.token
-        self.custom_fields = dict(pbo.custom_field)
+    _identifier: str
+    _display_name: str
+    _description: str
+    _category: str
+    _url: str
+    _username: str
+    _password: str
+    _token: str
+    _custom_fields: dict[str, str]
+
+    def __init__(self, url: str, category: str, identifier: str = "", display_name: str = "", description: str = "",
+                 username: str = "", password: str = "", token: str = "", custom_fields: dict[str, str] | None = None):
+        """
+        :param url: The URL that the credentials are for.
+        :param category: The category of the credentials. This can be used to search for the credentials using the
+            AgentBase.get_credentials function.
+        :param identifier: The unique identifier for the credentials.
+        :param display_name: The display name for the credentials.
+        :param description: A description of the credentials.
+        :param username: The username for the credentials.
+        :param password: The password for the credentials.
+        :param token: The token for the credentials.
+        :param custom_fields: A dictionary of custom fields associated with the credentials.
+        """
+        self._identifier = identifier
+        self._display_name = display_name
+        self._description = description
+        self._category = category
+        self._url = url
+        self._username = username
+        self._password = password
+        self._token = token
+        self._custom_fields = custom_fields or {}
+
+    @staticmethod
+    def from_pbo(pbo: ExternalCredentialsPbo) -> ExternalCredentials:
+        """
+        Create an ExternalCredentials instance from a protobuf object.
+
+        :param pbo: An ExternalCredentialsPbo object.
+        :return: An ExternalCredentials instance.
+        """
+        creds = ExternalCredentials(pbo.url, pbo.category)
+        creds._identifier = pbo.id
+        creds._display_name = pbo.display_name
+        creds._description = pbo.description
+        creds._username = pbo.username
+        creds._password = pbo.password
+        creds._token = pbo.token
+        creds._custom_fields = dict(pbo.custom_field)
+        return creds
+
+    @property
+    def identifier(self) -> str:
+        """The unique identifier for the credentials."""
+        return self._identifier
+
+    @property
+    def display_name(self) -> str:
+        """The display name for the credentials."""
+        return self._display_name
+
+    @property
+    def description(self) -> str:
+        """A description of the credentials."""
+        return self._description
+
+    @property
+    def category(self) -> str:
+        """The category of the credentials."""
+        return self._category
+
+    @property
+    def url(self) -> str:
+        """The URL that the credentials are for."""
+        return self._url
+
+    @property
+    def username(self) -> str:
+        """The username for the credentials."""
+        return self._username
+
+    @property
+    def password(self) -> str:
+        """The password for the credentials."""
+        return self._password
+
+    @property
+    def token(self) -> str:
+        """The token for the credentials."""
+        return self._token
 
     def get_custom_field(self, key: str, default: str = None) -> str | None:
         """
@@ -34,4 +107,22 @@ class ExternalCredentials:
         :param default: The value to return if the key does not exist.
         :return: The value of the custom field, or None if the key does not exist.
         """
-        return self.custom_fields.get(key, default)
+        return self._custom_fields.get(key, default)
+
+    def to_pbo(self) -> ExternalCredentialsPbo:
+        """
+        Convert the ExternalCredentials instance to a protobuf object.
+
+        :return: An ExternalCredentialsPbo object.
+        """
+        return ExternalCredentialsPbo(
+            id=self._identifier,
+            display_name=self._display_name,
+            description=self._description,
+            category=self._category,
+            url=self._url,
+            username=self._username,
+            password=self._password,
+            token=self._token,
+            custom_field=self._custom_fields
+        )

sapiopycommons/ai/test_client.py

@@ -1,11 +1,14 @@
 import base64
 import json
+import os
 from enum import Enum
 from typing import Any
 
 import grpc
 from sapiopylib.rest.User import SapioUser
 
+from sapiopycommons.ai.external_credentials import ExternalCredentials
+from sapiopycommons.ai.protoapi.externalcredentials.external_credentials_pb2 import ExternalCredentialsPbo
 from sapiopycommons.ai.protoapi.fielddefinitions.fields_pb2 import FieldValuePbo
 from sapiopycommons.ai.protoapi.plan.converter.converter_pb2 import ConverterDetailsRequestPbo, \
     ConverterDetailsResponsePbo, ConvertResponsePbo, ConvertRequestPbo
@@ -20,6 +23,7 @@ from sapiopycommons.ai.protoapi.plan.tool.tool_pb2_grpc import ToolServiceStub
 from sapiopycommons.ai.protoapi.session.sapio_conn_info_pb2 import SapioConnectionInfoPbo, SapioUserSecretTypePbo
 from sapiopycommons.ai.protobuf_utils import ProtobufUtils
 from sapiopycommons.general.aliases import FieldValue
+from sapiopycommons.general.time_util import TimeUtil
 
 
 class ContainerType(Enum):
@@ -63,39 +67,43 @@ class AgentOutput:
         self.new_records = []
         self.logs = []
 
-    def save_outputs(self, path: str = "test_outputs", file_extensions: list[str] | None = None) -> None:
+    def save_outputs(self, path: str = "test_outputs", subfolder: str | None = None,
+                     file_extensions: list[str] | None = None) -> None:
         """
-        Save all outputs to files in the specified directory. The files will be named according to the agent name
-        and the output type.
+        Save all outputs to files in the specified output directory.
 
         :param path: The directory to save the output files to.
+        :param subfolder: An optional subfolder within the path to save the output files to. Useful for when you are
+            calling the same agent multiple times for separate test cases.
         :param file_extensions: A list of file extensions to use for binary output files. The length of this list
             should match the number of binary outputs.
         """
         if not self:
             return
-        import os
-        os.makedirs(path, exist_ok=True)
-        if self.binary_output and (not file_extensions or len(file_extensions) != len(self.binary_output)):
+        output_path: str = os.path.join(path, self.agent_name)
+        if subfolder:
+            output_path = os.path.join(output_path, subfolder)
+        os.makedirs(output_path, exist_ok=True)
+        if self.binary_output and (file_extensions is None or len(file_extensions) != len(self.binary_output)):
             raise ValueError("File extensions must be provided for each binary output.")
         for i, output in enumerate(self.binary_output):
             ext: str = "." + file_extensions[i].lstrip(".")
             for j, entry in enumerate(output):
-                with open(os.path.join(path, self.agent_name, f"binary_output_{i}_{j}{ext}"), "wb") as f:
+                with open(os.path.join(output_path, f"binary_output_{i}_{j}{ext}"), "wb") as f:
                     f.write(entry)
         for i, output in enumerate(self.csv_output):
-            with open(os.path.join(path, self.agent_name, f"csv_output_{i}.csv"), "w", encoding="utf-8") as f:
+            with open(os.path.join(output_path, f"csv_output_{i}.csv"), "w", encoding="utf-8") as f:
                 headers = output[0].keys()
                 f.write(",".join(headers) + "\n")
                 for row in output:
                     f.write(",".join(f'"{str(row[h])}"' for h in headers) + "\n")
         for i, output in enumerate(self.json_output):
             for j, entry in enumerate(output):
-                with open(os.path.join(path, self.agent_name, f"json_output_{i}_{j}.json"), "w", encoding="utf-8") as f:
+                with open(os.path.join(output_path, f"json_output_{i}_{j}.json"), "w", encoding="utf-8") as f:
                     json.dump(entry, f, indent=2)
         for i, output in enumerate(self.text_output):
             for j, entry in enumerate(output):
-                with open(os.path.join(path, self.agent_name, f"text_output_{i}_{j}.txt"), "w", encoding="utf-8") as f:
+                with open(os.path.join(output_path, f"text_output_{i}_{j}.txt"), "w", encoding="utf-8") as f:
                     f.write(entry)
 
     def __bool__(self):
@@ -163,6 +171,7 @@ class TestClient:
     connection: SapioConnectionInfoPbo
     _request_inputs: list[StepItemContainerPbo]
     _config_fields: dict[str, FieldValuePbo]
+    _credentials: list[ExternalCredentialsPbo]
 
     def __init__(self, grpc_server_url: str, message_mb_size: int = 1024, user: SapioUser | None = None,
                  options: list[tuple[str, Any]] | None = None):
@@ -183,6 +192,7 @@ class TestClient:
         self._create_connection(user)
         self._request_inputs = []
         self._config_fields = {}
+        self._credentials = []
 
     def _create_connection(self, user: SapioUser | None = None):
         """
@@ -267,10 +277,28 @@ class TestClient:
         """
         self._config_fields.clear()
 
+    def add_credentials(self, credentials: list[ExternalCredentials]) -> None:
+        """
+        Add external credentials to the connection info for the next request.
+
+        :param credentials: A list of ExternalCredentialsPbo objects to add to the connection info.
+        """
+        for cred in credentials:
+            self._credentials.append(cred.to_pbo())
+
+    def clear_credentials(self) -> None:
+        """
+        Clear all external credentials that have been added to the next request.
+        This is useful if you want to start a new request without the previous credentials.
+        """
+        self._credentials.clear()
+
     def clear_request(self) -> None:
         """
         Clear all inputs and configuration fields that have been added to the next request.
         This is useful if you want to start a new request without the previous inputs and configurations.
+
+        Credentials are not cleared, as they may be reused across multiple requests.
         """
         self.clear_inputs()
         self.clear_configs()
@@ -314,9 +342,11 @@ class TestClient:
         :param is_dry_run: If True, the agent will not be executed, but the request will be validated.
         :return: An AgentOutput object containing the results of the agent service call.
         """
+        print(f"Calling agent \"{agent_name}\"...")
         with grpc.insecure_channel(self.grpc_server_url, options=self.options) as channel:
             stub = ToolServiceStub(channel)
 
+            start = TimeUtil.now_in_millis()
             response: ProcessStepResponsePbo = stub.ProcessData(
                 ProcessStepRequestPbo(
                     sapio_user=self.connection,
@@ -324,12 +354,15 @@ class TestClient:
                     config_field_values=self._config_fields,
                     dry_run=is_dry_run,
                     verbose_logging=is_verbose,
+                    external_credential=self._credentials,
                     input=[
                         StepInputBatchPbo(is_partial=False, item_container=item)
                         for item in self._request_inputs
                     ]
                 )
             )
+            end = TimeUtil.now_in_millis()
+            print(f"Agent call completed in {(end - start) / 1000.:.3f} seconds")
 
             results = AgentOutput(agent_name)
 

{sapiopycommons-2025.10.10a779.dist-info → sapiopycommons-2025.10.15a782.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sapiopycommons
-Version: 2025.10.10a779
+Version: 2025.10.15a782
 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.10.10a779.dist-info → sapiopycommons-2025.10.15a782.dist-info}/RECORD

@@ -1,12 +1,12 @@
 sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sapiopycommons/ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/ai/agent_service_base.py,sha256=UF5mSCXMxX0qUtEUWRtQ6_690aOo6pCRB89dyj8Amug,56292
+sapiopycommons/ai/agent_service_base.py,sha256=LVZg_4Kw5WTcIB7ru5hEqJoMWQr2eTDYjMrX8pzpn9I,56301
 sapiopycommons/ai/converter_service_base.py,sha256=HiUXmwqv1STgyQeF9_eTFXzjIFXp5-NJ7sEhMpV3aAU,6351
-sapiopycommons/ai/external_credentials.py,sha256=40AI7VtHf6PzvwJLR_mZemUCrfAUvC--tGH-npaDIgo,1163
+sapiopycommons/ai/external_credentials.py,sha256=ki_xIH4J843b_sSwEa8YHr8vW9erVv-jowZJXSgPQs8,4347
 sapiopycommons/ai/protobuf_utils.py,sha256=cBjbxoFAwU02kNUxEce95WnMU2CMuDD-qFaeWgvQJMQ,24599
 sapiopycommons/ai/request_validation.py,sha256=TD2EUi_G5cy1OOVK1AmY2SQc3PEoAKGWs2pT8Qnp2Oo,25092
 sapiopycommons/ai/server.py,sha256=gutSskn_Fenq1uz0DDMvjx4QVFiKt2WVEP3-01a69eU,6384
-sapiopycommons/ai/test_client.py,sha256=jHIKaBy2jta2UCcci6z0dvX_BZZuiV_0z2HPr9dEI_s,18897
+sapiopycommons/ai/test_client.py,sha256=IRZ-8prhg7XMDmN9aC1MQr5mSkMgfT37aLsOy-VB-MU,20495
 sapiopycommons/ai/protoapi/externalcredentials/external_credentials_pb2.py,sha256=mEonoj6Iq-AyvO4m3YsPYu85aZfD1E0a0cL8B9yPfEo,2481
 sapiopycommons/ai/protoapi/externalcredentials/external_credentials_pb2.pyi,sha256=sfExq8fFwIwFxCpV50ytdxW5ePNBjJBr_80_trq_JQw,1658
 sapiopycommons/ai/protoapi/externalcredentials/external_credentials_pb2_grpc.py,sha256=TNS1CB_QGBSa1YU9sYR_hF-pmBwv2GpxjaNQoM_r9iU,948
@@ -106,7 +106,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.10.10a779.dist-info/METADATA,sha256=5rW00M6gy8crugEHSZZCOCNdoe-Bi8gbVBwfOqoNk0U,3143
-sapiopycommons-2025.10.10a779.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-sapiopycommons-2025.10.10a779.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2025.10.10a779.dist-info/RECORD,,
+sapiopycommons-2025.10.15a782.dist-info/METADATA,sha256=DIeUTx52EZpA1ZIecBFRA4_LsTMKBwOZLzB6i2iBgxs,3143
+sapiopycommons-2025.10.15a782.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+sapiopycommons-2025.10.15a782.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
+sapiopycommons-2025.10.15a782.dist-info/RECORD,,