zrb 1.0.0a1__py3-none-any.whl → 1.0.0a3__py3-none-any.whl

zrb/input/password_input.py

@@ -1,8 +1,8 @@
 import getpass
 from collections.abc import Callable
 
-from ..context.any_shared_context import AnySharedContext
-from .base_input import BaseInput
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
 
 
 class PasswordInput(BaseInput):

zrb/input/str_input.py

@@ -1,4 +1,4 @@
-from .base_input import BaseInput
+from zrb.input.base_input import BaseInput
 
 
 class StrInput(BaseInput):

zrb/input/text_input.py

@@ -1,10 +1,11 @@
+import os
 import subprocess
 import tempfile
 from collections.abc import Callable
 
-from ..config import DEFAULT_EDITOR
-from ..context.any_shared_context import AnySharedContext
-from .base_input import BaseInput
+from zrb.config import DEFAULT_EDITOR
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
 
 
 class TextInput(BaseInput):
@@ -66,14 +67,15 @@ class TextInput(BaseInput):
 
     def _prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
         prompt_message = (
-            f"{self.comment_start}{super().prompt_message}{self.comment_end}\n"
+            f"{self.comment_start}{super().prompt_message}{self.comment_end}"
         )
+        prompt_message_eol = f"{prompt_message}\n"
         default_value = self._get_default_str(shared_ctx)
         with tempfile.NamedTemporaryFile(
             delete=False, suffix=self._extension
         ) as temp_file:
             temp_file_name = temp_file.name
-            temp_file.write(prompt_message.encode())
+            temp_file.write(prompt_message_eol.encode())
             # Pre-fill with default content
             if default_value:
                 temp_file.write(default_value.encode())
@@ -82,8 +84,8 @@ class TextInput(BaseInput):
         subprocess.call([self._editor, temp_file_name])
         # Read the edited content
         with open(temp_file_name, "r") as temp_file:
-            edited_content = temp_file.read().strip()
-            parts = edited_content.split(prompt_message)
-            if len(parts) == 2 and parts[0].strip() == "":
-                edited_content = parts[1]
-        return edited_content.strip() if edited_content.strip() else default_value
+            edited_content = temp_file.read()
+            parts = [text.strip() for text in edited_content.split(prompt_message, 1)]
+            edited_content = "\n".join(parts).lstrip()
+        os.remove(temp_file_name)
+        return edited_content

zrb/runner/cli.py

@@ -1,16 +1,22 @@
 import sys
 from typing import Any
 
-from ..config import BANNER, WEB_HTTP_PORT
-from ..context.shared_context import SharedContext
-from ..group.group import Group
-from ..session.session import Session
-from ..task.any_task import AnyTask
-from ..task.task import Task
-from ..util.cli.style import stylize_bold_yellow, stylize_faint, stylize_section_header
-from ..util.group import extract_node_from_args, get_non_empty_subgroups, get_subtasks
-from ..util.load import load_zrb_init
-from .web_server import run_web_server
+from zrb.config import BANNER, WEB_HTTP_PORT
+from zrb.context.any_context import AnyContext
+from zrb.context.shared_context import SharedContext
+from zrb.group.group import Group
+from zrb.runner.web_server import create_app, run_web_server
+from zrb.session.session import Session
+from zrb.task.any_task import AnyTask
+from zrb.task.make_task import make_task
+from zrb.util.cli.style import (
+    stylize_bold_yellow,
+    stylize_faint,
+    stylize_section_header,
+)
+from zrb.util.group import extract_node_from_args, get_non_empty_subgroups, get_subtasks
+from zrb.util.load import load_zrb_init
+from zrb.util.string.conversion import double_quote
 
 
 class Cli(Group):
@@ -25,12 +31,15 @@ class Cli(Group):
         if "h" in kwargs or "help" in kwargs:
             self._show_task_info(node)
             return
-        result = self._run_task(node, args, kwargs)
-        if result is not None:
-            print(result)
-        run_command = self._get_run_command(node_path, kwargs, args)
-        self._print_run_command(run_command)
-        return result
+        run_kwargs = self._get_run_kwargs(node, args, kwargs)
+        try:
+            result = self._run_task(node, args, run_kwargs)
+            if result is not None:
+                print(result)
+            return result
+        finally:
+            run_command = self._get_run_command(node_path, run_kwargs)
+            self._print_run_command(run_command)
 
     def _print_run_command(self, run_command: str):
         print(
@@ -39,34 +48,51 @@ class Cli(Group):
             file=sys.stderr,
         )
 
