clerk-sdk 0.4.9__py3-none-any.whl → 0.4.11__py3-none-any.whl

clerk/__init__.py

@@ -1,4 +1,4 @@
 from .client import Clerk
 
 
-__version__ = "0.4.6"
+__version__ = "0.4.11"

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/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/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/gui_automation/ui_state_machine/ai_recovery.py

@@ -2,9 +2,8 @@ from typing import Union, List, Optional, Type
 from pydantic import BaseModel, Field
 
 from clerk.gui_automation.client import CourseCorrectorClerk
-
-from ..client_actor.client_actor import get_screen
-from .models import ActionString
+from clerk.gui_automation.client_actor.client_actor import get_screen
+from clerk.gui_automation.ui_state_inspector.models import ActionString
 
 
 class CourseCorrector(BaseModel):

clerk/gui_automation/ui_state_machine/state_machine.py

@@ -8,9 +8,18 @@ from typing import List, Tuple, Callable, Optional, Deque, Literal, Union
 import traceback
 from datetime import datetime
 
-from ..ui_actions.actions import ForceCloseApplication
-from ..ui_actions.support import save_screenshot
-from .exceptions import (
+from clerk.client import Clerk
+from clerk.utils import logger
+from clerk.gui_automation.client_actor.exception import PerformActionException
+from clerk.gui_automation.ui_actions.actions import ForceCloseApplication
+from clerk.gui_automation.ui_actions.support import save_screenshot
+from clerk.gui_automation.ui_state_inspector.gui_vision import Vision
+from clerk.gui_automation.ui_state_inspector.models import ActionString
+from clerk.gui_automation.ui_state_machine.ai_recovery import (
+    CourseCorrector,
+    course_corrector_v1,
+)
+from clerk.gui_automation.ui_state_machine.exceptions import (
     BusinessException,
     ScreenPilotException,
     UnplannedTransitionsError,
@@ -21,12 +30,6 @@ from .exceptions import (
     CourseCorrectionImpossible,
     SuccessfulCompletion,
 )
-from ..ui_state_machine.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
-from ...client import Clerk
-from ...utils import logger
 
 
 class ScreenPilot:

{clerk_sdk-0.4.9.dist-info → clerk_sdk-0.4.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.4.9
+Version: 0.4.11
 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.dist-info → clerk_sdk-0.4.11.dist-info}/RECORD

@@ -1,4 +1,4 @@
-clerk/__init__.py,sha256=ubAUuMPlxiWOVmwL7aMXdRDmiXjmyqibfKLX5ZcLZR4,50
+clerk/__init__.py,sha256=-JHAzWtOyJr_JOTN5rh2mXi9sFVo3gAoaL_kzY7_KKA,51
 clerk/base.py,sha256=S1RKc2pBw2FPlVjefJzsNtyTDPB0UG46C2K_QVV1opA,4008
 clerk/client.py,sha256=RdOvC23WK9ZtIXDOYaoSFk9debh3UTmstBXjAswAH6E,4981
 clerk/decorator/__init__.py,sha256=yGGcS17VsZ7cZ-hVGCm3I3vGDJMiJIAqmDGzriIi0DI,65
@@ -13,7 +13,7 @@ clerk/gui_automation/action_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 clerk/gui_automation/action_model/model.py,sha256=yzaCyEMOH3YMkPBf6IwUMuu69-xyf78HzmthiewgWQY,3811
 clerk/gui_automation/action_model/utils.py,sha256=xzFxgN-bTK6HKGS7J-esQZ-ePj_yG72T-2ZVhcWvKjw,798
 clerk/gui_automation/client_actor/__init__.py,sha256=SVuL6-oo1Xc0oJkjMKrO6mJwpPGjrCLKhDV6r2Abtf8,66
-clerk/gui_automation/client_actor/client_actor.py,sha256=RT5WnvrM37pLpoDd_WZg8sSjBuugqMW_eDLTEkL7kWc,5117
+clerk/gui_automation/client_actor/client_actor.py,sha256=GFUwUR0QsvuFjRulzETIXLPxBGOX255L1XUUSG15WAY,5117
 clerk/gui_automation/client_actor/exception.py,sha256=zdnImHZ88yf52Xq3aMHivEU3aJg-r2c-r8x8XZnI3ic,407
 clerk/gui_automation/client_actor/model.py,sha256=wVpFCi1w2kh4kAV8oNx489vf_SLUQnqhc02rFD5NIJA,6335
 clerk/gui_automation/decorators/__init__.py,sha256=OCgXStEumscgT-RyVy5OKS7ml1w9y-lEnjCVnxuRnQs,43
@@ -24,18 +24,17 @@ clerk/gui_automation/exceptions/websocket.py,sha256=-MdwSwlf1hbnu55aDgk3L1znkTZ6
 clerk/gui_automation/exceptions/modality/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/exceptions/modality/exc.py,sha256=P-dMuCTyVZYD3pbGpCf_1SYEgaETn13c51pmfbsXr5k,1436
 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/actions.py,sha256=r_gVnAOGfv7XZyli8b8ru0nsMqn_JiTAMTNvgVf8T1I,28789
 clerk/gui_automation/ui_actions/base.py,sha256=oaUI3vIOoDwP_HdLu2GIG46-aMv0_Zv-PljMgSFeNmk,7329
 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=Pk5nuFZnp_zNbqSOtndSmgqb6PLeADJfnC-eRIJMDZk,7736
-clerk/gui_automation/ui_state_inspector/models.py,sha256=cXFKmdTPt3m78NQ7sqGllJU0gLSfZuXd0cM0GFuD490,5542
+clerk/gui_automation/ui_state_inspector/models.py,sha256=qEbdrWGglOJH8QaOKoYp8ZKQMjnGk4JufpgYuTWoQ10,6082
 clerk/gui_automation/ui_state_machine/__init__.py,sha256=bTPZsPJkDLCwP2mdtBj4fU7C7ekOh0b-VPRKFEV3bPo,301
-clerk/gui_automation/ui_state_machine/ai_recovery.py,sha256=3_Gu_RPxta4eXmXWH3WA31c15sJL-dk1m1H2bOFV7so,3772
+clerk/gui_automation/ui_state_machine/ai_recovery.py,sha256=jAx8DehN5ue3zIroZwOADf_QyiTzFPij_5N57pJg6Us,3829
 clerk/gui_automation/ui_state_machine/decorators.py,sha256=gBOpIusjsXlA7FEiszDCFKTS6vXx3LBNMz_SQJNkMWg,2134
 clerk/gui_automation/ui_state_machine/exceptions.py,sha256=9KWg20dnCssMdMu632E0nP5vkndgYNI4cDCDW-vMkQA,1436
-clerk/gui_automation/ui_state_machine/models.py,sha256=oNmfHtjqgRkUAxPnQ8R5-IR-K_FCeg3NU6aqjVSnThI,1407
-clerk/gui_automation/ui_state_machine/state_machine.py,sha256=u2wJqu5WxmZHkzlIHTgK_icZUw3yv9nNuZkh9IaqmXI,35622
+clerk/gui_automation/ui_state_machine/state_machine.py,sha256=BNBQpxutWldR8hBBnVZ1u1xhwf5MWT2vL5d12bxzsUU,35812
 clerk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/models/document.py,sha256=SdHLuX01yQ1std-o25Wso5sq7HQznV7-SN8azVzyczQ,3036
 clerk/models/document_statuses.py,sha256=67EMwh7FUNEOkb563mO5WtckK1EICY-sk9pRhD-BYK4,347
@@ -46,8 +45,8 @@ clerk/models/ui_operator.py,sha256=mKTJUFZgv7PeEt5oys28HVZxHOJsofmRQOcRpqj0dbU,2
 clerk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/utils/logger.py,sha256=NrMIlJfVmRjjRw_N_Jngkl0qqv7btXUbg5wxcRmFEH4,3800
 clerk/utils/save_artifact.py,sha256=94aYkYNVGcSUaSWZmdjiY6Oc-3yCKb2XWCZ56IAXQqk,1158
-clerk_sdk-0.4.9.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.4.9.dist-info/METADATA,sha256=feCbtDLlu-sYMn7P2ti5kqvQjBDuZ8g6sc4I948wcjo,9936
-clerk_sdk-0.4.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.4.9.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.4.9.dist-info/RECORD,,
+clerk_sdk-0.4.11.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.4.11.dist-info/METADATA,sha256=rIzbkJ6lW7rpGkhsdzUN2Jtpx_WzlRbJ8-hkLAW_Gmk,9937
+clerk_sdk-0.4.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.4.11.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.4.11.dist-info/RECORD,,

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