zrb 0.15.1__py3-none-any.whl → 0.16.0__py3-none-any.whl

zrb/__init__.py

@@ -32,6 +32,7 @@ from zrb.task.resource_maker import (
     get_default_resource_skip_parsing,
 )
 from zrb.task.rsync_task import RsyncTask
+from zrb.task.server import Controller, Server
 from zrb.task.task import Task
 from zrb.task.time_watcher import TimeWatcher
 from zrb.task.wiki_task import create_wiki_tasks
@@ -74,6 +75,8 @@ assert HTTPChecker
 assert PortChecker
 assert PathChecker
 assert PathWatcher
+assert Controller
+assert Server
 assert TimeWatcher
 assert ResourceMaker
 assert FlowTask

zrb/builtin/devtool/install/helix/resource/config.toml

@@ -3,6 +3,7 @@ theme = "gruvbox_transparent"
 [editor]
 line-number = "relative"
 mouse = true
+bufferline = "always"
 
 [editor.cursor-shape]
 insert = "bar"
@@ -16,4 +17,4 @@ enable = true
 hidden = false
 git-ignore = false
 git-global = false
-git-exclude = false
+git-exclude = false

zrb/builtin/process/pid/get_by_name.py

@@ -16,7 +16,7 @@ get_process_pid_by_name = CmdTask(
             prompt="Process name to be checked",
         )
     ],
-    cmd="pgrep {{ input.name }}",
+    cmd='pgrep "{{ input.name }}" || exit 0',
     checking_interval=3,
 )
 runner.register(get_process_pid_by_name)

zrb/builtin/schedule.py

@@ -1,10 +1,10 @@
 from zrb.builtin._helper.reccuring_action import create_recurring_action
 from zrb.runner import runner
-from zrb.task.recurring_task import RecurringTask
+from zrb.task.server import Controller, Server
 from zrb.task.time_watcher import TimeWatcher
 from zrb.task_input.str_input import StrInput
 