-    def _get_run_command(
-        self, node_path: list[str], kwargs: dict[str, Any], args: list[str]
-    ) -> str:
+    def _get_run_command(self, node_path: list[str], run_kwargs: dict[str, str]) -> str:
         parts = [self.name] + node_path
-        if len(kwargs) > 0:
-            parts += [f"--{key}={val}" for key, val in kwargs.items()]
-        if len(args) > 0:
-            parts += args
+        if len(run_kwargs) > 0:
+            parts += [
+                self._get_run_command_param(key, val) for key, val in run_kwargs.items()
+            ]
         return " ".join(parts)
 
-    def _run_task(self, task: AnyTask, args: list[str], options: list[str]) -> Any:
+    def _get_run_command_param(self, key: str, val: str) -> str:
+        if '"' in val or "'" in val or " " in val:
+            return f"--{key} {double_quote(val)}"
+        return f"--{key} {val}"
+
+    def _run_task(
+        self, task: AnyTask, args: list[str], run_kwargs: dict[str, str]
+    ) -> tuple[Any]:
+        shared_ctx = SharedContext(args=args)
+        for task_input in task.inputs:
+            if task_input.name in run_kwargs:
+                task_input.update_shared_context(
+                    shared_ctx, run_kwargs[task_input.name]
+                )
+                continue
+        try:
+            return task.run(Session(shared_ctx=shared_ctx, root_group=self))
+        except KeyboardInterrupt:
+            pass
+
+    def _get_run_kwargs(
+        self, task: AnyTask, args: list[str], kwargs: dict[str, str]
+    ) -> tuple[Any]:
         arg_index = 0
-        str_kwargs = {key: val for key, val in options.items()}
+        str_kwargs = {key: val for key, val in kwargs.items()}
+        run_kwargs = {**str_kwargs}
         shared_ctx = SharedContext(args=args)
         for task_input in task.inputs:
             if task_input.name in str_kwargs:
                 continue
             if arg_index < len(args):
-                str_kwargs[task_input.name] = args[arg_index]
+                run_kwargs[task_input.name] = args[arg_index]
                 arg_index += 1
                 continue
-            str_kwargs[task_input.name] = task_input.prompt_cli_str(shared_ctx)
-        try:
-            return task.run(
-                Session(shared_ctx=shared_ctx, root_group=self), str_kwargs=str_kwargs
-            )
-        except KeyboardInterrupt:
-            pass
+            str_value = task_input.prompt_cli_str(shared_ctx)
+            run_kwargs[task_input.name] = str_value
+        return run_kwargs
 
     def _show_task_info(self, task: AnyTask):
         description = task.description
@@ -77,8 +103,9 @@ class Cli(Group):
             print()
         if len(inputs) > 0:
             print(stylize_section_header("INPUTS"))
+            max_input_name_length = max(len(task_input.name) for task_input in inputs)
             for task_input in inputs:
-                task_input_name = task_input.name.ljust(20)
+                task_input_name = task_input.name.ljust(max_input_name_length + 1)
                 print(f"  --{task_input_name}: {task_input.description}")
             print()
 
@@ -93,15 +120,17 @@ class Cli(Group):
         subgroups = get_non_empty_subgroups(group)
         if len(subgroups) > 0:
             print(stylize_section_header("GROUPS"))
+            max_subgroup_alias_length = max(len(s) for s in subgroups)
             for alias, subgroup in subgroups.items():
-                alias = alias.ljust(20)
+                alias = alias.ljust(max_subgroup_alias_length + 1)
                 print(f"  {alias}: {subgroup.description}")
             print()
         subtasks = get_subtasks(group)
         if len(subtasks) > 0:
             print(stylize_section_header("TASKS"))
+            max_subtask_alias_length = max(len(s) for s in subtasks)
             for alias, subtask in subtasks.items():
