clerk-sdk 0.4.9__tar.gz → 0.4.10__tar.gz

{clerk_sdk-0.4.9/clerk_sdk.egg-info → clerk_sdk-0.4.10}/PKG-INFO

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

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10}/clerk/gui_automation/client_actor/client_actor.py

@@ -42,9 +42,9 @@ async def _perform_action_ws(payload: Dict[str, Any]) -> PerformActionResponse:
 
         # 2. wait for ack message
         try:
-            ack = await asyncio.wait_for(global_ws.recv(), 90)
+            ack = await asyncio.wait_for(global_ws.recv(), 10)
             if ack == "OK":
-                action_info = await asyncio.wait_for(global_ws.recv(), 90)
+                action_info = await asyncio.wait_for(global_ws.recv(), 10)
                 return PerformActionResponse(**json.loads(action_info))
             else:
                 raise RuntimeError("Received ACK != OK")

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10}/clerk/gui_automation/ui_actions/actions.py

@@ -24,7 +24,7 @@ from ..client_actor.model import (
 from ..client_actor.exception import GetScreenError
 from ..exceptions.modality.exc import ModalityNotKnownError
 
-MAX_TIME = 5
+MAX_TRIES = 3
 
 
 class File(BaseModel):
@@ -80,7 +80,7 @@ class LeftClick(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )
@@ -123,7 +123,7 @@ class RightClick(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )
@@ -166,7 +166,7 @@ class MiddleClickAction(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )
@@ -209,7 +209,7 @@ class DoubleClick(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )
@@ -256,7 +256,7 @@ class Scroll(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )
@@ -306,6 +306,13 @@ class SendKeys(BaseAction):
             )
         return self
 
+    @backoff.on_exception(
+        backoff.expo,
+        (RuntimeError, GetScreenError),
+        max_tries=MAX_TRIES,
+        on_giveup=maybe_engage_operator_ui_action,
+        raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
+    )
     def do(self):
         payload: Screenshot
         try:
@@ -356,6 +363,13 @@ class PressKeys(BaseAction):
     action_type: ActionTypes = "press_keys"
     keys: str
 
+    @backoff.on_exception(
+        backoff.expo,
+        (RuntimeError, GetScreenError),
+        max_tries=MAX_TRIES,
+        on_giveup=maybe_engage_operator_ui_action,
+        raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
+    )
     def do(self):
         # provide widget + screen to the action model via http request
         execute_payload = ExecutePayload(
@@ -484,6 +498,13 @@ class ForceCloseApplication(BaseAction):
         description="Process name from task manager. Example: process.exe"
     )
 
