zrb 1.0.0a5__py3-none-any.whl → 1.0.0a12__py3-none-any.whl

zrb/builtin/todo.py

@@ -4,7 +4,7 @@ import os
 from typing import Any
 
 from zrb.builtin.group import todo_group
-from zrb.config import TODO_DIR
+from zrb.config import TODO_DIR, TODO_VISUAL_FILTER
 from zrb.context.any_context import AnyContext
 from zrb.input.str_input import StrInput
 from zrb.input.text_input import TextInput
@@ -13,6 +13,7 @@ from zrb.util.todo import (
     TodoTaskModel,
     add_durations,
     cascade_todo_task,
+    get_visual_todo_card,
     get_visual_todo_list,
     line_to_todo_task,
     load_todo_list,
@@ -23,7 +24,7 @@ from zrb.util.todo import (
 
 
 @make_task(
-    name="todo-add",
+    name="add-todo",
     input=[
         StrInput(
             name="description",
@@ -51,7 +52,7 @@ from zrb.util.todo import (
     group=todo_group,
     alias="add",
 )
-def todo_add(ctx: AnyContext):
+def add_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -77,26 +78,58 @@ def todo_add(ctx: AnyContext):
         )
     )
     save_todo_list(todo_file_path, todo_list)
-    return get_visual_todo_list(todo_list)
+    return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
 
 
-@make_task(name="todo-list", description="📋 List todo", group=todo_group, alias="list")
-def todo_list(ctx: AnyContext):
+@make_task(name="list-todo", description="📋 List todo", group=todo_group, alias="list")
+def list_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
-    todo_tasks: list[TodoTaskModel] = []
+    todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
-        todo_tasks = load_todo_list(todo_file_path)
-    return get_visual_todo_list(todo_tasks)
+        todo_list = load_todo_list(todo_file_path)
+    return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
 
 
 @make_task(
-    name="todo-complete",
+    name="show-todo",
+    input=StrInput(name="keyword", prompt="Task keyword", description="Task Keyword"),
+    description="🔍 Show todo",
+    group=todo_group,
+    alias="show",
+)
+def show_todo(ctx: AnyContext):
+    todo_file_path = os.path.join(TODO_DIR, "todo.txt")
+    todo_list: list[TodoTaskModel] = []
+    todo_list: list[TodoTaskModel] = []
+    if os.path.isfile(todo_file_path):
+        todo_list = load_todo_list(todo_file_path)
+    # Get todo task
+    todo_task = select_todo_task(todo_list, ctx.input.keyword)
+    if todo_task is None:
+        ctx.log_error("Task not found")
+        return
+    if todo_task.completed:
+        ctx.log_error("Task already completed")
+        return
+    # Update todo task
+    todo_task = cascade_todo_task(todo_task)
+    task_id = todo_task.keyval.get("id", "")
+    log_work_path = os.path.join(TODO_DIR, "log-work", f"{task_id}.json")
+    log_work_list = []
+    if os.path.isfile(log_work_path):
+        with open(log_work_path, "r") as f:
+            log_work_list = json.loads(f.read())
+    return get_visual_todo_card(todo_task, log_work_list)
+
+
+@make_task(
+    name="complete-todo",
     input=StrInput(name="keyword", prompt="Task keyword", description="Task Keyword"),
     description="✅ Complete todo",
     group=todo_group,
     alias="complete",
 )
-def todo_complete(ctx: AnyContext):
+def complete_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -105,7 +138,10 @@ def todo_complete(ctx: AnyContext):
     todo_task = select_todo_task(todo_list, ctx.input.keyword)
     if todo_task is None:
         ctx.log_error("Task not found")
-        return get_visual_todo_list(todo_list)
+        return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
+    if todo_task.completed:
+        ctx.log_error("Task already completed")
+        return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
     # Update todo task
     todo_task = cascade_todo_task(todo_task)
     if todo_task.creation_date is not None:
@@ -113,11 +149,43 @@ def todo_complete(ctx: AnyContext):
     todo_task.completed = True
     # Save todo list
     save_todo_list(todo_file_path, todo_list)
-    return get_visual_todo_list(todo_list)
+    return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
 
 
 @make_task(
-    name="todo-log",
+    name="archive-todo",
+    description="📚 Archive todo",
+    group=todo_group,
+    alias="archive",
+)
+def archive_todo(ctx: AnyContext):
+    todo_file_path = os.path.join(TODO_DIR, "todo.txt")
+    todo_list: list[TodoTaskModel] = []
+    if os.path.isfile(todo_file_path):
+        todo_list = load_todo_list(todo_file_path)
+    working_todo_list = [
+        todo_task for todo_task in todo_list if not todo_task.completed
+    ]
+    new_archived_todo_list = [
+        todo_task for todo_task in todo_list if todo_task.completed
+    ]
+    if len(new_archived_todo_list) == 0:
+        ctx.print("No completed task to archive")
+        return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
+    archive_file_path = os.path.join(TODO_DIR, "archive.txt")
+    if not os.path.isdir(TODO_DIR):
+        os.make_dirs(TODO_DIR, exist_ok=True)
+    archived_todo_list = []
+    if os.path.isfile(archive_file_path):
+        archived_todo_list = load_todo_list(archive_file_path)
+    archived_todo_list += new_archived_todo_list
+    save_todo_list(archive_file_path, archived_todo_list)
+    save_todo_list(todo_file_path, working_todo_list)
+    return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
+
+
+@make_task(
+    name="log-todo",
     input=[
         StrInput(name="keyword", prompt="Task keyword", description="Task Keyword"),
         StrInput(
@@ -142,7 +210,7 @@ def todo_complete(ctx: AnyContext):
     group=todo_group,
     alias="log",
 )
-def todo_log(ctx: AnyContext):
+def log_todo(ctx: AnyContext):
     todo_file_path = os.path.join(TODO_DIR, "todo.txt")
     todo_list: list[TodoTaskModel] = []
     if os.path.isfile(todo_file_path):
@@ -151,12 +219,11 @@ def todo_log(ctx: AnyContext):
     todo_task = select_todo_task(todo_list, ctx.input.keyword)
     if todo_task is None:
         ctx.log_error("Task not found")
-        return get_visual_todo_list(todo_list)
+        return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
     # Update todo task
     todo_task = cascade_todo_task(todo_task)
     current_duration = todo_task.keyval.get("duration", "0")
     todo_task.keyval["duration"] = add_durations(current_duration, ctx.input.duration)
-    print(current_duration, todo_task.keyval)
     # Save todo list
     save_todo_list(todo_file_path, todo_list)
     # Add log work
@@ -176,7 +243,7 @@ def todo_log(ctx: AnyContext):
     )
     with open(log_work_file_path, "w") as f:
         f.write(json.dumps(log_work, indent=2))
-    return get_visual_todo_list(todo_list)
+    return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
 
 
 def _get_default_start() -> str:
@@ -184,7 +251,7 @@ def _get_default_start() -> str:
 
 
 @make_task(
-    name="todo-edit",
+    name="edit-todo",
     input=[
         TextInput(
             name="text",
@@ -197,7 +264,7 @@ def _get_default_start() -> str:
     group=todo_group,
     alias="edit",
 )
-def todo_edit(ctx: AnyContext):
+def edit_todo(ctx: AnyContext):
     todo_list = [
         cascade_todo_task(line_to_todo_task(line))
         for line in ctx.input.text.split("\n")
@@ -208,7 +275,7 @@ def todo_edit(ctx: AnyContext):
     with open(todo_file_path, "w") as f:
         f.write(new_content)
     todo_list = load_todo_list(todo_file_path)
-    return get_visual_todo_list(todo_list)
+    return get_visual_todo_list(todo_list, TODO_VISUAL_FILTER)
 
 
 def _get_todo_txt_content() -> str:
@@ -217,3 +284,4 @@ def _get_todo_txt_content() -> str:
         return ""
     with open(todo_file_path, "r") as f:
         return f.read()
+        return f.read()

zrb/config.py

@@ -49,10 +49,14 @@ LOGGING_LEVEL = _get_log_level(os.getenv("ZRB_LOGGING_LEVEL", "WARNING"))
 LOAD_BUILTIN = to_boolean(os.getenv("ZRB_LOAD_BUILTIN", "1"))
 ENV_PREFIX = os.getenv("ZRB_ENV", "")
 SHOW_PROMPT = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
+WARN_UNRECOMMENDED_COMMAND = to_boolean(
+    os.getenv("ZRB_WARN_UNRECOMMENDED_COMMAND", "1")
+)
 SESSION_LOG_DIR = os.getenv(
     "ZRB_SESSION_LOG_DIR", os.path.expanduser(os.path.join("~", ".zrb-session"))
 )
 TODO_DIR = os.getenv("ZRB_TODO_DIR", os.path.expanduser(os.path.join("~", "todo")))
+TODO_VISUAL_FILTER = os.getenv("ZRB_TODO_FILTER", "")
 VERSION = metadata.version("zrb")
 WEB_HTTP_PORT = int(os.getenv("ZRB_WEB_HTTP_PORT", "21213"))
 LLM_MODEL = os.getenv("ZRB_LLM_MODEL", "ollama_chat/llama3.1")
@@ -77,7 +81,7 @@ BANNER = f"""
    zzzzz rr     bbbbbb   {VERSION} Janggala
    _ _ . .  . _ .  _ . . .
 
-A Framework to Enhance Your Workflow
+Your Automation Powerhouse
 
 ☕ Donate at: https://stalchmst.com/donation
 🐙 Submit issues/PR at: https://github.com/state-alchemists/zrb

zrb/input/base_input.py

@@ -14,7 +14,7 @@ class BaseInput(AnyInput):
         prompt: str | None = None,
         default_str: StrAttr = "",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
     ):
         self._name = name
         self._description = description

zrb/input/bool_input.py

@@ -12,7 +12,7 @@ class BoolInput(BaseInput):
         prompt: str | None = None,
         default_str: StrAttr = "False",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
     ):
         super().__init__(
             name=name,

zrb/input/float_input.py

@@ -11,7 +11,7 @@ class FloatInput(BaseInput):
         prompt: str | None = None,
         default_str: StrAttr = "0.0",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
     ):
         super().__init__(
             name=name,

zrb/input/int_input.py

@@ -11,7 +11,7 @@ class IntInput(BaseInput):
         prompt: str | None = None,
         default_str: StrAttr = "0",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
     ):
         super().__init__(
             name=name,

zrb/input/option_input.py

@@ -13,7 +13,7 @@ class OptionInput(BaseInput):
         options: StrListAttr = [],
         default_str: StrAttr = "",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
     ):
         super().__init__(
             name=name,

zrb/input/password_input.py

@@ -13,7 +13,7 @@ class PasswordInput(BaseInput):
         prompt: str | None = None,
         default_str: str | Callable[[AnySharedContext], str] = "",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
     ):
         super().__init__(
             name=name,

zrb/input/text_input.py

@@ -16,7 +16,7 @@ class TextInput(BaseInput):
         prompt: str | None = None,
         default_str: str | Callable[[AnySharedContext], str] = "",
         auto_render: bool = True,
-        allow_empty: bool = True,
+        allow_empty: bool = False,
         editor: str = DEFAULT_EDITOR,
         extension: str = ".txt",
         comment_start: str | None = None,

zrb/runner/web_app.py

@@ -2,7 +2,7 @@ import asyncio
 import os
 import sys
 from datetime import datetime, timedelta
-from typing import Any, Dict, List
+from typing import Any
 
 from zrb.config import BANNER, WEB_HTTP_PORT
 from zrb.context.shared_context import SharedContext
@@ -23,7 +23,7 @@ from zrb.util.group import extract_node_from_args, get_node_path
 def create_app(root_group: AnyGroup, port: int = WEB_HTTP_PORT):
     from contextlib import asynccontextmanager
 
-    from fastapi import FastAPI, HTTPException, Request
+    from fastapi import FastAPI, HTTPException, Query, Request
     from fastapi.responses import FileResponse, HTMLResponse
     from fastapi.staticfiles import StaticFiles
 
@@ -97,7 +97,13 @@ def create_app(root_group: AnyGroup, port: int = WEB_HTTP_PORT):
         raise HTTPException(status_code=404, detail="Not Found")
 
     @app.get("/api/{path:path}", response_model=SessionStateLog | SessionStateLogList)
-    async def get_session(path: str, query_params: Dict[str, Any] = {}):
+    async def get_session(
+        path: str,
+        min_start_query: str = Query(default=None, alias="from"),
+        max_start_query: str = Query(default=None, alias="to"),
+        page: int = Query(default=0, alias="page"),
+        limit: int = Query(default=10, alias="limit"),
+    ):
         """
         Getting existing session or sessions
         """
@@ -106,24 +112,30 @@ def create_app(root_group: AnyGroup, port: int = WEB_HTTP_PORT):
         if isinstance(node, AnyTask) and residual_args:
             if residual_args[0] == "list":
                 task_path = get_node_path(root_group, node)
-                return list_sessions(task_path, query_params)
+                max_start_time = (
+                    datetime.now()
+                    if max_start_query is None
+                    else datetime.strptime(max_start_query, "%Y-%m-%d %H:%M:%S")
+                )
+                min_start_time = (
+                    max_start_time - timedelta(hours=1)
+                    if min_start_query is None
+                    else datetime.strptime(min_start_query, "%Y-%m-%d %H:%M:%S")
+                )
+                return list_sessions(
+                    task_path, min_start_time, max_start_time, page, limit
+                )
             else:
                 return read_session(residual_args[0])
         raise HTTPException(status_code=404, detail="Not Found")
 
     def list_sessions(
-        task_path: List[str], query_params: Dict[str, Any]
+        task_path: list[str],
+        min_start_time: datetime,
+        max_start_time: datetime,
+        page: int,
+        limit: int,
     ) -> SessionStateLogList:
-        max_start_time = datetime.now()
-        if "to" in query_params:
-            max_start_time = datetime.strptime(query_params["to"], "%Y-%m-%d %H:%M:%S")
-        min_start_time = max_start_time - timedelta(hours=1)
-        if "from" in query_params:
-            min_start_time = datetime.strptime(
-                query_params["from"], "%Y-%m-%d %H:%M:%S"
-            )
-        page = int(query_params.get("page", 0))
-        limit = int(query_params.get("limit", 10))
         try:
             return default_session_state_logger.list(
                 task_path,
@@ -142,9 +154,3 @@ def create_app(root_group: AnyGroup, port: int = WEB_HTTP_PORT):
             raise HTTPException(status_code=500, detail=str(e))
 
     return app
-
-
-# async def run_web_server(app: FastAPI, port: int = WEB_HTTP_PORT):
-#     config = Config(app=app, host="0.0.0.0", port=port, loop="asyncio")
-#     server = Server(config)
-#     await server.serve()

zrb/task/any_task.py

@@ -74,6 +74,12 @@ class AnyTask(ABC):
         """Task fallbacks"""
         pass
 
+    @property
+    @abstractmethod
+    def successors(self) -> list["AnyTask"]:
+        """Task successors"""
+        pass
+
     @property
     @abstractmethod
     def readiness_checks(self) -> list["AnyTask"]:
@@ -81,8 +87,38 @@ class AnyTask(ABC):
         pass
 
     @abstractmethod
-    def append_upstreams(self, upstreams: "AnyTask" | list["AnyTask"]):
-        """Sets the upstream tasks that this task depends on.
+    def append_fallback(self, fallbacks: "AnyTask" | list["AnyTask"]):
+        """Add the fallback tasks.
+
+        Args:
+            fallbacks (AnyTask | list[AnyTask]): A single fallback task or
+                a list of fallback tasks.
+        """
+        pass
+
+    @abstractmethod
+    def append_successor(self, successors: "AnyTask" | list["AnyTask"]):
+        """Add the successor tasks.
+
+        Args:
+            successors (AnyTask | list[AnyTask]): A single successor task or
+                a list of successor tasks.
+        """
+        pass
+
+    @abstractmethod
+    def append_readiness_check(self, readiness_checks: "AnyTask" | list["AnyTask"]):
+        """Add the readiness_check tasks.
+
+        Args:
+            readiness_checks (AnyTask | list[AnyTask]): A single readiness_check task or
+                a list of readiness_check tasks.
+        """
+        pass
+
+    @abstractmethod
+    def append_upstream(self, upstreams: "AnyTask" | list["AnyTask"]):
+        """Add the upstream tasks that this task depends on.
 
         Args:
             upstreams (AnyTask | list[AnyTask]): A single upstream task or

zrb/task/base_task.py

@@ -38,6 +38,7 @@ class BaseTask(AnyTask):
         monitor_readiness: bool = False,
         upstream: list[AnyTask] | AnyTask | None = None,
         fallback: list[AnyTask] | AnyTask | None = None,
+        successor: list[AnyTask] | AnyTask | None = None,
     ):
         self._name = name
         self._color = color
@@ -50,6 +51,7 @@ class BaseTask(AnyTask):
         self._retry_period = retry_period
         self._upstreams = upstream
         self._fallbacks = fallback
+        self._successors = successor
         self._readiness_checks = readiness_check
         self._readiness_check_delay = readiness_check_delay
         self._readiness_check_period = readiness_check_period
@@ -65,17 +67,17 @@ class BaseTask(AnyTask):
     def __rshift__(self, other: AnyTask | list[AnyTask]) -> AnyTask:
         try:
             if isinstance(other, AnyTask):
-                other.append_upstreams(self)
+                other.append_upstream(self)
             elif isinstance(other, list):
                 for task in other:
-                    task.append_upstreams(self)
+                    task.append_upstream(self)
             return other
         except Exception as e:
             raise ValueError(f"Invalid operation {self} >> {other}: {e}")
 
     def __lshift__(self, other: AnyTask | list[AnyTask]) -> AnyTask:
         try:
-            self.append_upstreams(other)
+            self.append_upstream(other)
             return self
         except Exception as e:
             raise ValueError(f"Invalid operation {self} << {other}: {e}")
@@ -142,6 +144,44 @@ class BaseTask(AnyTask):
             return [self._fallbacks]
         return self._fallbacks
 
+    def append_fallback(self, fallbacks: AnyTask | list[AnyTask]):
+        fallback_list = [fallbacks] if isinstance(fallbacks, AnyTask) else fallbacks
+        for fallback in fallback_list:
+            self.__append_fallback(fallback)
+
+    def __append_fallback(self, fallback: AnyTask):
+        # Make sure self._fallbacks is a list
+        if self._fallbacks is None:
+            self._fallbacks = []
+        elif isinstance(self._fallbacks, AnyTask):
+            self._fallbacks = [self._fallbacks]
+        # Add fallback if it was not on self._fallbacks
+        if fallback not in self._fallbacks:
+            self._fallbacks.append(fallback)
+
+    @property
+    def successors(self) -> list[AnyTask]:
+        if self._successors is None:
+            return []
+        elif isinstance(self._successors, AnyTask):
+            return [self._successors]
+        return self._successors
+
+    def append_successor(self, successors: AnyTask | list[AnyTask]):
+        successor_list = [successors] if isinstance(successors, AnyTask) else successors
+        for successor in successor_list:
+            self.__append_successor(successor)
+
+    def __append_successor(self, successor: AnyTask):
+        # Make sure self._successors is a list
+        if self._successors is None:
+            self._successors = []
+        elif isinstance(self._successors, AnyTask):
+            self._successors = [self._successors]
+        # Add successor if it was not on self._successors
+        if successor not in self._successors:
+            self._successors.append(successor)
+
     @property
     def readiness_checks(self) -> list[AnyTask]:
         if self._readiness_checks is None:
@@ -150,6 +190,25 @@ class BaseTask(AnyTask):
             return [self._readiness_checks]
         return self._readiness_checks
 
+    def append_readiness_check(self, readiness_checks: AnyTask | list[AnyTask]):
+        readiness_check_list = (
+            [readiness_checks]
+            if isinstance(readiness_checks, AnyTask)
+            else readiness_checks
+        )
+        for readiness_check in readiness_check_list:
+            self.__append_readiness_check(readiness_check)
+
+    def __append_readiness_check(self, readiness_check: AnyTask):
+        # Make sure self._readiness_checks is a list
+        if self._readiness_checks is None:
+            self._readiness_checks = []
+        elif isinstance(self._readiness_checks, AnyTask):
+            self._readiness_checks = [self._readiness_checks]
+        # Add readiness_check if it was not on self._readiness_checks
+        if readiness_check not in self._readiness_checks:
+            self._readiness_checks.append(readiness_check)
+
     @property
     def upstreams(self) -> list[AnyTask]:
         if self._upstreams is None:
@@ -158,7 +217,7 @@ class BaseTask(AnyTask):
             return [self._upstreams]
         return self._upstreams
 
-    def append_upstreams(self, upstreams: AnyTask | list[AnyTask]):
+    def append_upstream(self, upstreams: AnyTask | list[AnyTask]):
         upstream_list = [upstreams] if isinstance(upstreams, AnyTask) else upstreams
         for upstream in upstream_list:
             self.__append_upstream(upstream)
@@ -374,6 +433,7 @@ class BaseTask(AnyTask):
                 # Put result on xcom
                 task_xcom: Xcom = ctx.xcom.get(self.name)
                 task_xcom.push(result)
+                await run_async(self.__exec_successors(session))
                 return result
             except (asyncio.CancelledError, KeyboardInterrupt):
                 ctx.log_info("Marked as failed")
@@ -390,6 +450,13 @@ class BaseTask(AnyTask):
                 await run_async(self.__exec_fallbacks(session))
                 raise e
 
+    async def __exec_successors(self, session: AnySession) -> Any:
+        successors: list[AnyTask] = self.successors
+        successor_coros = [
+            run_async(successor.exec_chain(session)) for successor in successors
+        ]
+        await asyncio.gather(*successor_coros)
+
     async def __exec_fallbacks(self, session: AnySession) -> Any:
         fallbacks: list[AnyTask] = self.fallbacks
         fallback_coros = [