zrb 0.15.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

zrb/task/time_watcher.py

@@ -1,13 +1,17 @@
+import asyncio
 import datetime
 
 import croniter
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import (
     Any,
     Callable,
     Iterable,
     JinjaTemplate,
+    Mapping,
     Optional,
     TypeVar,
     Union,
@@ -22,17 +26,19 @@ from zrb.task.any_task_event_handler import (
     OnTriggered,
     OnWaiting,
 )
-from zrb.task.checker import Checker
+from zrb.task.watcher import Watcher
 from zrb.task_env.env import Env
 from zrb.task_env.env_file import EnvFile
 from zrb.task_group.group import Group
 from zrb.task_input.any_input import AnyInput
 
+logger.debug(colored("Loading zrb.task.time_watcher", attrs=["dark"]))
+
 TTimeWatcher = TypeVar("TTimeWatcher", bound="TimeWatcher")
 
 
 @typechecked
-class TimeWatcher(Checker):
+class TimeWatcher(Watcher):
     """
     TimeWatcher will wait for any changes specified on  path.
 
@@ -40,6 +46,8 @@ class TimeWatcher(Checker):
     and <task-name>.scheduled-time xcom will be set.
     """
 
+    __scheduled_times: Mapping[str, Mapping[str, datetime.datetime]] = {}
+
     def __init__(
         self,
         name: str = "watch-path",
@@ -64,7 +72,7 @@ class TimeWatcher(Checker):
         progress_interval: Union[int, float] = 30,
         should_execute: Union[bool, JinjaTemplate, Callable[..., bool]] = True,
     ):
-        Checker.__init__(
+        Watcher.__init__(
             self,
             name=name,
             group=group,
@@ -88,7 +96,6 @@ class TimeWatcher(Checker):
             should_execute=should_execute,
         )
         self._schedule = schedule
-        self._scheduled_time: Optional[datetime.datetime] = None
         self._rendered_schedule: str = ""
 
     def copy(self) -> TTimeWatcher:
@@ -100,23 +107,48 @@ class TimeWatcher(Checker):
         raise_error: bool = True,
         is_async: bool = False,
         show_done_info: bool = True,
+        should_clear_xcom: bool = False,
+        should_stop_looper: bool = False,
     ) -> Callable[..., bool]:
-        return super().to_function(env_prefix, raise_error, is_async, show_done_info)
+        return super().to_function(
+            env_prefix=env_prefix,
+            raise_error=raise_error,
+            is_async=is_async,
+            show_done_info=show_done_info,
+            should_clear_xcom=should_clear_xcom,
+            should_stop_looper=should_stop_looper,
+        )
 
     async def run(self, *args: Any, **kwargs: Any) -> bool:
         self._rendered_schedule = self.render_str(self._schedule)
-        margin = datetime.timedelta(seconds=0.001)
-        slightly_before_check_time = datetime.datetime.now() - margin
-        cron = croniter.croniter(self._rendered_schedule, slightly_before_check_time)
-        self._scheduled_time = cron.get_next(datetime.datetime)
-        self.set_task_xcom(key="scheduled-time", value=self._scheduled_time)
+        identifier = self.get_identifier()
+        if identifier not in self.__scheduled_times:
+            self.__scheduled_times[identifier] = self._get_next_schedule_time()
         return await super().run(*args, **kwargs)
 
-    async def inspect(self, *args: Any, **kwargs: Any) -> bool:
-        label = f"Watching {self._rendered_schedule}"
-        now = datetime.datetime.now()
-        if now > self._scheduled_time:
-            self.print_out_dark(f"{label} (Meet {self._scheduled_time})")
-            return True
-        self.show_progress(f"{label} (Waiting for {self._scheduled_time})")
-        return False
+    def create_loop_inspector(self) -> Callable[..., Optional[bool]]:
+        async def loop_inspect() -> bool:
+            await asyncio.sleep(0.1)
+            label = f"Watching {self._rendered_schedule}"
+            identifier = self.get_identifier()
+            scheduled_time = self.__scheduled_times[identifier]
+            self.set_task_xcom(key="scheduled-time", value=scheduled_time)
+            now = datetime.datetime.now()
+            if now > scheduled_time:
+                self.print_out_dark(f"{label} (Meet {scheduled_time})")
+                self.__scheduled_times[identifier] = self._get_next_schedule_time()
+                return True
+            self.show_progress(f"{label} (Waiting for {scheduled_time})")
+            return False
+
+        return loop_inspect
+
+    def _get_next_schedule_time(self) -> datetime.datetime:
+        cron = self._get_cron()
+        return cron.get_next(datetime.datetime)
+
+    def _get_cron(self) -> Any:
+        margin = datetime.timedelta(seconds=0.001)
+        slightly_before_now = datetime.datetime.now() - margin
+        cron = croniter.croniter(self._rendered_schedule, slightly_before_now)
+        return cron

zrb/task/watcher.py

@@ -0,0 +1,100 @@
+import asyncio
+
+from zrb.helper.accessories.color import colored
+from zrb.helper.accessories.name import get_random_name
+from zrb.helper.log import logger
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Callable, Iterable, Optional, Union
+from zrb.task.any_task import AnyTask
+from zrb.task.any_task_event_handler import (
+    OnFailed,
+    OnReady,
+    OnRetry,
+    OnSkipped,
+    OnStarted,
+    OnTriggered,
+    OnWaiting,
+)
+from zrb.task.checker import Checker
+from zrb.task.looper import looper
+from zrb.task_env.env import Env
+from zrb.task_env.env_file import EnvFile
+from zrb.task_group.group import Group
+from zrb.task_input.any_input import AnyInput
+
+logger.debug(colored("Loading zrb.task.watcher", attrs=["dark"]))
+
+
+@typechecked
+class Watcher(Checker):
+    __looper = looper
+
+    def __init__(
+        self,
+        name: str = "watch",
+        group: Optional[Group] = None,
+        inputs: Iterable[AnyInput] = [],
+        envs: Iterable[Env] = [],
+        env_files: Iterable[EnvFile] = [],
+        icon: Optional[str] = None,
+        color: Optional[str] = None,
+        description: str = "",
+        upstreams: Iterable[AnyTask] = [],
+        fallbacks: Iterable[AnyTask] = [],
+        on_triggered: Optional[OnTriggered] = None,
+        on_waiting: Optional[OnWaiting] = None,
+        on_skipped: Optional[OnSkipped] = None,
+        on_started: Optional[OnStarted] = None,
+        on_ready: Optional[OnReady] = None,
+        on_retry: Optional[OnRetry] = None,
+        on_failed: Optional[OnFailed] = None,
+        checking_interval: Union[int, float] = 0.1,
+        progress_interval: Union[int, float] = 30,
+        expected_result: bool = True,
+        should_execute: Union[bool, str, Callable[..., bool]] = True,
+    ):
+        Checker.__init__(
+            self,
+            name=name,
+            group=group,
+            inputs=inputs,
+            envs=envs,
+            env_files=env_files,
+            icon=icon,
+            color=color,
+            description=description,
+            upstreams=upstreams,
+            fallbacks=fallbacks,
+            on_triggered=on_triggered,
+            on_waiting=on_waiting,
+            on_skipped=on_skipped,
+            on_started=on_started,
+            on_ready=on_ready,
+            on_retry=on_retry,
+            on_failed=on_failed,
+            checking_interval=checking_interval,
+            should_execute=should_execute,
+            progress_interval=progress_interval,
+            expected_result=expected_result,
+        )
+        self._identifier = get_random_name()
+
+    def get_identifier(self):
+        return self._identifier
+
+    async def run(self, *args: Any, **kwargs: Any) -> bool:
+        if not looper.is_registered(self._identifier):
+            asyncio.create_task(
+                looper.register(self._identifier, self.create_loop_inspector())
+            )
+        return await super().run(*args, **kwargs)
+
+    async def inspect(self, *args, **kwargs: Any) -> Optional[bool]:
+        result = await looper.pop(self._identifier)
+        return result
+
+    def create_loop_inspector(self) -> Callable[..., Optional[bool]]:
+        def loop_inspect() -> Optional[bool]:
+            return None
+
+        return loop_inspect

zrb/task/wiki_task.py

@@ -1,6 +1,8 @@
 import os
 
 from zrb.action.runner import Runner
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.task import show_lines
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Callable, Iterable, List, Mapping, Optional, Union
@@ -21,6 +23,8 @@ from zrb.task_env.env_file import EnvFile
 from zrb.task_group.group import Group
 from zrb.task_input.any_input import AnyInput
 
+logger.debug(colored("Loading zrb.task.wiki_task", attrs=["dark"]))
+
 
 @typechecked
 def create_wiki_tasks(

zrb/task_env/constant.py

@@ -1 +1,6 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+
+logger.debug(colored("Loading zrb.task_env.constant", attrs=["dark"]))
+
 RESERVED_ENV_NAMES = ("_ZRB_EXECUTION_ID", "_ZRB_EXECUTION_ID")

zrb/task_env/env.py

@@ -1,10 +1,14 @@
 import os
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.string.modification import double_quote
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import JinjaTemplate, Optional
 from zrb.task_env.constant import RESERVED_ENV_NAMES
 
+logger.debug(colored("Loading zrb.task_env.env", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_env/env_file.py

@@ -1,11 +1,15 @@
 from dotenv import dotenv_values
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.string.modification import double_quote
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import List, Optional
 from zrb.task_env.constant import RESERVED_ENV_NAMES
 from zrb.task_env.env import Env
 
+logger.debug(colored("Loading zrb.task_env.env_file", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_group/group.py

@@ -1,9 +1,13 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.string.conversion import to_cli_name
 from zrb.helper.string.modification import double_quote
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import List, Optional, TypeVar
 from zrb.task.any_task import AnyTask
 
+logger.debug(colored("Loading zrb.task_group.group", attrs=["dark"]))
+
 # flake8: noqa E501
 TGroup = TypeVar("TGroup", bound="Group")
 

zrb/task_input/any_input.py

@@ -1,7 +1,11 @@
 from abc import ABC, abstractmethod
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typing import Any, List, Mapping
 
+logger.debug(colored("Loading zrb.task_input.any_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/base_input.py

@@ -1,9 +1,13 @@
 from zrb.config.config import show_prompt
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, List, Mapping, Optional, Union
 from zrb.task_input.any_input import AnyInput
 from zrb.task_input.constant import RESERVED_INPUT_NAMES
 
+logger.debug(colored("Loading zrb.task_input.base_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/bool_input.py

@@ -1,7 +1,11 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.bool_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/choice_input.py

@@ -1,9 +1,13 @@
 import click
 
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Iterable, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.choice_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/constant.py

@@ -1 +1,6 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+
+logger.debug(colored("Loading zrb.task_input.constant", attrs=["dark"]))
+
 RESERVED_INPUT_NAMES = ("_task", "_args")

zrb/task_input/float_input.py

@@ -1,7 +1,11 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.float_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/int_input.py

@@ -1,7 +1,11 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.int_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/password_input.py

@@ -1,7 +1,11 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.password_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/str_input.py

@@ -1,7 +1,11 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
 from zrb.helper.typing import Any, Optional, Union
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.str_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

zrb/task_input/task_input.py

@@ -1,5 +1,9 @@
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
 from zrb.task_input.base_input import BaseInput
 
+logger.debug(colored("Loading zrb.task_input.task_input", attrs=["dark"]))
+
 # flake8: noqa E501
 
 

{zrb-0.15.0.dist-info → zrb-0.17.0.dist-info}/METADATA

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