zrb 0.23.4__py3-none-any.whl → 0.26.0__py3-none-any.whl

zrb/task/base_task/base_task.py

@@ -2,9 +2,11 @@ import asyncio
 import copy
 import os
 import shutil
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, Union
 
 from zrb.advertisement import advertisements
-from zrb.config.config import show_advertisement, tmp_dir
+from zrb.config.config import SHOW_ADVERTISEMENT, TMP_DIR
 from zrb.helper.accessories.name import get_random_name
 from zrb.helper.advertisement import get_advertisement
 from zrb.helper.callable import run_async
@@ -12,7 +14,6 @@ from zrb.helper.map.conversion import to_str as map_to_str
 from zrb.helper.string.conversion import to_variable_name
 from zrb.helper.string.modification import double_quote
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Any, Callable, Iterable, List, Mapping, Optional, Union
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,
@@ -41,14 +42,14 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     Every Task definition should be extended from this class.
     """
 
-    __running_tasks: List[AnyTask] = []
+    __running_tasks: list[AnyTask] = []
 
     def __init__(
         self,
         name: str,
         group: Optional[Group] = None,
         description: str = "",
-        inputs: List[AnyInput] = [],
+        inputs: list[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -119,7 +120,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             operand.add_upstream(self)
             return operand
         if isinstance(operand, AnyParallel):
-            other_tasks: List[AnyTask] = operand.get_tasks()
+            other_tasks: list[AnyTask] = operand.get_tasks()
             for other_task in other_tasks:
                 other_task.add_upstream(self)
             return operand
@@ -127,7 +128,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
     def __get_xcom_dir(self, execution_id: Optional[str] = None) -> str:
         if execution_id is None:
             execution_id = self.get_execution_id()
-        return os.path.join(tmp_dir, f"xcom.{execution_id}")
+        return os.path.join(TMP_DIR, f"xcom.{execution_id}")
 
     def __ensure_xcom_dir_exists(self, execution_id: Optional[str] = None):
         xcom_dir = self.__get_xcom_dir(execution_id=execution_id)
@@ -286,6 +287,9 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             result = results[-1]
             self._print_result(result)
             return result
+        except RuntimeError as e:
+            if "event loop is closed" not in str(e).lower():
+                raise e
         except Exception as e:
             self.log_error(f"{e}")
             if raise_error:
@@ -303,7 +307,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             await asyncio.sleep(self._checking_interval)
         self._end_timer()
         if show_done_info:
-            if show_advertisement:
+            if SHOW_ADVERTISEMENT:
                 selected_advertisement = get_advertisement(advertisements)
                 selected_advertisement.show()
             self._show_done_info()
@@ -415,7 +419,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         # wait all upstream checkers to complete
         await asyncio.gather(*coroutines)
 
-    async def __trigger_failure(self, tasks: List[AnyTask]):
+    async def __trigger_failure(self, tasks: list[AnyTask]):
         coroutines = [
             task.on_failed(is_last_attempt=True, exception=Exception("canceled"))
             for task in tasks
@@ -423,7 +427,7 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
         await asyncio.gather(*coroutines)
 
     async def __trigger_fallbacks(
-        self, tasks: List[AnyTask], kwargs: Mapping[str, Any]
+        self, tasks: list[AnyTask], kwargs: Mapping[str, Any]
     ):
         coroutines: Iterable[asyncio.Task] = []
         for fallback in self.__get_all_fallbacks(tasks):
@@ -431,8 +435,8 @@ class BaseTask(FinishTracker, AttemptTracker, Renderer, BaseTaskModel, AnyTask):
             coroutines.append(asyncio.create_task(fallback._run_all(**kwargs)))
         await asyncio.gather(*coroutines)
 
-    def __get_all_fallbacks(self, tasks: List[AnyTask]) -> List[AnyTask]:
-        all_fallbacks: List[AnyTask] = []
+    def __get_all_fallbacks(self, tasks: list[AnyTask]) -> list[AnyTask]:
+        all_fallbacks: list[AnyTask] = []
         for task in tasks:
             task._lock_fallbacks()
             for fallback in task._get_fallbacks():

zrb/task/base_task/component/base_task_model.py

@@ -2,24 +2,17 @@ import datetime
 import logging
 import os
 import sys
+from collections.abc import Callable, Iterable, Mapping
 from functools import lru_cache
+from typing import Any, Optional, Union
 
-from zrb.config.config import env_prefix, logging_level, show_time
+from zrb.config.config import ENV_PREFIX, LOGGING_LEVEL, SHOW_TIME
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.string.conversion import to_variable_name
 from zrb.helper.string.modification import double_quote
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import (
-    Any,
-    Callable,
-    Iterable,
-    JinjaTemplate,
-    List,
-    Mapping,
-    Optional,
-    Union,
-)
+from zrb.helper.typing import JinjaTemplate
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,
@@ -48,7 +41,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         name: str,
         group: Optional[Group] = None,
         description: str = "",
-        inputs: List[AnyInput] = [],
+        inputs: list[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -102,7 +95,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         )
         PidModel.__init__(self)
         TimeTracker.__init__(self)
-        self.__args: List[Any] = []
+        self.__args: list[Any] = []
         self.__kwargs: Mapping[str, Any] = {}
 
     def _set_args(self, args: Iterable[Any]):
@@ -118,35 +111,35 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         self.__kwargs = kwargs
 
     def log_debug(self, message: Any):
-        if logging_level > logging.DEBUG:
+        if LOGGING_LEVEL > logging.DEBUG:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", attrs=["dark"])
         logger.debug(colored_message)
 
     def log_warn(self, message: Any):
-        if logging_level > logging.WARNING:
+        if LOGGING_LEVEL > logging.WARNING:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", attrs=["dark"])
         logger.warning(colored_message)
 
     def log_info(self, message: Any):
-        if logging_level > logging.INFO:
+        if LOGGING_LEVEL > logging.INFO:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", attrs=["dark"])
         logger.info(colored_message)
 
     def log_error(self, message: Any):
-        if logging_level > logging.ERROR:
+        if LOGGING_LEVEL > logging.ERROR:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", color="red", attrs=["bold"])
         logger.error(colored_message, exc_info=True)
 
     def log_critical(self, message: Any):
-        if logging_level > logging.CRITICAL:
+        if LOGGING_LEVEL > logging.CRITICAL:
             return
         prefix = self.__get_log_prefix()
         colored_message = colored(f"{prefix} • {message}", color="red", attrs=["bold"])
@@ -192,16 +185,16 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         self._play_bell()
 
     def _show_env_prefix(self):
-        if env_prefix == "":
+        if ENV_PREFIX == "":
             return
-        colored_env_prefix = colored(env_prefix, color="yellow")
+        colored_env_prefix = colored(ENV_PREFIX, color="yellow")
         colored_label = colored("Your current environment: ", attrs=["dark"])
         print(colored(f"{colored_label}{colored_env_prefix}"), file=sys.stderr)
 
     def _show_run_command(self):
         if not self.__has_cli_interface:
             return
-        params: List[str] = [double_quote(arg) for arg in self.__args]
+        params: list[str] = [double_quote(arg) for arg in self.__args]
         for task_input in self._get_combined_inputs():
             if task_input.is_hidden():
                 continue
@@ -225,7 +218,7 @@ class BaseTaskModel(CommonTaskModel, PidModel, TimeTracker):
         return colored(text, color=self.get_color())
 
     def __get_print_prefix(self) -> str:
-        common_prefix = self.__get_common_prefix(show_time=show_time)
+        common_prefix = self.__get_common_prefix(show_time=SHOW_TIME)
         icon = self.get_icon()
         length = LOG_NAME_LENGTH - len(icon)
         rjust_cli_name = self.__get_rjust_full_cli_name(length)

zrb/task/base_task/component/common_task_model.py

@@ -1,19 +1,12 @@
 import os
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, Union
 
 from zrb.helper.accessories.color import get_random_color
 from zrb.helper.accessories.icon import get_random_icon
 from zrb.helper.string.conversion import to_cli_name
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import (
-    Any,
-    Callable,
-    Iterable,
-    JinjaTemplate,
-    List,
-    Mapping,
-    Optional,
-    Union,
-)
+from zrb.helper.typing import JinjaTemplate
 from zrb.helper.util import coalesce_str
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
@@ -39,7 +32,7 @@ class CommonTaskModel:
         name: str,
         group: Optional[Group] = None,
         description: str = "",
-        inputs: List[AnyInput] = [],
+        inputs: list[AnyInput] = [],
         envs: Iterable[Env] = [],
         env_files: Iterable[EnvFile] = [],
         icon: Optional[str] = None,
@@ -65,7 +58,7 @@ class CommonTaskModel:
         self._group = group
         if group is not None:
             group._add_task(self)
-        checkers_cp: List[AnyTask] = [checker.copy() for checker in checkers]
+        checkers_cp: list[AnyTask] = [checker.copy() for checker in checkers]
         for checker in checkers_cp:
             checker.add_env(*envs)
             checker.add_env_file(*env_files)
@@ -104,7 +97,7 @@ class CommonTaskModel:
         self.__has_already_inject_inputs: bool = False
         self.__has_already_inject_upstreams: bool = False
         self.__has_already_inject_fallbacks: bool = False
-        self.__all_inputs: Optional[List[AnyInput]] = None
+        self.__all_inputs: Optional[list[AnyInput]] = None
 
     def _lock_checkers(self):
         self.__allow_add_checkers = False
@@ -185,7 +178,7 @@ class CommonTaskModel:
     def inject_inputs(self):
         pass
 
-    def _get_inputs(self) -> List[AnyInput]:
+    def _get_inputs(self) -> list[AnyInput]:
         if not self.__has_already_inject_inputs:
             self.inject_inputs()
             self.__has_already_inject_inputs = True
@@ -197,7 +190,7 @@ class CommonTaskModel:
         """
         if self.__all_inputs is not None:
             return self.__all_inputs
