zrb 1.8.10__py3-none-any.whl → 1.21.29__py3-none-any.whl

zrb/input/text_input.py

@@ -1,12 +1,9 @@
-import os
-import subprocess
-import tempfile
 from collections.abc import Callable
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.context.any_shared_context import AnySharedContext
 from zrb.input.base_input import BaseInput
-from zrb.util.file import read_file
+from zrb.util.cli.text import edit_text
 
 
 class TextInput(BaseInput):
@@ -85,24 +82,10 @@ class TextInput(BaseInput):
         comment_prompt_message = (
             f"{self.comment_start}{prompt_message}{self.comment_end}"
         )
-        comment_prompt_message_eol = f"{comment_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(comment_prompt_message_eol.encode())
-            # Pre-fill with default content
-            if default_value:
-                temp_file.write(default_value.encode())
-            temp_file.flush()
-            subprocess.call([self.editor_cmd, temp_file_name])
-            # Read the edited content
-            edited_content = read_file(temp_file_name)
-        parts = [
-            text.strip() for text in edited_content.split(comment_prompt_message, 1)
-        ]
-        edited_content = "\n".join(parts).lstrip()
-        os.remove(temp_file_name)
-        print(f"{prompt_message}: {edited_content}")
-        return edited_content
+        return edit_text(
+            prompt_message=comment_prompt_message,
+            value=default_value,
+            editor=self.editor_cmd,
+            extension=self._extension,
+        )

zrb/runner/cli.py

@@ -1,14 +1,13 @@
 import sys
 from typing import Any
 
-from zrb.config import CFG
+from zrb.config.config import CFG
+from zrb.config.web_auth_config import web_auth_config
 from zrb.context.any_context import AnyContext
 from zrb.context.shared_context import SharedContext
 from zrb.group.any_group import AnyGroup
 from zrb.group.group import Group
-from zrb.runner.common_util import get_run_kwargs
-from zrb.runner.web_app import create_web_app
-from zrb.runner.web_auth_config import web_auth_config
+from zrb.runner.common_util import get_task_str_kwargs
 from zrb.session.session import Session
 from zrb.session_state_logger.session_state_logger_factory import session_state_logger
 from zrb.task.any_task import AnyTask
@@ -39,23 +38,25 @@ class Cli(Group):
     def banner(self) -> str:
         return CFG.BANNER
 
-    def run(self, args: list[str] = []):
-        kwargs, args = self._extract_kwargs_from_args(args)
-        node, node_path, args = extract_node_from_args(self, args)
+    def run(self, str_args: list[str] = []):
+        str_kwargs, str_args = self._extract_kwargs_from_args(str_args)
+        node, node_path, str_args = extract_node_from_args(self, str_args)
         if isinstance(node, AnyGroup):
             self._show_group_info(node)
             return
-        if "h" in kwargs or "help" in kwargs:
+        if "h" in str_kwargs or "help" in str_kwargs:
             self._show_task_info(node)
             return
-        run_kwargs = get_run_kwargs(task=node, args=args, kwargs=kwargs, cli_mode=True)
+        task_str_kwargs = get_task_str_kwargs(
+            task=node, str_args=str_args, str_kwargs=str_kwargs, cli_mode=True
+        )
         try:
-            result = self._run_task(node, args, run_kwargs)
+            result = self._run_task(node, str_args, task_str_kwargs)
             if result is not None:
                 print(result)
             return result
         finally:
-            run_command = self._get_run_command(node_path, run_kwargs)
+            run_command = self._get_run_command(node_path, task_str_kwargs)
             self._print_run_command(run_command)
 
     def _print_run_command(self, run_command: str):
@@ -65,11 +66,14 @@ class Cli(Group):
             file=sys.stderr,
         )
 
-    def _get_run_command(self, node_path: list[str], run_kwargs: dict[str, str]) -> str:
+    def _get_run_command(
+        self, node_path: list[str], task_str_kwargs: dict[str, str]
+    ) -> str:
         parts = [self.name] + node_path
-        if len(run_kwargs) > 0:
+        if len(task_str_kwargs) > 0:
             parts += [
-                self._get_run_command_param(key, val) for key, val in run_kwargs.items()
+                self._get_run_command_param(key, val)
+                for key, val in task_str_kwargs.items()
             ]
         return " ".join(parts)
 
@@ -82,13 +86,9 @@ class Cli(Group):
         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
-        return task.run(Session(shared_ctx=shared_ctx, root_group=self))
+        return task.run(
+            Session(shared_ctx=shared_ctx, root_group=self), str_kwargs=run_kwargs
+        )
 
     def _show_task_info(self, task: AnyTask):
         description = task.description