-                alias = alias.ljust(20)
+                alias = alias.ljust(max_subtask_alias_length + 1)
                 print(f"  {alias}: {subtask.description}")
             print()
 
@@ -139,13 +168,19 @@ class Cli(Group):
 
 
 cli = Cli(name="zrb", description="Your Automation Powerhouse", banner=BANNER)
+server_group = cli.add_group(
+    Group(name="server", description="🌐 Server related command")
+)
+
 
-cli.add_task(
-    Task(
-        name="start-server",
-        description="Make tasks available via HTTP Requests 🚀",
-        action=lambda ctx: run_web_server(ctx=ctx, root_group=cli, port=WEB_HTTP_PORT),
-        cli_only=True,
-        retries=0,
-    )
+@make_task(
+    name="start-server",
+    description="🚀 Start Zrb Web Server",
+    cli_only=True,
+    retries=0,
+    group=server_group,
+    alias="start",
 )
+async def run(_: AnyContext):
+    app = create_app(cli, WEB_HTTP_PORT)
+    await run_web_server(app, WEB_HTTP_PORT)

zrb/runner/web_app/group_info_ui/controller.py

@@ -1,9 +1,10 @@
 import os
 
-from ....group.any_group import AnyGroup
-from ....util.group import get_non_empty_subgroups, get_subtasks
-from ....util.string.format import fstring_format
-from ..any_request_handler import AnyRequestHandler
+from fastapi.responses import HTMLResponse
+
+from zrb.group.any_group import AnyGroup
+from zrb.util.group import get_non_empty_subgroups, get_subtasks
+from zrb.util.string.format import fstring_format
 
 _DIR = os.path.dirname(__file__)
 
@@ -23,9 +24,7 @@ with open(os.path.join(_DIR, "partial", "task_li.html")) as f:
     _TASK_LI_TEMPLATE = f.read()
 
 
-def handle_group_info_ui(
-    handler: AnyRequestHandler, root_group: AnyGroup, group: AnyGroup, url: str
-):
+def handle_group_info_ui(root_group: AnyGroup, group: AnyGroup, url: str):
     url_parts = url.split("/")
     parent_url_parts = url_parts[:-2] + [""]
     parent_url = "/".join(parent_url_parts)
@@ -75,7 +74,7 @@ def handle_group_info_ui(
             },
         )
     )