+    @backoff.on_exception(
+        backoff.expo,
+        (RuntimeError, GetScreenError),
+        max_tries=MAX_TRIES,
+        on_giveup=maybe_engage_operator_ui_action,
+        raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
+    )
     def do(self):
         payload = ApplicationExecutePayload(
             action_type=self.action_type,
@@ -531,6 +552,13 @@ class SaveFiles(BaseAction):
                 files_details.append(file)
         return files_details
 
+    @backoff.on_exception(
+        backoff.expo,
+        (RuntimeError, GetScreenError),
+        max_tries=MAX_TRIES,
+        on_giveup=maybe_engage_operator_ui_action,
+        raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
+    )
     def do(self):
         payload = SaveFilesExecutePayload(
             action_type=self.action_type,
@@ -558,6 +586,13 @@ class DeleteFiles(BaseAction):
     action_type: ActionTypes = "delete_files"
     files_location: List[str]
 
+    @backoff.on_exception(
+        backoff.expo,
+        (RuntimeError, GetScreenError),
+        max_tries=MAX_TRIES,
+        on_giveup=maybe_engage_operator_ui_action,
+        raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
+    )
     def do(self):
         payload = DeleteFilesExecutePayload(
             action_type=self.action_type, files_location=self.files_location
@@ -714,7 +749,7 @@ class GetText(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )
@@ -759,7 +794,7 @@ class PasteText(BaseAction):
     @backoff.on_exception(
         backoff.expo,
         (RuntimeError, GetScreenError),
-        max_time=MAX_TIME,
+        max_tries=MAX_TRIES,
         on_giveup=maybe_engage_operator_ui_action,
         raise_on_giveup=False,  # Exception might be raised in the giveup handler instead
     )

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10}/clerk/gui_automation/ui_state_inspector/models.py

@@ -161,7 +161,9 @@ class ActionString(BaseModel):
 
     Attributes:
         action_string (str): The string representation of the action.
-        comment (str, optional): An optional comment or description for the action.
+        action_comment (str, optional): An optional comment about the action.
+        observation (str, optional): An optional observation related to the action.
+        interrupt_process (bool, optional): A flag indicating whether the action should interrupt the process.
 
     Methods:
         ensure_format(v: str) -> str:
@@ -170,7 +172,9 @@ class ActionString(BaseModel):
     """
 
     action_string: str
-    comment: Optional[str] = None
+    action_comment: Optional[str] = None
+    observation: Optional[str] = None
+    interrupt_process: Optional[bool] = False
 
     @field_validator("action_string", mode="before")
     @classmethod
@@ -180,3 +184,11 @@ class ActionString(BaseModel):
         if not v.endswith(".do()") and not v.startswith("NoAction"):
             raise ValueError("Action string must end with '.do()'")
         return v
+
+    @field_validator("interrupt_process", mode="before")
+    def convert_to_bool(cls, v: str | bool | None):
+        if v is None:
+            return False
+        elif isinstance(v, str):
+            return v.lower() in ["true", "1", "yes"]
+        return v

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10}/clerk/gui_automation/ui_state_machine/state_machine.py

@@ -21,7 +21,7 @@ from .exceptions import (
     CourseCorrectionImpossible,
     SuccessfulCompletion,
 )
-from ..ui_state_machine.models import ActionString
+from gui_automation.ui_state_inspector.models import ActionString
 from .ai_recovery import CourseCorrector, course_corrector_v1
 from ..client_actor.exception import PerformActionException
 from ..ui_state_inspector.gui_vision import Vision

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10/clerk_sdk.egg-info}/PKG-INFO

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

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10}/clerk_sdk.egg-info/SOURCES.txt

@@ -41,7 +41,6 @@ clerk/gui_automation/ui_state_machine/__init__.py
 clerk/gui_automation/ui_state_machine/ai_recovery.py
 clerk/gui_automation/ui_state_machine/decorators.py
 clerk/gui_automation/ui_state_machine/exceptions.py
-clerk/gui_automation/ui_state_machine/models.py
 clerk/gui_automation/ui_state_machine/state_machine.py
 clerk/models/__init__.py
 clerk/models/document.py

{clerk_sdk-0.4.9 → clerk_sdk-0.4.10}/setup.py

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

clerk_sdk-0.4.9/clerk/gui_automation/ui_state_machine/models.py

@@ -1,40 +0,0 @@
-from typing import Any, Optional
-from pydantic import BaseModel, field_validator
-
-
-class ActionString(BaseModel):
-    """
-    ActionString class represents a string that represents an action in an application.
-
-    Attributes:
-        action_string (str): The string representation of the action.
-        comment (str, optional): An optional comment or description for the action.
-        interrupt_process (bool, optional): A flag indicating whether the action should interrupt the process.
-
-    Methods:
-        ensure_format(v: str) -> str:
-            Validator function that ensures the action string has the correct format.
-
-    """
-
-    action_string: str
-    action_comment: Optional[str] = None
-    observation: Optional[str] = None
-    interrupt_process: Optional[bool] = False
-
-    @field_validator("action_string", mode="before")
-    @classmethod
-    def ensure_format(cls, v: Any):
-        if not isinstance(v, str):
-            raise ValueError("Action string must be a string")
-        if not v.endswith(".do()") and not v.startswith("NoAction"):
-            raise ValueError("Action string must end with '.do()'")
-        return v
-
-    @field_validator("interrupt_process", mode="before")
-    def convert_to_bool(cls, v: str | bool | None):
-        if v is None:
-            return False
-        elif isinstance(v, str):
-            return v.lower() in ["true", "1", "yes"]
-        return v