clerk-sdk 0.2.7__py3-none-any.whl → 0.3.0__py3-none-any.whl

clerk/decorator/task_decorator.py

@@ -1,7 +1,10 @@
 import os
 import pickle
+import traceback
 from typing import Callable, Optional
 from functools import wraps
+
+from clerk.exceptions.exceptions import ApplicationException
 from .models import ClerkCodePayload
 
 input_pkl: str = "/app/data/input/input.pkl"
@@ -35,7 +38,10 @@ def clerk_code():
                 if not isinstance(output, ClerkCodePayload):
                     raise TypeError("Function must return a ClerkCodePayload instance.")
             except Exception as e:
-                output = e
+                # parse no standard errors into the standard Application Error
+                output = ApplicationException(
+                    type=str(type(e)), message=str(e), traceback=traceback.format_exc()
+                )
 
             # 3. write to output.pkl
             try:

clerk/exceptions/exceptions.py

@@ -0,0 +1,13 @@
+from typing import Optional
+
+
+class AppBaseException(Exception):
+    def __init__(self, type_: str, message: str, traceback: Optional[str] = None):
+        super().__init__(message)
+        self.type = type_
+        self.message = message
+        self.traceback = traceback
+
+
+class ApplicationException(AppBaseException):
+    pass

clerk/exceptions/remote_device.py

@@ -0,0 +1,4 @@
+class RemoteDeviceAllocationError(Exception):
+    """Exception raised when there is an error allocating a remote device."""
+
+    pass

clerk/gui_automation/ui_actions/support.py

@@ -2,7 +2,7 @@ from datetime import timedelta, datetime
 import os
 import base64
 import time
-from typing import Optional
+from typing import List, Optional
 from backoff._typing import Details
 
 from clerk.models.ui_operator import TaskStatuses, UiOperatorTask
@@ -60,6 +60,47 @@ def save_screenshot(filename: str, sub_folder: Optional[str] = None) -> str:
     )
 
 
+def try_actions(actions: List[BaseAction]):
+    """
+    Executes a list of UI actions and handles any errors that occur.
+
+    This function takes a list of UI actions as input and executes them one by one.
+    If an action fails with a RuntimeError, it logs a warning message and moves on to the next action.
+    If all actions fail, it logs an error message and raises a RuntimeError.
+
+    Args:
+        actions (List[BaseAction]): A list of UI actions to be executed.
+
+    Raises:
+        TypeError: If any of the actions in the list is not an instance of BaseAction.
+        RuntimeError: If all actions fail.
+
+    Returns:
+        None
+
+    Example Usage:
+        actions = [action1, action2, action3]
+        try_actions(actions)
+    """
+    try:
+        assert all(isinstance(action, BaseAction) for action in actions)
+        for action in actions:
+            try:
+                action.do()
+                return
+            except RuntimeError as e:
+                logger.warning(
+                    f"The action {action} was not performed successfully.\nDetails: {str(e)}",
+                )
+        # all the actions have failed. log an error and raise a runtime error
+        logger.error("All actions have failed.")
+        raise RuntimeError("All actions have failed")
+    except AssertionError as e:
+        raise TypeError(
+            f"All actions must be valid. Encountered invalid action: {str(e)}"
+        )
+
+
 def _format_action_string(action: BaseAction) -> str:
     """
     Formats action in the same format as the one used in task modules.

clerk/utils/logger.py

@@ -79,11 +79,11 @@ def _log(level: str, message: str):
         _log_to_console("INFO", "module_name", "This is an info message")
 
     """
-    # Get run_id from environment variable or default to "unknown"
-    run_id = os.getenv("_RUN_ID", "unknown")
+    # Get artifact folder from environment variable or default to "unknown"
+    _artifacts_folder = os.getenv("_artifacts_folder", "unknown")
 
     # Create the base path for artifacts
-    logs_path = os.path.join(base_path, run_id)
+    logs_path = os.path.join(base_path, _artifacts_folder)
     os.makedirs(logs_path, exist_ok=True)
     # Define the log file path
     log_file_path = os.path.join(logs_path, "logs.txt")

clerk/utils/save_artifact.py