-        self.__all_inputs: List[AnyInput] = []
+        self.__all_inputs: list[AnyInput] = []
         existing_input_names: Mapping[str, bool] = {}
         # Add task inputs
         inputs = self._get_inputs()
@@ -244,7 +237,7 @@ class CommonTaskModel:
     def inject_envs(self):
         pass
 
-    def _get_envs(self) -> List[Env]:
+    def _get_envs(self) -> list[Env]:
         if not self.__has_already_inject_envs:
             self.inject_envs()
             self.__has_already_inject_envs = True
@@ -297,7 +290,7 @@ class CommonTaskModel:
     def inject_upstreams(self):
         pass
 
-    def _get_upstreams(self) -> List[AnyTask]:
+    def _get_upstreams(self) -> list[AnyTask]:
         if not self.__has_already_inject_upstreams:
             self.inject_upstreams()
             self.__has_already_inject_upstreams = True
@@ -316,7 +309,7 @@ class CommonTaskModel:
     def inject_fallbacks(self):
         pass
 
-    def _get_fallbacks(self) -> List[AnyTask]:
+    def _get_fallbacks(self) -> list[AnyTask]:
         if not self.__has_already_inject_fallbacks:
             self.inject_fallbacks()
             self.__has_already_inject_fallbacks = True
