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

zrb/task/base_task/component/base_task_model.py

@@ -4,7 +4,7 @@ import os
 import sys
 from functools import lru_cache
 
-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
@@ -118,35 +118,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,9 +192,9 @@ 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)
 
@@ -225,7 +225,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/cmd_task.py

@@ -8,7 +8,7 @@ import subprocess
 import sys
 import time
 
-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.log import logger
 from zrb.helper.typecheck import typechecked
@@ -57,7 +57,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)
@@ -187,8 +187,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

zrb/task/docker_compose_start_task.py

@@ -0,0 +1,151 @@
+import os
+import pathlib
+
+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,
+    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.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:
+        cmd_str = "\n".join(
+            [
+                # setup
+                self._create_cmd_script(
+                    self._setup_cmd_path, self._setup_cmd, *args, **kwargs
+                ),
+                # 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,
+                ),
+            ]
+        )
+        self.log_info(f"Command: {cmd_str}")
+        return cmd_str

zrb/task/docker_compose_task.py

@@ -1,7 +1,7 @@
 import os
 import pathlib
 
-from zrb.config.config import container_backend
+from zrb.config.config import CONTAINER_BACKEND
 from zrb.helper.accessories.color import colored
 from zrb.helper.accessories.name import get_random_name
 from zrb.helper.docker_compose.fetch_external_env import fetch_compose_file_env_map
@@ -66,7 +66,7 @@ def _get_ensure_zrb_network_task(backend: str):
 
 
 TDockerComposeTask = TypeVar("TDockerComposeTask", bound="DockerComposeTask")
-ensure_zrb_network_task = _get_ensure_zrb_network_task(container_backend)
+ensure_zrb_network_task = _get_ensure_zrb_network_task(CONTAINER_BACKEND)
 
 
 @typechecked
@@ -341,10 +341,34 @@ class DockerComposeTask(CmdTask):
         raise Exception(f"Invalid compose file: {compose_file}")
 
     def get_cmd_script(self, *args: Any, **kwargs: Any) -> str:
-        setup_cmd_str = self._create_cmd_script(
-            self._setup_cmd_path, self._setup_cmd, *args, **kwargs
+        cmd_str = "\n".join(
+            [
+                # setup
+                self._create_cmd_script(
+                    self._setup_cmd_path, self._setup_cmd, *args, **kwargs
+                ),
+                # compose
+                self._get_docker_compose_cmd_script(
+                    compose_cmd=self._compose_cmd,
+                    compose_options=self._compose_options,
+                    compose_flags=self._compose_flags,
+                    compose_args=self._compose_args,
+                    *args,
+                ),
+            ]
         )
-        command_options = dict(self._compose_options)
+        self.log_info(f"Command: {cmd_str}")
+        return cmd_str
+
+    def _get_docker_compose_cmd_script(
+        self,
+        compose_cmd: str,
+        compose_options: Mapping[JinjaTemplate, JinjaTemplate],
+        compose_flags: Iterable[JinjaTemplate],
+        compose_args: Iterable[JinjaTemplate],
+        *args: Any,
+    ) -> str:
+        command_options = dict(compose_options)
         command_options["--file"] = self._compose_runtime_file
         options = " ".join(
             [
@@ -356,22 +380,15 @@ class DockerComposeTask(CmdTask):
         flags = " ".join(
             [
                 self.render_str(flag)
-                for flag in self._compose_flags
+                for flag in compose_flags
                 if self.render_str(flag) != ""
             ]
         )
         args = " ".join(
             [
                 double_quote(self.render_str(arg))
-                for arg in self._compose_args
+                for arg in compose_args
                 if self.render_str(arg) != ""
             ]
         )
-        cmd_str = "\n".join(
-            [
-                setup_cmd_str,
-                f"{container_backend} compose {options} {self._compose_cmd} {flags} {args}",  # noqa
-            ]
-        )
-        self.log_info(f"Command: {cmd_str}")
-        return cmd_str
+        return f"{CONTAINER_BACKEND} compose {options} {compose_cmd} {flags} {args}"

zrb/task_input/base_input.py

@@ -1,4 +1,4 @@
-from zrb.config.config import show_prompt
+from zrb.config.config import SHOW_PROMPT
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.string.conversion import to_variable_name
@@ -141,7 +141,7 @@ class BaseInput(AnyInput):
             "callback": self._wrapped_callback,
             "default": self._wrapped_default,
         }
-        if show_prompt:
+        if SHOW_PROMPT:
             options["prompt"] = self._prompt
         return options
 

zrb/task_input/multiline_input.py

@@ -1,4 +1,4 @@
-from zrb.config.config import default_editor
+from zrb.config.config import DEFAULT_EDITOR
 from zrb.helper.accessories.color import colored
 from zrb.helper.log import logger
 from zrb.helper.multiline import edit
@@ -56,7 +56,7 @@ class MultilineInput(BaseInput):
         shortcut: Optional[str] = None,
         comment_prefix: str = "//",
         comment_suffix: str = "",
-        editor: str = default_editor,
+        editor: str = DEFAULT_EDITOR,
         extension: str = "txt",
         default: Optional[Union[Any, InputDefault]] = None,
         callback: Optional[InputCallback] = None,

{zrb-0.23.4.dist-info → zrb-0.24.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.23.4
+Version: 0.24.0
 Summary: A Framework to Enhance Your Workflow
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later
@@ -257,7 +257,7 @@ zrb project add fastapp crud --project-dir . --app-name "fastapp" --module-name
 
 # Add column to the entity
 zrb project add fastapp field --project-dir . --app-name "fastapp" --module-name "library" \
-    --entity-name "book" --column-name "title" --column-type "str"
+    --entity-name "book" --column-name "title" --column-type "string"
 
 # Run Fastapp as monolith
 zrb project fastapp monolith start