@@ -18,11 +18,11 @@ def save_artifact(
         str: The path to the saved artifact.
     """
 
-    # get the run ID from environment variable or default to "unknown"
-    run_id = os.getenv("_RUN_ID", "unknown")
+    # get the artifact folder from environment variable or default to "unknown"
+    _artifacts_folder = os.getenv("_artifacts_folder", "unknown")
 
     # create the base path for artifacts
-    base_path = os.path.join(os.getcwd(), "data", "artifacts", run_id)
+    base_path = os.path.join(os.getcwd(), "data", "artifacts", _artifacts_folder)
     if subfolder:
         base_path = os.path.join(base_path, subfolder)
 

{clerk_sdk-0.2.7.dist-info → clerk_sdk-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.2.7
+Version: 0.3.0
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group

{clerk_sdk-0.2.7.dist-info → clerk_sdk-0.3.0.dist-info}/RECORD

@@ -3,7 +3,10 @@ clerk/base.py,sha256=Ayb2zCQr8fqKZM_Qh3nVxVJOQkkYt-eD5VtpPXd1TLs,2669
 clerk/client.py,sha256=6nWWWjGB7a6FNUWsZRM-IoBb_mshRi6g5KX8meMiJ2E,576
 clerk/decorator/__init__.py,sha256=4VCGOFNq7pA7iJS410V_R9eWfjxP7mwxwa4thwaUTf8,39
 clerk/decorator/models.py,sha256=JWFOJuUh3F40iOL0aoNgUC9GRHU3Fcq3GOjSXA7Gwng,394
-clerk/decorator/task_decorator.py,sha256=srb8AC3tNj1RWC4iNkkwkUuG33B8TtxfTpOm1Oi373Y,2169
+clerk/decorator/task_decorator.py,sha256=RNFQBcRcvolAomAKw2XsSEA5C4W1Ttv_qSfwcmybJAM,2453
+clerk/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/exceptions/exceptions.py,sha256=pCG_KwJ8nwtfnljeqWXchd-qNgTeEfD8KQPXeUkN81A,331
+clerk/exceptions/remote_device.py,sha256=R0Vfmk8ejibEFeV29A8Vqst2YA6yxdqEX9lP5wWubgM,134
 clerk/gui_automation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/client.py,sha256=LqrUQtC-4pjUJYDDn_s3t073K066j_p0vf4kXLChBc0,4891
 clerk/gui_automation/action_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -23,7 +26,7 @@ clerk/gui_automation/exceptions/modality/exc.py,sha256=P-dMuCTyVZYD3pbGpCf_1SYEg
 clerk/gui_automation/ui_actions/__init__.py,sha256=-EDQ5375HXrvG3sfFY7zOPC405YcBL6xXRACm2p-YyI,23
 clerk/gui_automation/ui_actions/actions.py,sha256=hhxl5VMDNSXdqm2L0tZqs6IhJHVXtlSVSdwsiz2BbDI,27449
 clerk/gui_automation/ui_actions/base.py,sha256=4CjOkMZNLt8W0tLO91tOkz8CCea0m2IRBIOpWNMOZUA,7230
-clerk/gui_automation/ui_actions/support.py,sha256=83D-oVmZxD507kh9-8PsoXt5zD4o225TmkmS0Kh_8Zo,4330
+clerk/gui_automation/ui_actions/support.py,sha256=Ulb8DBfwnrBMaYoMLDgldEy9V--NDUSdhIYXpuODZoU,5772
 clerk/gui_automation/ui_state_inspector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/ui_state_inspector/gui_vision.py,sha256=lRnF3IMLViOB-UE447A4kc8BO7NKqqLV1NZKRswRKWg,7707
 clerk/gui_automation/ui_state_inspector/models.py,sha256=uuzYhE9is4Z-TmsVMA1mwf0mQGs_PDLqdSZKbe8dHSs,5691
@@ -41,10 +44,10 @@ clerk/models/remote_device.py,sha256=2jijS-9WWq7y6xIbAaDaPnzZo3-tjp2-dCQvNKP8YSU
 clerk/models/response_model.py,sha256=R62daUN1YVOwgnrh_epvFRsQcOwT7R4u97l73egvm-c,232
 clerk/models/ui_operator.py,sha256=mKTJUFZgv7PeEt5oys28HVZxHOJsofmRQOcRpqj0dbU,293
 clerk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/utils/logger.py,sha256=_jYOSEc1WCsY9DvU8cIWUPmz41QNjpHTEZ7WrUnmFPA,3650
-clerk/utils/save_artifact.py,sha256=Lwl3l3QqKnSFLFpfEEa-dJ-dV9OxvCU3ADkuYZ18U-Q,1117
-clerk_sdk-0.2.7.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.2.7.dist-info/METADATA,sha256=tNJBhP9i4zm0UyCCr-BBTdmrHH42QgA6IWX9YkY4ApU,3508
-clerk_sdk-0.2.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.2.7.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.2.7.dist-info/RECORD,,
+clerk/utils/logger.py,sha256=vHbp-lUK3W3c5fhyPsp05p9LGyDHj95v8XM_XQ_FlLc,3691
+clerk/utils/save_artifact.py,sha256=94aYkYNVGcSUaSWZmdjiY6Oc-3yCKb2XWCZ56IAXQqk,1158
+clerk_sdk-0.3.0.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.3.0.dist-info/METADATA,sha256=lNfPCGTunwV4EXk-uZiWLfPB2OlwPor_fwwkXA_5gs0,3508
+clerk_sdk-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.3.0.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.3.0.dist-info/RECORD,,