@@ -151,11 +151,11 @@ class Cli(Group):
                         kwargs[key] = args[i + 1]
                         i += 1  # Skip the next argument as it's a value
                     else:
-                        kwargs[key] = True
+                        kwargs[key] = "true"
             elif arg.startswith("-"):
                 # Handle short flags like -t or -n
                 key = arg[1:]
-                kwargs[key] = True
+                kwargs[key] = "true"
             else:
                 # Anything else is considered a positional argument
                 residual_args.append(arg)
@@ -187,6 +187,8 @@ server_group = cli.add_group(
 async def start_server(_: AnyContext):
     from uvicorn import Config, Server
 
+    from zrb.runner.web_app import create_web_app
+
     app = create_web_app(cli, web_auth_config, session_state_logger)
     server = Server(
         Config(

zrb/runner/common_util.py

@@ -1,31 +1,36 @@
-from typing import Any
-
 from zrb.context.shared_context import SharedContext
 from zrb.task.any_task import AnyTask
 
 
-def get_run_kwargs(
-    task: AnyTask, args: list[str], kwargs: dict[str, str], cli_mode: bool
+def get_task_str_kwargs(
+    task: AnyTask, str_args: list[str], str_kwargs: dict[str, str], cli_mode: bool
 ) -> dict[str, str]:
     arg_index = 0
-    str_kwargs = {key: f"{val}" for key, val in kwargs.items()}
-    run_kwargs = {**str_kwargs}
-    shared_ctx = SharedContext(args=args)
+    dummmy_shared_ctx = SharedContext()
+    task_str_kwargs = {}
     for task_input in task.inputs:
+        task_name = task_input.name
         if task_input.name in str_kwargs:
-            # Update shared context for next input default value
-            task_input.update_shared_context(shared_ctx, str_kwargs[task_input.name])
-        elif arg_index < len(args) and task_input.allow_positional_parsing:
-            run_kwargs[task_input.name] = args[arg_index]
-            # Update shared context for next input default value
-            task_input.update_shared_context(shared_ctx, run_kwargs[task_input.name])
+            task_str_kwargs[task_input.name] = str_kwargs[task_name]
+            # Update dummy shared context for next input default value
+            task_input.update_shared_context(
+                dummmy_shared_ctx, str_value=str_kwargs[task_name]
+            )
+        elif arg_index < len(str_args) and task_input.allow_positional_parsing:
+            task_str_kwargs[task_name] = str_args[arg_index]
+            # Update dummy shared context for next input default value
+            task_input.update_shared_context(
+                dummmy_shared_ctx, str_value=task_str_kwargs[task_name]
+            )
             arg_index += 1
         else:
             if cli_mode and task_input.always_prompt:
-                str_value = task_input.prompt_cli_str(shared_ctx)
+                str_value = task_input.prompt_cli_str(dummmy_shared_ctx)
             else:
-                str_value = task_input.get_default_str(shared_ctx)
-            run_kwargs[task_input.name] = str_value
-            # Update shared context for next input default value
-            task_input.update_shared_context(shared_ctx, run_kwargs[task_input.name])
-    return run_kwargs
+                str_value = task_input.get_default_str(dummmy_shared_ctx)
+            task_str_kwargs[task_name] = str_value
+            # Update dummy shared context for next input default value
+            task_input.update_shared_context(
+                dummmy_shared_ctx, str_value=task_str_kwargs[task_name]
+            )
+    return task_str_kwargs

zrb/runner/web_app.py

@@ -2,9 +2,9 @@ import asyncio
 import sys
 from typing import TYPE_CHECKING
 
-from zrb.config import CFG
+from zrb.config.config import CFG
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_route.docs_route import serve_docs
 from zrb.runner.web_route.error_page.serve_default_404 import serve_default_404
 from zrb.runner.web_route.home_page.home_page_route import serve_home_page
@@ -39,7 +39,7 @@ def create_web_app(
     async def lifespan(app: FastAPI):
         capitalized_group_name = CFG.ROOT_GROUP_NAME.capitalize()
         for line in CFG.BANNER.split("\n") + [
-            f"{capitalized_group_name} Server running on http://localhost:{web_auth_config.port}"
+            f"{capitalized_group_name} Server running on http://localhost:{CFG.WEB_HTTP_PORT}"
         ]:
             print(line, file=sys.stderr)
         yield

zrb/runner/web_route/docs_route.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 
 if TYPE_CHECKING:
     # We want fastapi to only be loaded when necessary to decrease footprint

zrb/runner/web_route/error_page/serve_default_404.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_route.error_page.show_error_page import show_error_page
 from zrb.runner.web_util.user import get_user_from_request
 

zrb/runner/web_route/error_page/show_error_page.py

@@ -1,6 +1,6 @@
 import os
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_schema.user import User
 from zrb.runner.web_util.html import get_html_auth_link

zrb/runner/web_route/home_page/home_page_route.py

@@ -1,9 +1,9 @@
 import os
 from typing import TYPE_CHECKING
 
-from zrb.config import CFG
+from zrb.config.config import CFG
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.html import (
     get_html_auth_link,
     get_html_subgroup_info,

zrb/runner/web_route/login_api_route.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING, Annotated
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.cookie import set_auth_cookie
 from zrb.runner.web_util.token import generate_tokens_by_credentials
 

zrb/runner/web_route/login_page/login_page_route.py

@@ -1,9 +1,9 @@
 import os
 from typing import TYPE_CHECKING
 
-from zrb.config import CFG
+from zrb.config.config import CFG
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.html import get_html_auth_link
 from zrb.runner.web_util.user import get_user_from_request
 from zrb.util.file import read_file

zrb/runner/web_route/logout_api_route.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 
 if TYPE_CHECKING:
     # We want fastapi to only be loaded when necessary to decrease footprint

zrb/runner/web_route/logout_page/logout_page_route.py

@@ -1,9 +1,9 @@
 import os
 from typing import TYPE_CHECKING
 
-from zrb.config import CFG
+from zrb.config.config import CFG
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_util.html import get_html_auth_link
 from zrb.runner.web_util.user import get_user_from_request
 from zrb.util.file import read_file

zrb/runner/web_route/node_page/group/show_group_page.py

@@ -1,6 +1,6 @@
 import os
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_schema.user import User
 from zrb.runner.web_util.html import (

zrb/runner/web_route/node_page/node_page_route.py

@@ -1,9 +1,9 @@
 import os
 from typing import TYPE_CHECKING
 
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.context.shared_context import SharedContext
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_route.error_page.show_error_page import show_error_page
 from zrb.runner.web_route.node_page.group.show_group_page import show_group_page
 from zrb.runner.web_route.node_page.task.show_task_page import show_task_page

zrb/runner/web_route/node_page/task/show_task_page.py

@@ -1,7 +1,7 @@
 import json
 import os
 
-from zrb.config import CFG
+from zrb.config.config import CFG
 from zrb.group.any_group import AnyGroup
 from zrb.runner.web_schema.user import User
 from zrb.runner.web_util.html import get_html_auth_link

zrb/runner/web_route/refresh_token_api_route.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.runner.web_schema.token import RefreshTokenRequest
 from zrb.runner.web_util.cookie import set_auth_cookie
 from zrb.runner.web_util.token import regenerate_tokens

zrb/runner/web_route/static/static_route.py

@@ -1,7 +1,7 @@
 import os
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.util.file import read_file
 
 if TYPE_CHECKING:

zrb/runner/web_route/task_input_api_route.py

@@ -1,9 +1,9 @@
 import json
 from typing import TYPE_CHECKING
 
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.group.any_group import AnyGroup
-from zrb.runner.common_util import get_run_kwargs
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.runner.common_util import get_task_str_kwargs
 from zrb.runner.web_util.user import get_user_from_request
 from zrb.task.any_task import AnyTask
 from zrb.util.group import NodeNotFoundError, extract_node_from_args
@@ -39,9 +39,9 @@ def serve_task_input_api(
         if isinstance(task, AnyTask):
             if not user.can_access_task(task):
                 return JSONResponse(content={"detail": "Forbidden"}, status_code=403)
-            query_dict = json.loads(query)
-            run_kwargs = get_run_kwargs(
-                task=task, args=[], kwargs=query_dict, cli_mode=False
+            str_kwargs = json.loads(query)
+            task_str_kwargs = get_task_str_kwargs(
+                task=task, str_args=[], str_kwargs=str_kwargs, cli_mode=False
             )
-            return run_kwargs
+            return task_str_kwargs
         return JSONResponse(content={"detail": "Not found"}, status_code=404)

zrb/runner/web_route/task_session_api_route.py

@@ -1,24 +1,25 @@
 import asyncio
-import os
 from datetime import datetime, timedelta
 from typing import TYPE_CHECKING, Any
 
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.context.shared_context import SharedContext
 from zrb.group.any_group import AnyGroup
-from zrb.runner.web_auth_config import WebAuthConfig
 from zrb.runner.web_schema.session import NewSessionResponse
 from zrb.runner.web_util.user import get_user_from_request
 from zrb.session.session import Session
-from zrb.session_state_log.session_state_log import SessionStateLog, SessionStateLogList
 from zrb.session_state_logger.any_session_state_logger import AnySessionStateLogger
 from zrb.task.any_task import AnyTask
 from zrb.util.group import NodeNotFoundError, extract_node_from_args, get_node_path
 
 if TYPE_CHECKING:
-    # We want fastapi to only be loaded when necessary to decrease footprint
-
     from fastapi import FastAPI
 
+    from zrb.session_state_log.session_state_log import (
+        SessionStateLog,
+        SessionStateLogList,
+    )
+
 
 def serve_task_session_api(
     app: "FastAPI",
@@ -30,6 +31,11 @@ def serve_task_session_api(
     from fastapi import Query, Request
     from fastapi.responses import JSONResponse
 
+    from zrb.session_state_log.session_state_log import (
+        SessionStateLog,
+        SessionStateLogList,
+    )
+
     @app.post("/api/v1/task-sessions/{path:path}")
     async def create_new_task_session_api(
         path: str,
@@ -50,9 +56,7 @@ def serve_task_session_api(
                 return JSONResponse(content={"detail": "Forbidden"}, status_code=403)
             session_name = residual_args[0] if residual_args else None
             if not session_name:
-                shared_ctx = SharedContext(
-                    env={**dict(os.environ), "_ZRB_WEB_ENV": "1"}
-                )
+                shared_ctx = SharedContext(is_web_mode=True)
                 session = Session(shared_ctx=shared_ctx, root_group=root_group)
                 coro = asyncio.create_task(task.async_run(session, str_kwargs=inputs))
                 coroutines.append(coro)
@@ -110,8 +114,10 @@ def serve_task_session_api(
 
 
 def sanitize_session_state_log_list(
-    task: AnyTask, session_state_log_list: SessionStateLogList
-) -> SessionStateLogList:
+    task: AnyTask, session_state_log_list: "SessionStateLogList"
+) -> "SessionStateLogList":
+    from zrb.session_state_log.session_state_log import SessionStateLogList
+
     return SessionStateLogList(
         total=session_state_log_list.total,
         data=[
@@ -122,8 +128,8 @@ def sanitize_session_state_log_list(
 
 
 def sanitize_session_state_log(
-    task: AnyTask, session_state_log: SessionStateLog
-) -> SessionStateLog:
+    task: AnyTask, session_state_log: "SessionStateLog"
+) -> "SessionStateLog":
     """
     In session, we create snake_case aliases of inputs.
     The purpose was to increase ergonomics, so that user can use `input.system_prompt`
@@ -131,6 +137,8 @@ def sanitize_session_state_log(
     However, when we serve the session through HTTP API,
     we only want to show the original input names.
     """
+    from zrb.session_state_log.session_state_log import SessionStateLog
+
     enhanced_inputs = session_state_log.input
     real_inputs = {}
     for real_input in task.inputs:

zrb/runner/web_util/cookie.py

@@ -1,7 +1,7 @@
 from datetime import datetime, timedelta, timezone
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.runner.web_schema.token import Token
 
 if TYPE_CHECKING:

zrb/runner/web_util/token.py

@@ -1,6 +1,6 @@
 from datetime import datetime, timedelta, timezone
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.runner.web_schema.token import Token
 from zrb.runner.web_util.user import get_user_by_credentials
 

zrb/runner/web_util/user.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-from zrb.runner.web_auth_config import WebAuthConfig
+from zrb.config.web_auth_config import WebAuthConfig
 from zrb.runner.web_schema.user import User
 
 if TYPE_CHECKING:
@@ -19,7 +19,7 @@ def get_user_by_credentials(
 
 async def get_user_from_request(
     web_auth_config: WebAuthConfig, request: "Request"
-) -> User | None:
+) -> User:
     from fastapi.security import OAuth2PasswordBearer
 
     if not web_auth_config.enable_auth:
@@ -45,7 +45,11 @@ def _get_user_from_cookie(
     return None
 
 
-def _get_user_from_token(web_auth_config: WebAuthConfig, token: str) -> User | None:
+def _get_user_from_token(
+    web_auth_config: WebAuthConfig, token: str | None
+) -> User | None:
+    if token is None:
+        return None
     try:
         from jose import jwt
 
@@ -54,7 +58,7 @@ def _get_user_from_token(web_auth_config: WebAuthConfig, token: str) -> User | N
             web_auth_config.secret_key,
             options={"require_sub": True, "require_exp": True},
         )
-        username: str = payload.get("sub")
+        username: str | None = payload.get("sub")
         if username is None:
             return None
         user = web_auth_config.find_user_by_username(username)