clerk-sdk 0.2.7__tar.gz → 0.3.0__tar.gz

{clerk_sdk-0.2.7/clerk_sdk.egg-info → clerk_sdk-0.3.0}/PKG-INFO

@@ -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 → clerk_sdk-0.3.0}/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_sdk-0.3.0/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_sdk-0.3.0/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_sdk-0.2.7 → clerk_sdk-0.3.0}/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_sdk-0.2.7 → clerk_sdk-0.3.0}/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_sdk-0.2.7 → clerk_sdk-0.3.0}/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 → clerk_sdk-0.3.0/clerk_sdk.egg-info}/PKG-INFO

@@ -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 → clerk_sdk-0.3.0}/clerk_sdk.egg-info/SOURCES.txt

@@ -10,6 +10,9 @@ clerk/client.py
 clerk/decorator/__init__.py
 clerk/decorator/models.py
 clerk/decorator/task_decorator.py
+clerk/exceptions/__init__.py
+clerk/exceptions/exceptions.py
+clerk/exceptions/remote_device.py
 clerk/gui_automation/__init__.py
 clerk/gui_automation/client.py
 clerk/gui_automation/requirements.txt

{clerk_sdk-0.2.7 → clerk_sdk-0.3.0}/setup.py

@@ -13,7 +13,7 @@ gui_requirements = get_requirements("./clerk/gui_automation")
 
 setup(
     name="clerk-sdk",
-    version="0.2.7",
+    version="0.3.0",
     description="Library for interacting with Clerk",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",