@@ -328,7 +321,7 @@ class CommonTaskModel:
     def get_color(self) -> str:
         return self._color
 
-    def _get_env_files(self) -> List[EnvFile]:
+    def _get_env_files(self) -> list[EnvFile]:
         if not self.__has_already_inject_env_files:
             self.inject_env_files()
             self.__has_already_inject_env_files = True
@@ -346,11 +339,11 @@ class CommonTaskModel:
         additional_checkers = self.__complete_new_checkers(checkers)
         self._checkers = self._checkers + additional_checkers
 
-    def __complete_new_checkers(self, new_checkers: List[AnyTask]) -> List[AnyTask]:
+    def __complete_new_checkers(self, new_checkers: Iterable[AnyTask]) -> list[AnyTask]:
         """
         For internal use: copy and completing new checkers
         """
-        checkers: List[AnyTask] = [checker.copy() for checker in new_checkers]
+        checkers: list[AnyTask] = [checker.copy() for checker in new_checkers]
         for checker in checkers:
             checker.add_input(*self._get_inputs())
             checker.add_env(*self._get_envs())
@@ -360,7 +353,7 @@ class CommonTaskModel:
     def inject_checkers(self):
         pass
 
-    def _get_checkers(self) -> List[AnyTask]:
+    def _get_checkers(self) -> list[AnyTask]:
         if not self.__allow_add_checkers:
             self.inject_checkers()
             self.__allow_add_checkers = True

