zrb 0.17.0__tar.gz → 0.17.2__tar.gz

{zrb-0.17.0 → zrb-0.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.17.0
+Version: 0.17.2
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later

{zrb-0.17.0 → zrb-0.17.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "0.17.0"
+version = "0.17.2"
 description = "A Framework to Enhance Your Workflow"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/builtin/devtool/install/helix/helix.py

@@ -29,7 +29,6 @@ install_helix = FlowTask(
                 run=write_config(
                     template_file=os.path.join(
                         _CURRENT_DIR,
-                        "helix",
                         "resource",
                         "themes",
                         "gruvbox_transparent.toml",  # noqa
@@ -41,9 +40,7 @@ install_helix = FlowTask(
             Task(
                 name="configure-helix",
                 run=write_config(
-                    template_file=os.path.join(
-                        _CURRENT_DIR, "helix", "resource", "config.toml"
-                    ),
+                    template_file=os.path.join(_CURRENT_DIR, "resource", "config.toml"),
                     config_file="~/.config/helix/config.toml",
                     remove_old_config=True,
                 ),

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/any_task.py

@@ -25,14 +25,12 @@ TAnyTask = TypeVar("TAnyTask", bound="AnyTask")
 
 class AnyTask(ABC):
     """
-    Abstract base class for defining tasks in a task management system.
+    Contract/interface for all Zrb Task.
 
-    This class acts as a template for creating new task types. To define a new task,
-    extend this class and implement all its abstract methods. The `AnyTask` class is
-    considered atomic and is not broken into multiple interfaces.
+    This class acts as a template for creating new Zrb Task types.
 
-    Subclasses should implement the abstract methods to define custom behavior for
-    task execution, state transitions, and other functionalities.
+    To define a new Zrb Task, you should extend this class and implement all its methods.
+    The easiest way to do so is by extending `Task`
     """
 
     @abstractmethod
@@ -74,7 +72,7 @@ class AnyTask(ABC):
         Examples:
             >>> from zrb import Task
             >>> class MyTask(Task):
-            >>>     async def run(self, *args: Any, **kwargs: Any) -> int:
+            >>>     def run(self, *args: Any, **kwargs: Any) -> int:
             >>>         self.print_out('Doing some calculation')
             >>>         return 42
         """
@@ -88,8 +86,7 @@ class AnyTask(ABC):
         Any other tasks depends on the current task, will be `started` once the current task is `ready`.
 
         This method should be implemented to define the criteria for considering the task
-        `ready`. The specifics of this completion depend on the task's
-        nature and the subclass implementation.
+        `ready`. The specifics of this completion depend on the task's nature and the subclass implementation.
 
         Returns:
             bool: True if the task is completed, False otherwise.

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/base_task/base_task.py

@@ -72,10 +72,10 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     ):
         # init properties
         retry_interval = retry_interval if retry_interval >= 0 else 0
-        checking_interval = checking_interval if checking_interval > 0 else 0.1
+        checking_interval = checking_interval if checking_interval > 0 else 0.05
         retry = retry if retry >= 0 else 0
         # init parent classes
-        FinishTracker.__init__(self)
+        FinishTracker.__init__(self, checking_interval=checking_interval)
         Renderer.__init__(self)
         AttemptTracker.__init__(self, retry=retry)
         BaseTaskModel.__init__(
@@ -233,7 +233,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             await run_async(self._on_retry, self)
 
     async def check(self) -> bool:
-        return await self._is_done()
+        return await run_async(self._is_done)
 
     def inject_envs(self):
         super().inject_envs()
@@ -315,7 +315,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         if self.__is_check_triggered:
             self.log_debug("Waiting readiness flag to be set")
             while not self.__is_ready:
-                await asyncio.sleep(0.1)
+                await asyncio.sleep(self._checking_interval)
             return True
         self.__is_check_triggered = True
         check_result = await self._check()
@@ -336,7 +336,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         self.log_debug("Waiting execution to be started")
         while not self.__is_execution_started:
             # Don't start checking before the execution itself has been started
-            await asyncio.sleep(0.05)
+            await asyncio.sleep(self._checking_interval / 2.0)
         check_coroutines: Iterable[asyncio.Task] = []
         for checker_task in self._get_checkers():
             checker_task._set_execution_id(self.get_execution_id())

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/base_task/component/trackers.py

@@ -2,7 +2,7 @@ import asyncio
 import time
 
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Optional
+from zrb.helper.typing import Optional, Union
 
 LOG_NAME_LENGTH = 20
 
@@ -51,9 +51,10 @@ class AttemptTracker:
 
 @typechecked
 class FinishTracker:
-    def __init__(self):
+    def __init__(self, checking_interval: Union[float, int]):
         self.__execution_queue: Optional[asyncio.Queue] = None
         self.__counter = 0
+        self.__checking_interval = checking_interval
 
     async def _mark_awaited(self):
         if self.__execution_queue is None:
@@ -69,5 +70,5 @@ class FinishTracker:
 
     async def _is_done(self) -> bool:
         while self.__execution_queue is None:
-            await asyncio.sleep(0.05)
+            await asyncio.sleep(self.__checking_interval / 2.0)
         return await self.__execution_queue.get()

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/checker.py

@@ -44,7 +44,7 @@ class Checker(BaseTask):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0.1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 30,
         expected_result: bool = True,
         should_execute: Union[bool, str, Callable[..., bool]] = True,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/decorator.py

@@ -43,9 +43,9 @@ def python_task(
     on_retry: Optional[OnRetry] = None,
     on_failed: Optional[OnFailed] = None,
     checkers: Iterable[AnyTask] = [],
-    checking_interval: float = 0.1,
+    checking_interval: Union[float, int] = 0,
     retry: int = 2,
-    retry_interval: float = 1,
+    retry_interval: Union[float, int] = 1,
     should_execute: Union[bool, str, Callable[..., bool]] = True,
     return_upstream_result: bool = False,
     runner: Optional[Runner] = None,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/docker_compose_task.py

@@ -115,9 +115,9 @@ class DockerComposeTask(CmdTask):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         checkers: Iterable[AnyTask] = [],
-        checking_interval: float = 0.1,
+        checking_interval: Union[float, int] = 0,
         retry: int = 2,
-        retry_interval: float = 1,
+        retry_interval: Union[float, int] = 1,
         max_output_line: int = 1000,
         max_error_line: int = 1000,
         preexec_fn: Optional[Callable[[], Any]] = os.setsid,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/http_checker.py

@@ -87,7 +87,7 @@ class HTTPChecker(Checker):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0.1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 5,
         expected_result: bool = True,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/looper.py

@@ -32,8 +32,11 @@ class Looper:
                 if result is not None:
                     if not result:
                         continue
+                    while len(self._queue[identifier]) > 1000:
+                        self._queue[identifier].pop(0)
                     self._queue[identifier].append(result)
             except KeyboardInterrupt:
+                self.stop()
                 break
 
 

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/path_checker.py

@@ -56,7 +56,7 @@ class PathChecker(Checker):
         on_failed: Optional[OnFailed] = None,
         path: JinjaTemplate = "",
         ignored_path: Union[JinjaTemplate, Iterable[JinjaTemplate]] = [],
-        checking_interval: Union[int, float] = 0.1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 5,
         expected_result: bool = True,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/path_watcher.py

@@ -72,7 +72,7 @@ class PathWatcher(Watcher):
         on_failed: Optional[OnFailed] = None,
         path: JinjaTemplate = "",
         ignored_path: Union[JinjaTemplate, Iterable[JinjaTemplate]] = [],
-        checking_interval: Union[int, float] = 0.1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 30,
         watch_new_files: bool = True,
         watch_modified_files: bool = True,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/port_checker.py

@@ -66,7 +66,7 @@ class PortChecker(Checker):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0.1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 5,
         expected_result: bool = True,
         should_execute: Union[bool, str, Callable[..., bool]] = True,

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/server.py

@@ -86,6 +86,7 @@ class Controller:
         task = self._get_task()
 
         async def fn() -> Any:
+            task.print_out_dark(f"Starting controller: {self._name}")
             task_fn = task.to_function(is_async=True)
             return await task_fn(*self._args, **self._kwargs)
 

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/time_watcher.py

@@ -68,7 +68,7 @@ class TimeWatcher(Watcher):
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
         schedule: JinjaTemplate = "",
-        checking_interval: Union[int, float] = 1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 30,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,
     ):
@@ -128,7 +128,7 @@ class TimeWatcher(Watcher):
 
     def create_loop_inspector(self) -> Callable[..., Optional[bool]]:
         async def loop_inspect() -> bool:
-            await asyncio.sleep(0.1)
+            await asyncio.sleep(self._checking_interval)
             label = f"Watching {self._rendered_schedule}"
             identifier = self.get_identifier()
             scheduled_time = self.__scheduled_times[identifier]
@@ -148,7 +148,7 @@ class TimeWatcher(Watcher):
         return cron.get_next(datetime.datetime)
 
     def _get_cron(self) -> Any:
-        margin = datetime.timedelta(seconds=0.001)
+        margin = datetime.timedelta(seconds=self._checking_interval / 2.0)
         slightly_before_now = datetime.datetime.now() - margin
         cron = croniter.croniter(self._rendered_schedule, slightly_before_now)
         return cron

{zrb-0.17.0 → zrb-0.17.2}/src/zrb/task/watcher.py

@@ -48,7 +48,7 @@ class Watcher(Checker):
         on_ready: Optional[OnReady] = None,
         on_retry: Optional[OnRetry] = None,
         on_failed: Optional[OnFailed] = None,
-        checking_interval: Union[int, float] = 0.1,
+        checking_interval: Union[int, float] = 0,
         progress_interval: Union[int, float] = 30,
         expected_result: bool = True,
         should_execute: Union[bool, str, Callable[..., bool]] = True,