-schedule = RecurringTask(
+schedule = Server(
     name="schedule",
     icon="📅",
     color="yellow",
@@ -17,15 +17,21 @@ schedule = RecurringTask(
             description="Schedule cron pattern to show the message",
         ),
     ],
-    triggers=[
-        TimeWatcher(
-            name="watch-time", color="cyan", icon="⏰", schedule="{{input.schedule}}"
+    controllers=[
+        Controller(
+            name="periodic",
+            trigger=TimeWatcher(
+                name="watch-time",
+                color="cyan",
+                icon="⏰",
+                schedule="{{input.schedule}}",
+            ),
+            action=create_recurring_action(
+                notif_title="Schedule",
+                trigger_caption="Schedule",
+                trigger_xcom_key="watch-time.scheduled-time",
+            ),
         )
     ],
-    task=create_recurring_action(
-        notif_title="Schedule",
-        trigger_caption="Schedule",
-        trigger_xcom_key="watch-time.scheduled-time",
-    ),
 )
 runner.register(schedule)

zrb/builtin/watch_changes.py

@@ -1,10 +1,10 @@
 from zrb.builtin._helper.reccuring_action import create_recurring_action
 from zrb.runner import runner
 from zrb.task.path_watcher import PathWatcher
-from zrb.task.recurring_task import RecurringTask
+from zrb.task.server import Controller, Server
 from zrb.task_input.str_input import StrInput
 
-watch_changes = RecurringTask(
+watch_changes = Server(
     name="watch-changes",
     icon="🕵️",
     color="yellow",
@@ -23,19 +23,22 @@ watch_changes = RecurringTask(
             description="Ignored file pattern",
         ),
     ],
-    triggers=[
-        PathWatcher(
-            name="watch-path",
-            color="cyan",
-            icon="👀",
-            path="{{input.pattern}}",
-            ignored_path="{{input.ignored_pattern}}",
+    controllers=[
+        Controller(
+            name="watch",
+            trigger=PathWatcher(
+                name="watch-path",
+                color="cyan",
+                icon="👀",
+                path="{{input.pattern}}",
+                ignored_path="{{input.ignored_pattern}}",
+            ),
+            action=create_recurring_action(
+                notif_title="Watch",
+                trigger_caption="File changes",
+                trigger_xcom_key="watch-path.file",
+            ),
         )
     ],
-    task=create_recurring_action(
-        notif_title="Watch",
-        trigger_caption="File changes",
-        trigger_xcom_key="watch-path.file",
-    ),
 )
 runner.register(watch_changes)

zrb/task/base_task/base_task.py

@@ -140,7 +140,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         xcom_dir = self.__get_xcom_dir()
         xcom_file = os.path.join(xcom_dir, key)
         with open(xcom_file, "w") as f:
-            f.write(value)
+            f.write(f"{value}")
 
     def get_xcom(self, key: str) -> str:
         self.__ensure_xcom_dir_exists()

zrb/task/recurring_task.py

@@ -115,6 +115,7 @@ class RecurringTask(BaseTask):
         self._triggers: List[AnyTask] = [trigger.copy() for trigger in triggers]
         self._run_configs: List[RunConfig] = []
         self._single_execution = single_execution
+        self.print_err("Deprecated, please use Server instead")
 
     async def _set_keyval(self, kwargs: Mapping[str, Any], env_prefix: str):
         await super()._set_keyval(kwargs=kwargs, env_prefix=env_prefix)

zrb/task/server.py

@@ -0,0 +1,192 @@
+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, List, Mapping, Optional, Union
+from zrb.helper.util import to_kebab_case
+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.base_task.base_task import BaseTask
+from zrb.task.flow_task import FlowTask
+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.server", attrs=["dark"]))
+
+
+@typechecked
+class Controller:
+    def __init__(
+        self,
+        trigger: Union[AnyTask, List[AnyTask]],
+        action: Union[AnyTask, List[AnyTask]],
+        name: Optional[str] = None,
+    ):
+        self._name = get_random_name() if name is None else name
+        self._triggers = [trigger] if isinstance(trigger, AnyTask) else trigger
+        self._actions = [action] if isinstance(action, AnyTask) else action
+        self._args: List[Any] = []
+        self._kwargs: Mapping[str, Any] = {}
+        self._inputs: List[AnyInput] = []
+        self._envs: List[Env] = []
+        self._env_files: List[EnvFile] = []
+
+    def set_args(self, args: List[Any]):
+        self._args = args
+
+    def set_kwargs(self, kwargs: Mapping[str, Any]):
+        self._kwargs = kwargs
+
+    def set_inputs(self, inputs: List[AnyInput]):
+        self._inputs = inputs
+
+    def set_envs(self, envs: List[Env]):
+        self._envs = envs
+
+    def set_env_files(self, env_files: List[EnvFile]):
+        self._env_files = env_files
+
+    def get_sub_env_files(self) -> Iterable[EnvFile]:
+        env_files = []
+        for trigger in self._triggers:
+            env_files += trigger.copy()._get_env_files()
+        for action in self._actions:
+            env_files += action.copy()._get_env_files()
+        return env_files
+
+    def get_sub_envs(self) -> Iterable[Env]:
+        envs = []
+        for trigger in self._triggers:
+            envs += trigger.copy()._get_envs()
+        for action in self._actions:
+            envs += action.copy()._get_envs()
+        return envs
+
+    def get_sub_inputs(self) -> Iterable[AnyInput]:
+        inputs = []
+        for trigger in self._triggers:
+            inputs += trigger.copy()._get_combined_inputs()
+        for action in self._actions:
+            inputs += action.copy()._get_combined_inputs()
+        return inputs
+
+    def to_function(self) -> Callable[..., Any]:
+        task = self._get_task()
+
+        async def fn() -> Any:
+            task_fn = task.to_function(is_async=True)
+            return await task_fn(*self._args, **self._kwargs)
+
+        return fn
+
+    def _get_task(self) -> AnyTask:
+        kebab_name = to_kebab_case(self._name)
+        actions = self._actions
+        actions.insert(0, self._get_reschedule_task())
+        task: AnyTask = FlowTask(
+            name=f"{kebab_name}-flow",
+            inputs=self._inputs,
+            envs=self._envs,
+            env_files=self._env_files,
+            steps=[self._triggers, actions],
+        )
+        return task
+
+    def _get_reschedule_task(self) -> AnyTask:
+        kebab_name = to_kebab_case(self._name)
+
+        async def on_ready(task: AnyTask):
+            task = self._get_task()
+            fn = task.to_function(is_async=True)
+            await fn()
+
+        return BaseTask(
+            name=f"{kebab_name}-reschedule",
+            on_ready=on_ready,
+        )
+
+
+@typechecked
+class Server(BaseTask):
+
+    def __init__(
+        self,
+        name: str,
+        controllers: List[Controller],
+        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,
+        checkers: Iterable[AnyTask] = [],
+        checking_interval: float = 0,
+        retry: int = 0,
+        retry_interval: float = 1,
+        should_execute: Union[bool, str, Callable[..., bool]] = True,
+        return_upstream_result: bool = False,
+    ):
+        inputs, envs, env_files = list(inputs), list(envs), list(env_files)
+        for controller in controllers:
+            inputs += controller.get_sub_inputs()
+            envs += controller.get_sub_envs()
+            env_files += controller.get_sub_env_files()
+        BaseTask.__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,
+            checkers=checkers,
+            checking_interval=checking_interval,
+            retry=retry,
+            retry_interval=retry_interval,
+            should_execute=should_execute,
+            return_upstream_result=return_upstream_result,
+        )
+        self._controllers = controllers
+
+    async def run(self, *args: Any, **kwargs: Any):
+        for controller in self._controllers:
+            controller.set_envs(self._get_envs())
+            controller.set_env_files(self._get_env_files())
+            controller.set_inputs(self._get_inputs())
+            controller.set_args(args)
+            controller.set_kwargs(kwargs)
+        functions = [controller.to_function() for controller in self._controllers]
+        await asyncio.gather(*[fn() for fn in functions])

{zrb-0.15.1.dist-info → zrb-0.16.0.dist-info}/METADATA

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

{zrb-0.15.1.dist-info → zrb-0.16.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-zrb/__init__.py,sha256=QNtBHrQnz4dEnnFtgrUBUUl9Ph7cUVFt6zJe3PpN0d0,2683
+zrb/__init__.py,sha256=x6qsXjDRBqBjW6EP1HXy3GlaJfeJxOJrmi7iTTjBINw,2762
 zrb/__main__.py,sha256=-_k0XOahDF-06n41Uly-oUMkZ8XDSxO-WUUImWz6GiA,171
 zrb/action/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/action/runner.py,sha256=Z_Rh60DA0U_HqO4t_NzWTmXvHVfdgaL5RQJfTnEZiFQ,4951
@@ -30,7 +30,7 @@ zrb/builtin/devtool/install/gvm/resource/config.sh,sha256=M_r6XjtoYZjx8rJaT3FIwV
 zrb/builtin/devtool/install/helix/helix.py,sha256=W0Xm_eq0wIHcoq0CzG9WrQIH9tPByT-AZ-zi4Z72-U0,2098
 zrb/builtin/devtool/install/helix/install-language-server.sh,sha256=ZkV_ARwhTnLjjbAhJe8Pvp1hyRYVn176DYwg7ObkQ1w,1040
 zrb/builtin/devtool/install/helix/install.sh,sha256=Dsg65aEnpU8YnlvHwiKoxRpj8Jo8j3mejB4bTi2eeKo,1375
-zrb/builtin/devtool/install/helix/resource/config.toml,sha256=zEeA-oiVbCGs6dQNZAbeFfMJ3giClOkuhgJ6Pcel2ww,282
+zrb/builtin/devtool/install/helix/resource/config.toml,sha256=35IwzDzXGfSnUH3O3nyd2IzDVOWyKqj6Kb3QuympXCE,305
 zrb/builtin/devtool/install/helix/resource/themes/gruvbox_transparent.toml,sha256=Kz6AhxXKVHrP5mpFI99uPFyfUOvB_0x2fapj0tUkIaA,56
 zrb/builtin/devtool/install/helm/helm.py,sha256=Y2Iklrcw4-OQYNIjeuKmuIzpdAqGGcl82ZSHMFWck_E,762
 zrb/builtin/devtool/install/helm/install.sh,sha256=fqjaTsO25B2MV7134sriSY5hQ2A1VRsaLc3WmD5jKu4,228
@@ -90,7 +90,7 @@ zrb/builtin/process/__init__.py,sha256=dWM1zIehY65rkJvEAFvX6HGJHL8kb1gkzaSz0Woay
 zrb/builtin/process/_group.py,sha256=KY7iQ_pvqe5iVsRFeLWs-O-xuSyqlTXVj47_TCnu7zQ,118
 zrb/builtin/process/pid/__init__.py,sha256=Rcb3bYgR_oVNOlaggYjcRipHRehrumZuQyadrguXdR0,293
 zrb/builtin/process/pid/_group.py,sha256=SUe7G8tmfg_Q-X3nHOqCUMjDXlTE_hb9gAKVie2wQ2A,195
-zrb/builtin/process/pid/get_by_name.py,sha256=fjJw0n353lhhyR1wnPHLXV13M9aNQmIAeQ_jUmBMVsA,625
+zrb/builtin/process/pid/get_by_name.py,sha256=cW4c9l4JUGa9w5VHUFWi_3tUyx55t7-6i12Gm_hCkhQ,637
 zrb/builtin/process/pid/get_by_port.py,sha256=_yz0jBAV7qIo-eU33peDgVhtzYhMAxAHOc6xQtDwXyc,640
 zrb/builtin/project/__init__.py,sha256=i1YF08_6UjNznYeL0iGTbU8o5yz7iw41RYd8UgeB8U4,887
 zrb/builtin/project/_group.py,sha256=RPWt2YOLIqF7ZznzkSeFm9dozz1oCKmpCWCA1jjgsl4,112
@@ -1280,7 +1280,7 @@ zrb/builtin/project/create/template/src/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeu
 zrb/builtin/project/create/template/template.env,sha256=Y_11yIi7fA5aIOHxrcexFXNxz1UqXaEiIgqUHBazy0w,102
 zrb/builtin/project/create/template/zrb_init.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/builtin/say.py,sha256=KHuzgwitmWQy5g7N11qqs9iV-66vvAl0Uyke9hdc-Eg,3859
-zrb/builtin/schedule.py,sha256=-yOfTAx4lORR7_4PCBpOwn8m-imN7oHs4-RTUL2DC-Y,990
+zrb/builtin/schedule.py,sha256=DtAhHhG56LuneLo9xENPkaP91tOD3Hb1pwBSmkr2eLo,1154
 zrb/builtin/ubuntu/__init__.py,sha256=79JyTzx6pyhtEa7hrsUTNaAQ7xlrgDX1KU74OG8mhic,486
 zrb/builtin/ubuntu/_group.py,sha256=6VhCi-wZRuwvmELlvqvVSOfYLnibP8SQIT2GpaDPtOA,115
 zrb/builtin/ubuntu/install/__init__.py,sha256=AoGq7pPn8FWoRXrEwiaX1ZBBQTzFpqIjpwIx4aajpa8,472
@@ -1292,7 +1292,7 @@ zrb/builtin/ubuntu/install/toys.py,sha256=VlWb8_aHW1kRK6vpjpAveNByc1FlsMPLFXl1X9
 zrb/builtin/ubuntu/update.py,sha256=m3UREE6DhwlbdkQpuug2sfEM6fBLZn0ZGClt_EOsZ_I,372
 zrb/builtin/update.py,sha256=89i_fPUlL27IXczLI7Lr7k4STMpnxyw2je8daCKUTQo,225
 zrb/builtin/version.py,sha256=vjbmSeOSEjT0SgdeQHGslwFCQMukwVZkOOkusZGZNcU,394
-zrb/builtin/watch_changes.py,sha256=5oe1zPRamo5ZsWQKvgVWCXiBv4encS4kN7mubgvacjk,1192
+zrb/builtin/watch_changes.py,sha256=ifDs6sXAMaOmCas0j8RRb5_u8v9_V2zMVzyYH3Dz364,1320
 zrb/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/config/config.py,sha256=6uDxOLmHHstLCosj2miBVxlO9dMTIoXYedqaff8EVBU,1567
 zrb/helper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1359,7 +1359,7 @@ zrb/task/any_task.py,sha256=WHsEUfWjRvvDqF0fxHh4_q2LmdJcnfVC9y0HFleiBZ0,39393
 zrb/task/any_task_event_handler.py,sha256=AjTC6lIcprutRusNBGl83EifQe4TbZzxdlVIR4ndWN4,524
 zrb/task/base_remote_cmd_task.py,sha256=tZi3jODMXfTkDAmWiFR2YdA-b4-TDTP1uLtO0ulmM34,10101
 zrb/task/base_task/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-zrb/task/base_task/base_task.py,sha256=UNaMB9fBz3NqBKDr59ayAUPnUr6cNOhXUdePJcZjcko,20207
+zrb/task/base_task/base_task.py,sha256=i7WEsvTImjzYDxYUb1VifAunkJfiYQx2I4e3NKOOqY8,20212
 zrb/task/base_task/component/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zrb/task/base_task/component/base_task_model.py,sha256=YlEuvYSzlrK83Kds07bu2drKSw3rKyl7qIR1qwIPNZk,10376
 zrb/task/base_task/component/common_task_model.py,sha256=JoAAf8EvuPx31fCK_TBxX_TBeHZrZyFDjLeK8ts0w3A,12285
@@ -1377,10 +1377,11 @@ zrb/task/parallel.py,sha256=-coMuiFlS29GpBgW6plPVaCLesgzzD0bYib29OvhXFg,1193
 zrb/task/path_checker.py,sha256=65GpplGing3QeBPDtc1A_-PWXXiNItCXqabMLcgzm6s,4384
 zrb/task/path_watcher.py,sha256=UR-XMEB-Kly76T4QgGZSTeLxCk_sIiNi__Pm8FfO-yA,6499
 zrb/task/port_checker.py,sha256=uvOJPQqcZ_YQ1TTOxTfgfSc-7rAnSCWTYTgnY-eG4HY,4303
-zrb/task/recurring_task.py,sha256=q9vzZP3iFpHWEnQ2nJAdoAu15ZQothilZQ-ID16bUV8,7366
+zrb/task/recurring_task.py,sha256=FNxV7n4h9AzUCU8oKXwAS_A9j1newS-esWjmMsC33vE,7430
 zrb/task/remote_cmd_task.py,sha256=rmLB5uCcbbfZBy8-nAZI8mgnNd-J2d4SBemLEDwSlV4,3951
 zrb/task/resource_maker.py,sha256=vY55cBCJMYQzkVKygkb6aNTJT6kfSjPunJqHKGA2N2Y,7355
 zrb/task/rsync_task.py,sha256=bgCeZQTG-4isvjZGGs_05oOEkkwGc930NTyuUYUm_cg,4187
+zrb/task/server.py,sha256=w99_9cCEitf6k2sZfLTAc9CgEOsBlcK6yO1SjU3FdWQ,6398
 zrb/task/task.py,sha256=dHv4cmnd0QFPT9PwrfmHpxTaXj86mm8xf7_jAj_engI,329
 zrb/task/time_watcher.py,sha256=c5IPxUs4b5BsgGqyvjRVpeqXFJCHgCV-ke6uIvZ-_7A,4139
 zrb/task/wiki_task.py,sha256=Mcugk_6Pd7pzubi2ZP4eegJs8e9niYKh-9mCrNHXE_g,4330
@@ -1400,8 +1401,8 @@ zrb/task_input/int_input.py,sha256=d2fXcm5fCo09472eMAm6PdzLQD82ZBV9ARq5CjKepAo,4
 zrb/task_input/password_input.py,sha256=g_g8ZWAzDaHx4h2EHY3UCGvTigC6esAUBzXU0T9nDUk,4192
 zrb/task_input/str_input.py,sha256=BNflOhrJvST9bWK0rGdCi7C7y-QDvHj9ISQMRmujIWU,4200
 zrb/task_input/task_input.py,sha256=x1sGHsoSYAYMdQBrCLmcvZa_ZmGggMPj3goAQzewUKI,2181
-zrb-0.15.1.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
-zrb-0.15.1.dist-info/METADATA,sha256=izpcqCCdrTuJBe7HKKxyMVeKZX9X2rc58JohKVaV228,16460
-zrb-0.15.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-zrb-0.15.1.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
-zrb-0.15.1.dist-info/RECORD,,
+zrb-0.16.0.dist-info/LICENSE,sha256=WfnGCl8G60EYOPAEkuc8C9m9pdXWDe08NsKj3TBbxsM,728
+zrb-0.16.0.dist-info/METADATA,sha256=jDQM9ixJuvZpigI0o7T6LhNsL15-71CxyWhgAdbyfCQ,16460
+zrb-0.16.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+zrb-0.16.0.dist-info/entry_points.txt,sha256=xTgXc1kBKYhJHEujdaSPHUcJT3-hbyP1mLgwkv-5sSk,40
+zrb-0.16.0.dist-info/RECORD,,