zrb/task/base_task/component/renderer.py

@@ -1,4 +1,6 @@
 import os
+from collections.abc import Mapping
+from typing import Any, Optional, Union
 
 import jinja2
 
@@ -6,7 +8,7 @@ from zrb.helper.render_data import DEFAULT_RENDER_DATA
 from zrb.helper.string.conversion import to_boolean
 from zrb.helper.string.jinja import is_probably_jinja
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Any, JinjaTemplate, Mapping, Optional, Union
+from zrb.helper.typing import JinjaTemplate
 from zrb.task.any_task import AnyTask
 
 

zrb/task/base_task/component/trackers.py

@@ -1,8 +1,8 @@
 import asyncio
 import time
+from typing import Optional, Union
 
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import Optional, Union
 
 LOG_NAME_LENGTH = 20
 

zrb/task/checker.py

@@ -1,9 +1,10 @@
 import asyncio
+from collections.abc import Callable, Iterable
+from typing import Any, Optional, Union
 
 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, Optional, Union
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,

zrb/task/cmd_task.py

@@ -7,21 +7,15 @@ import signal
 import subprocess
 import sys
 import time
+from collections.abc import Callable, Iterable
+from typing import Any, Optional, TypeVar, Union
 
-from zrb.config.config import default_shell, logging_level
+from zrb.config.config import DEFAULT_SHELL, LOGGING_LEVEL
 from zrb.helper.accessories.color import colored
+from zrb.helper.asyncio_task import stop_asyncio_sync
 from zrb.helper.log import logger
 from zrb.helper.typecheck import typechecked
-from zrb.helper.typing import (
-    Any,
-    Callable,
-    Iterable,
-    JinjaTemplate,
-    List,
-    Optional,
-    TypeVar,
-    Union,
-)
+from zrb.helper.typing import JinjaTemplate
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,
@@ -57,7 +51,7 @@ def _reset_stty():
 
 
 def _log_error(message: Any):
-    if logging_level > logging.ERROR:
+    if LOGGING_LEVEL > logging.ERROR:
         return
     colored_message = colored(f"{message}", color="red", attrs=["bold"])
     logger.error(colored_message, exc_info=True)