-    handler.send_html_response(
+    return HTMLResponse(
         fstring_format(
             _VIEW_TEMPLATE,
             {

zrb/runner/web_app/group_info_ui/view.html

@@ -4,8 +4,8 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="color-scheme" content="light dark">
-    <link rel="stylesheet" href="/pico.min.css">
-    <link rel="icon" href="/favicon-32x32.png" sizes="32x32" type="image/png">
+    <link rel="stylesheet" href="/static/pico.min.css">
+    <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
     <title>Zrb</title>
   </head>
   <body>

zrb/runner/web_app/home_page/controller.py

@@ -1,9 +1,10 @@
 import os
 
-from ....group.any_group import AnyGroup
-from ....util.group import get_non_empty_subgroups, get_subtasks
-from ....util.string.format import fstring_format
-from ..any_request_handler import AnyRequestHandler
+from fastapi.responses import HTMLResponse
+
+from zrb.group.any_group import AnyGroup
+from zrb.util.group import get_non_empty_subgroups, get_subtasks
+from zrb.util.string.format import fstring_format
 
 _DIR = os.path.dirname(__file__)
 
@@ -23,7 +24,7 @@ with open(os.path.join(_DIR, "partial", "task_li.html")) as f:
     _TASK_LI_TEMPLATE = f.read()
 
 
-def handle_home_page(handler: AnyRequestHandler, root_group: AnyGroup):
+def handle_home_page(root_group: AnyGroup):
     subgroups = get_non_empty_subgroups(root_group, web_only=True)
     group_info = (
         ""
@@ -62,7 +63,7 @@ def handle_home_page(handler: AnyRequestHandler, root_group: AnyGroup):
             },
         )
     )
-    handler.send_html_response(
+    return HTMLResponse(
         fstring_format(
             _VIEW_TEMPLATE,
             {

zrb/runner/web_app/home_page/view.html

@@ -4,8 +4,8 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="color-scheme" content="light dark">
-    <link rel="stylesheet" href="/pico.min.css">
-    <link rel="icon" href="/favicon-32x32.png" sizes="32x32" type="image/png">
+    <link rel="stylesheet" href="/static/pico.min.css">
+    <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
     <title>Zrb</title>
   </head>
   <body>

zrb/runner/web_app/task_ui/controller.py

@@ -1,10 +1,11 @@
 import os
 
-from ....group.any_group import AnyGroup
-from ....session.any_session import AnySession
-from ....task.any_task import AnyTask
-from ....util.string.format import fstring_format
-from ..any_request_handler import AnyRequestHandler
+from fastapi.responses import HTMLResponse
+
+from zrb.group.any_group import AnyGroup
+from zrb.session.any_session import AnySession
+from zrb.task.any_task import AnyTask
+from zrb.util.string.format import fstring_format
 
 _DIR = os.path.dirname(__file__)
 
@@ -23,17 +24,15 @@ with open(os.path.join(_DIR, "partial", "show-existing-session.js")) as f:
 with open(os.path.join(_DIR, "partial", "visualize-history.js")) as f:
     _VISUALIZE_HISTORY_SCRIPT = f.read()
 
+with open(os.path.join(_DIR, "partial", "common-util.js")) as f:
+    _COMMON_UTIL_SCRIPT = f.read()
+
 
 def handle_task_ui(
-    handler: AnyRequestHandler,
-    root_group: AnyGroup,
-    task: AnyTask,
-    session: AnySession,
-    url: str,
-    args: list[str],
+    root_group: AnyGroup, task: AnyTask, session: AnySession, url: str, args: list[str]
 ):
     session.register_task(task)
-    ctx = session.get_ctx(task)
+    ctx = task.get_ctx(session)
     url_parts = url.split("/")
     # Assemble parent url
     parent_url_parts = url_parts[:-2] + [""]
@@ -53,7 +52,7 @@ def handle_task_ui(
         ]
     )
     session_name = args[0] if len(args) > 0 else ""
-    handler.send_html_response(
+    return HTMLResponse(
         fstring_format(
             _VIEW_TEMPLATE,
             {
@@ -69,6 +68,7 @@ def handle_task_ui(
                 "main_script": _MAIN_SCRIPT,
                 "show_existing_session_script": _SHOW_EXISTING_SESSION_SCRIPT,
                 "visualize_history_script": _VISUALIZE_HISTORY_SCRIPT,
+                "common_util_script": _COMMON_UTIL_SCRIPT,
                 "session_name": session_name,
             },
         )

zrb/runner/web_app/task_ui/partial/common-util.js

@@ -0,0 +1,37 @@
+function getFinalColor(finalStatus) {
+    switch(finalStatus) {
+        case "started":
+            return "#3498db";
+        case "ready":
+            return "#f39c12";
+        case "completed":
+            return "#2ecc71";
+        case "skipped":
+            return "#95a5a6";
+        case "failed":
+            return "#e74c3c";
+        case "permanently-failed":
+            return "#c0392b";
+        case "terminated":
+            return "#ffffff";
+        default:
+            return "#ffffff";
+    } 
+}
+
+function getFinalTaskStatus(taskStatus) {
+    if (taskStatus.is_completed) {
+        return "completed";
+    }
+    if (taskStatus.is_terminated) {
+        return "terminated"
+    }
+    if (taskStatus.is_permanently_failed) {
+        return "permanently-failed"
+    }
+    const histories = taskStatus.history;
+    if (histories.length > 0) {
+        return histories[histories.length - 1].status;
+    }
+    return "";
+}

zrb/runner/web_app/task_ui/partial/main.js

@@ -17,11 +17,18 @@ window.addEventListener("load", async function () {
     const minStartAtInput = document.getElementById("min-start-at-input");
     minStartAtInput.value = formattedToday;
     // Update session
-    getExistingSessions(0);
+    pollExistingSessions(PAGE);
 });
 
+async function pollExistingSessions() {
+    while (true) {
+        await getExistingSessions(PAGE);
+        await delay(5000);
+    }
+}
 
 async function getExistingSessions(page) {
+    PAGE=page
     const minStartAtInput = document.getElementById("min-start-at-input");
     const minStartAt = formatDate(minStartAtInput.value);
     const maxStartAtInput = document.getElementById("max-start-at-input");
@@ -41,7 +48,7 @@ async function getExistingSessions(page) {
             },
         });
         const {total, data} = await response.json();
-        showExistingSession(total, data);
+        showExistingSession(page, total, data);
         console.log("Success:", data);
     } catch (error) {
         console.error("Error:", error);

zrb/runner/web_app/task_ui/partial/show-existing-session.js

@@ -1,16 +1,31 @@
-function showExistingSession(total, data) {
+function showExistingSession(page, total, data) {
     const ul = document.getElementById("session-history-ul");
     ul.innerHTML = '';  // Clear existing content
     data.forEach(item => {
-        const task_status = item.task_status[item.main_task_name];
-        const task_histories = task_status.history;
-        const task_start_time = task_histories.length > 0 ? task_histories[0].time : ""
+        const taskStatus = item.task_status[item.main_task_name];
+        const finalStatus = getFinalTaskStatus(taskStatus);
+        const finalColor = getFinalColor(finalStatus);
+        const taskHistories = taskStatus.history;
+        const taskStartTime = taskHistories.length > 0 ? taskHistories[0].time : ""
         const li = document.createElement('li');
         const a = document.createElement('a');
-        a.textContent = `${item.name} - ${task_start_time}`;
+        const dateSpan = document.createElement('span');
+        const statusSpan = document.createElement('span');
+        a.textContent = item.name;
         a.target = '_blank';
         a.href = `${UI_URL}${item.name}`;
         li.appendChild(a);
+        statusSpan.style.marginLeft = "10px";
+        statusSpan.style.display = 'inline-block';
+        statusSpan.style.width = '15px';
+        statusSpan.style.height = '15px';
+        statusSpan.style.borderRadius = '50%';
+        statusSpan.style.border = '2px solid black';
+        statusSpan.style.backgroundColor = finalColor;
+        li.appendChild(statusSpan);
+        dateSpan.style.marginLeft = "10px";
+        dateSpan.textContent = taskStartTime;
+        li.appendChild(dateSpan);
         ul.appendChild(li);
     }); 
     const paginationUl = document.getElementById("session-history-pagination-ul");

zrb/runner/web_app/task_ui/partial/visualize-history.js

@@ -101,44 +101,4 @@ function getTaskEndDateTime(taskStatus, now) {
         }
     }
     return now;
-}
-
-
-function getFinalColor(finalStatus) {
-    switch(finalStatus) {
-        case "started":
-            return "#3498db";
-        case "ready":
-            return "#f39c12";
-        case "completed":
-            return "#2ecc71";
-        case "skipped":
-            return "#95a5a6";
-        case "failed":
-            return "#e74c3c";
-        case "permanently-failed":
-            return "#c0392b";
-        case "terminated":
-            return "#ffffff";
-        default:
-            return "#ffffff";
-    } 
-}
-
-
-function getFinalTaskStatus(taskStatus) {
-    if (taskStatus.is_completed) {
-        return "completed";
-    }
-    if (taskStatus.is_terminated) {
-        return "terminated"
-    }
-    if (taskStatus.is_permanently_failed) {
-        return "permanently-failed"
-    }
-    const histories = taskStatus.history;
-    if (histories.length > 0) {
-        return histories[histories.length - 1].status;
-    }
-    return "";
-}
+}

zrb/runner/web_app/task_ui/view.html

@@ -4,8 +4,8 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="color-scheme" content="light dark">
-    <link rel="stylesheet" href="/pico.min.css">
-    <link rel="icon" href="/favicon-32x32.png" sizes="32x32" type="image/png">
+    <link rel="stylesheet" href="/static/pico.min.css">
+    <link rel="icon" href="/static/favicon-32x32.png" sizes="32x32" type="image/png">
     <title>Zrb</title>
   </head>
   <body>
@@ -78,7 +78,9 @@
     const API_URL = '{api_url}';
     const UI_URL = `{ui_url}`;
     let SESSION_NAME = '{session_name}';
+    let PAGE = 0;
     {main_script} 
+    {common_util_script}
     {show_existing_session_script}
     {visualize_history_script}
   </script>