clerk-sdk 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

clerk/gui_automation/client.py

@@ -3,6 +3,7 @@ from typing import Dict, List, Optional
 from pydantic import BaseModel
 from clerk.base import BaseClerk
 from clerk.gui_automation.action_model.model import Coords
+from clerk.gui_automation.exceptions.agent_manager import NoClientsAvailable
 from clerk.gui_automation.ui_state_inspector.models import (
     ActionString,
     BaseState,
@@ -22,6 +23,9 @@ class RPAClerk(BaseClerk):
             endpoint=endpoint, json={"group_name": group_name, "run_id": run_id}
         )
 
+        if res.data[0] is None:
+            raise NoClientsAvailable()
+
         return RemoteDevice(**res.data[0])
 
     def deallocate_remote_device(

clerk/gui_automation/client_actor/client_actor.py

@@ -68,9 +68,7 @@ async def _get_screen_async() -> str:
     payload = {
         "proc_inst_id": os.getenv("PROC_ID"),
         "client_name": os.getenv("REMOTE_DEVICE_NAME"),
-        "headless": (
-            True if os.getenv("HEADLESS", "True").lower() == "true" else False
-        ),
+        "headless": True,
         "action": {"action_type": "screenshot"},
     }
     try:

clerk/gui_automation/decorators/gui_automation.py

@@ -1,15 +1,20 @@
 import asyncio
 import functools
-import logging
 import os
+import time
 from typing import Callable, Union
 
 from websockets.asyncio.client import connect, ClientConnection
 from websockets.protocol import State
 
 from clerk.gui_automation.client import RPAClerk
+from clerk.gui_automation.exceptions.agent_manager import (
+    ClientAvailabilityTimeout,
+    NoClientsAvailable,
+)
 from clerk.models.remote_device import RemoteDevice
 from clerk.decorator.models import ClerkCodePayload
+from clerk.utils import logger
 from ..exceptions.websocket import WebSocketConnectionFailed
 
 
@@ -19,22 +24,43 @@ global_ws: Union[ClientConnection, None] = None
 clerk_client = RPAClerk()
 wss_uri = "wss://agent-manager.f-one.group/action"
 
+CLIENT_TIMEOUT_MINS = 1
+MAX_CLIENT_AVAILABILITY_RETRIES = 60
+
 
 def _allocate_remote_device(
     clerk_client: RPAClerk, group_name: str, run_id: str
 ) -> RemoteDevice:
-    remote_device = clerk_client.allocate_remote_device(
-        group_name=group_name, run_id=run_id
-    )
-    os.environ["REMOTE_DEVICE_ID"] = remote_device.id
-    os.environ["REMOTE_DEVICE_NAME"] = remote_device.name
-    return remote_device
+    remote_device = None
+    retries = 0
+
+    while True:
+        try:
+            remote_device = clerk_client.allocate_remote_device(
+                group_name=group_name, run_id=run_id
+            )
+            os.environ["REMOTE_DEVICE_ID"] = remote_device.id
+            os.environ["REMOTE_DEVICE_NAME"] = remote_device.name
+            logger.debug(f"Remote device allocated: {remote_device.name}")
+            return remote_device
+
+        except NoClientsAvailable:
+            logger.warning(
+                f"No clients are available for {group_name} group. Initiating a {CLIENT_TIMEOUT_MINS} minute wait. Retry count: {retries}"
+            )
+            retries += 1
+            if retries == MAX_CLIENT_AVAILABILITY_RETRIES:
+                raise ClientAvailabilityTimeout(
+                    f"No clients available for {group_name} group after {CLIENT_TIMEOUT_MINS*MAX_CLIENT_AVAILABILITY_RETRIES} minutes"
+                )
+            time.sleep(CLIENT_TIMEOUT_MINS * 60)
 
 
 def _deallocate_target(
     clerk_client: RPAClerk, remote_device: RemoteDevice, run_id: str
 ):
     clerk_client.deallocate_remote_device(remote_device=remote_device, run_id=run_id)
+    logger.debug("Remote device deallocated")
     os.environ.pop("REMOTE_DEVICE_ID", None)
     os.environ.pop("REMOTE_DEVICE_NAME", None)
 
@@ -82,7 +108,7 @@ def gui_automation():
                 global_ws = event_loop.run_until_complete(task)
 
                 if global_ws and global_ws.state is State.OPEN:
-                    logging.debug("WebSocket connection established.")
+                    logger.debug("WebSocket connection established.")
                     func_ret = func(payload, *args, **kwargs)
                 else:
                     global_ws = None
@@ -97,7 +123,7 @@ def gui_automation():
                 if global_ws and global_ws.state is State.OPEN:
                     close_task = event_loop.create_task(close_ws_connection(global_ws))
                     event_loop.run_until_complete(close_task)
-                    print("WebSocket connection closed.")
+                    logger.debug("WebSocket connection closed.")
 
                 event_loop.run_until_complete(event_loop.shutdown_asyncgens())
                 event_loop.close()

clerk/gui_automation/exceptions/agent_manager.py

@@ -0,0 +1,6 @@
+class NoClientsAvailable(Exception):
+    pass
+
+
+class ClientAvailabilityTimeout(Exception):
+    pass

clerk/gui_automation/ui_actions/support.py

@@ -1,4 +1,5 @@
 import os
+import base64
 from typing import Optional
 from backoff._typing import Details
 
@@ -48,7 +49,7 @@ def save_screenshot(filename: str, sub_folder: Optional[str] = None) -> str:
     screen_b64: str = get_screen()
     return save_artifact(
         filename=filename,
-        file_bytes=screen_b64.encode("utf-8"),
+        file_bytes=base64.b64decode(screen_b64),
         subfolder=sub_folder,
     )
 

clerk/utils/logger.py

@@ -4,7 +4,7 @@ import logging
 import sys
 
 if sys.platform == "win32":
-    base_path = os.path.join(os.getcwd(), "data", "output", "artifacts")
+    base_path = os.path.join(os.getcwd(), "data", "artifacts")
 else:
     base_path = "/app/data/artifacts"
 
@@ -100,7 +100,13 @@ def _log(level: str, message: str):
         formatter = logging.Formatter(format)
         fh.setFormatter(formatter)
         logger.addHandler(fh)
+        # → console handler  (same formatter)
+        sh = logging.StreamHandler(sys.stdout)
+        sh.setFormatter(formatter)
+        logger.addHandler(sh)
+
     logger.setLevel(logging.DEBUG)
+    logger.propagate = False  # keep root logger from printing duplicates
 
     # Log the message based on the level
     if level.lower() == "info":

clerk/utils/save_artifact.py

@@ -1,5 +1,6 @@
 import os
 from typing import Optional
+from clerk.utils import logger
 
 
 def save_artifact(
@@ -32,4 +33,5 @@ def save_artifact(
     with open(file_path, "wb") as f:
         f.write(file_bytes)
 
+    logger.debug(f"Artifact successfully saved at: {file_path}")
     return file_path

{clerk_sdk-0.2.0.dist-info → clerk_sdk-0.2.2.dist-info}/METADATA

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

{clerk_sdk-0.2.0.dist-info → clerk_sdk-0.2.2.dist-info}/RECORD

@@ -5,24 +5,25 @@ clerk/decorator/__init__.py,sha256=4VCGOFNq7pA7iJS410V_R9eWfjxP7mwxwa4thwaUTf8,3
 clerk/decorator/models.py,sha256=JWFOJuUh3F40iOL0aoNgUC9GRHU3Fcq3GOjSXA7Gwng,394
 clerk/decorator/task_decorator.py,sha256=srb8AC3tNj1RWC4iNkkwkUuG33B8TtxfTpOm1Oi373Y,2169
 clerk/gui_automation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/gui_automation/client.py,sha256=FFK1xXGEvz3ZuUnmgvibhDIvdrOcBpa6pG-Z1cqzhKc,4256
+clerk/gui_automation/client.py,sha256=LJFHdWreH0pZnRUZJ6jd4Xp3kYJjOjNLEUfHD0ly2Y0,4405
 clerk/gui_automation/action_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/gui_automation/action_model/model.py,sha256=sbTySgOq4Xv_r2p7q_ji1bGCHgRS1HXC9Z39thwCQ9c,3829
 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=5hQ2KPLnXueUu6tOq-w44dDm3_Lxx4nA_mMnAZmqfVY,5167
+clerk/gui_automation/client_actor/client_actor.py,sha256=Me3NHc0nMA7Y5CUcnE0ZHT1P7dQRGR6duCAKwn0Tg6g,5081
 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
-clerk/gui_automation/decorators/gui_automation.py,sha256=AUDawosvwTXpIT0jLKzrgVUG0Fqu_Qs_AhAm3zgRfIo,3706
+clerk/gui_automation/decorators/gui_automation.py,sha256=C7s1HekmLiXvw3I7O3oCrrTAAlxb_w3PA7YAILGhSLc,4711
 clerk/gui_automation/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clerk/gui_automation/exceptions/agent_manager.py,sha256=KFWFWQ7X_8Z9XG__SMzb1jKI3yNoVTPJAXzW5O-fSXc,101
 clerk/gui_automation/exceptions/websocket.py,sha256=-MdwSwlf1hbnu55aDgk3L1znkTZ6xJS6po5VpEGD9ck,117
 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/base.py,sha256=4CjOkMZNLt8W0tLO91tOkz8CCea0m2IRBIOpWNMOZUA,7230
-clerk/gui_automation/ui_actions/support.py,sha256=oPu_xNOQb6i83pSDQ9if14Jh-noT2q0o-Rl3y5DrHLE,2160
+clerk/gui_automation/ui_actions/support.py,sha256=BS9QReyP_F9-oGPt0fuy5BD9kC9-E5mOE05Zk0M1Hzw,2176
 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
@@ -39,10 +40,10 @@ clerk/models/file.py,sha256=7n6bV6ukRA-uh7MFxUx_TEMNpVAdNe5O0nKIeneCQhg,459
 clerk/models/remote_device.py,sha256=2jijS-9WWq7y6xIbAaDaPnzZo3-tjp2-dCQvNKP8YSU,109
 clerk/models/response_model.py,sha256=R62daUN1YVOwgnrh_epvFRsQcOwT7R4u97l73egvm-c,232
 clerk/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clerk/utils/logger.py,sha256=OxpWOo7IMBajp6rwkZH8-7E9VxRNzJNfxC8fDFClDVo,3425
-clerk/utils/save_artifact.py,sha256=Y4lxcGKxr-5tKdY66Z4BghI4p0Vk4LtEBNsh6Nh01zc,1021
-clerk_sdk-0.2.0.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.2.0.dist-info/METADATA,sha256=9p4HdIoMfDoXlQX6rT0e624wqy2bGxAlhS1PJ0L02fQ,3508
-clerk_sdk-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.2.0.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.2.0.dist-info/RECORD,,
+clerk/utils/logger.py,sha256=_jYOSEc1WCsY9DvU8cIWUPmz41QNjpHTEZ7WrUnmFPA,3650
+clerk/utils/save_artifact.py,sha256=Lwl3l3QqKnSFLFpfEEa-dJ-dV9OxvCU3ADkuYZ18U-Q,1117
+clerk_sdk-0.2.2.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.2.2.dist-info/METADATA,sha256=8VZysSvY_q_eoLR6DQ7MetvLforSTw82vDUbGTAXfJI,3508
+clerk_sdk-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.2.2.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.2.2.dist-info/RECORD,,