@@ -111,7 +105,7 @@ class CmdTask(BaseTask):
         >>> runner.register(hello)
     """
 
-    _pids: List[int] = []
+    _pids: list[int] = []
     _global_state = CmdGlobalState()
 
     def __init__(
@@ -187,8 +181,8 @@ class CmdTask(BaseTask):
         self._max_error_size = max_error_line
         self._output_buffer: Iterable[str] = []
         self._error_buffer: Iterable[str] = []
-        if executable is None and default_shell != "":
-            executable = default_shell
+        if executable is None and DEFAULT_SHELL != "":
+            executable = DEFAULT_SHELL
         self._executable = executable
         self._process: Optional[asyncio.subprocess.Process]
         self._preexec_fn = preexec_fn
@@ -296,13 +290,7 @@ class CmdTask(BaseTask):
         _print_out_dark(f"Getting signal {signum}")
         for pid in self._pids:
             self.__kill_by_pid(pid)
-        tasks = asyncio.all_tasks()
-        for task in tasks:
-            try:
-                task.cancel()
-            except Exception as e:
-                self.print_err(e)
-        time.sleep(0.3)
+        stop_asyncio_sync()
         _print_out_dark(f"Exiting with signal {signum}")
         sys.exit(signum)
 

zrb/task/decorator.py

@@ -1,8 +1,10 @@
+from collections.abc import Callable, Iterable
+from typing import Any, Optional, Union
+
 from zrb.action.runner import Runner
 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, Optional, Union
 from zrb.task.any_task import AnyTask
 from zrb.task.any_task_event_handler import (
     OnFailed,

zrb/task/docker_compose_start_task.py

@@ -0,0 +1,146 @@
+import os
+import pathlib
+from collections.abc import Callable, Iterable, Mapping
+from typing import Any, Optional, Union
+
+from zrb.helper.accessories.color import colored
+from zrb.helper.log import logger
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import JinjaTemplate
+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.cmd_task import CmdVal
+from zrb.task.docker_compose_task import DockerComposeTask, ServiceConfig
+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.docker_compose_task", attrs=["dark"]))
+
+
+@typechecked
+class DockerComposeStartTask(DockerComposeTask):
+    def __init__(
+        self,
+        name: str,
+        group: Optional[Group] = None,
+        inputs: Iterable[AnyInput] = [],
+        envs: Iterable[Env] = [],
+        env_files: Iterable[EnvFile] = [],
+        icon: Optional[str] = None,
+        color: Optional[str] = None,
+        description: str = "",
+        executable: Optional[str] = None,
+        compose_service_configs: Mapping[str, ServiceConfig] = {},
+        compose_file: Optional[str] = None,
+        compose_options: Mapping[JinjaTemplate, JinjaTemplate] = {},
+        compose_flags: Iterable[JinjaTemplate] = [],
+        compose_args: Iterable[JinjaTemplate] = [],
+        compose_env_prefix: str = "",
+        setup_cmd: CmdVal = "",
+        setup_cmd_path: CmdVal = "",
+        cwd: Optional[Union[JinjaTemplate, pathlib.Path]] = None,
+        should_render_cwd: bool = True,
+        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: Union[float, int] = 0.05,
+        retry: int = 2,
+        retry_interval: Union[float, int] = 1,
+        max_output_line: int = 1000,
+        max_error_line: int = 1000,
+        preexec_fn: Optional[Callable[[], Any]] = os.setsid,
+        should_execute: Union[bool, str, Callable[..., bool]] = True,
+        return_upstream_result: bool = False,
+        should_print_cmd_result: bool = True,
+        should_show_cmd: bool = True,
+        should_show_working_directory: bool = True,
+    ):
+        DockerComposeTask.__init__(
+            self,
+            name=name,
+            group=group,
+            inputs=inputs,
+            envs=envs,
+            env_files=env_files,
+            icon=icon,
+            color=color,
+            description=description,
+            executable=executable,
+            compose_service_configs=compose_service_configs,
+            compose_file=compose_file,
+            compose_options=compose_options,
+            compose_flags=compose_flags,
+            compose_args=compose_args,
+            compose_env_prefix=compose_env_prefix,
+            setup_cmd=setup_cmd,
+            setup_cmd_path=setup_cmd_path,
+            cwd=cwd,
+            should_render_cwd=should_render_cwd,
+            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,
+            max_output_line=max_output_line,
+            max_error_line=max_error_line,
+            preexec_fn=preexec_fn,
+            should_execute=should_execute,
+            return_upstream_result=return_upstream_result,
+            should_print_cmd_result=should_print_cmd_result,
+            should_show_cmd=should_show_cmd,
+            should_show_working_directory=should_show_working_directory,
+        )
+
+    def get_cmd_script(self, *args: Any, **kwargs: Any) -> str:
+        # setup
+        setup_cmd = self._create_cmd_script(
+            self._setup_cmd_path, self._setup_cmd, *args, **kwargs
+        )
+        cmd_list = [setup_cmd] if setup_cmd.strip() != "" else []
+        # compose command
+        cmd_list = cmd_list + [
+            # compose start
+            self._get_docker_compose_cmd_script(
+                compose_cmd="up",
+                compose_options=self._compose_options,
+                compose_flags=list(self._compose_flags) + ["-d"],
+                compose_args=self._compose_args,
+                *args,
+            ),
+            # compose log
+            self._get_docker_compose_cmd_script(
+                compose_cmd="logs",
+                compose_options={},
+                compose_flags=["-f"],
+                compose_args=[],
+                *args,
+            ),
+        ]
+        cmd_str = "\n".join(cmd_list)
+        self.log_info(f"Command: {cmd_str}")
+        return cmd_str