falyx 0.1.26__py3-none-any.whl → 0.1.27__py3-none-any.whl

falyx/action/__init__.py

@@ -21,6 +21,7 @@ from .menu_action import MenuAction
 from .select_file_action import SelectFileAction
 from .selection_action import SelectionAction
 from .signal_action import SignalAction
+from .user_input_action import UserInputAction
 
 __all__ = [
     "Action",
@@ -38,4 +39,5 @@ __all__ = [
     "SignalAction",
     "FallbackAction",
     "LiteralInputAction",
+    "UserInputAction",
 ]

falyx/action/action_factory.py

@@ -11,6 +11,7 @@ from falyx.hook_manager import HookType
 from falyx.logger import logger
 from falyx.protocols import ActionFactoryProtocol
 from falyx.themes import OneColors
+from falyx.utils import ensure_async
 
 
 class ActionFactoryAction(BaseAction):
@@ -46,6 +47,14 @@ class ActionFactoryAction(BaseAction):
         self.preview_args = preview_args
         self.preview_kwargs = preview_kwargs or {}
 
+    @property
+    def factory(self) -> ActionFactoryProtocol:
+        return self._factory  # type: ignore[return-value]
+
+    @factory.setter
+    def factory(self, value: ActionFactoryProtocol):
+        self._factory = ensure_async(value)
+
     async def _run(self, *args, **kwargs) -> Any:
         updated_kwargs = self._maybe_inject_last_result(kwargs)
         context = ExecutionContext(
@@ -57,7 +66,7 @@ class ActionFactoryAction(BaseAction):
         context.start_timer()
         try:
             await self.hooks.trigger(HookType.BEFORE, context)
-            generated_action = self.factory(*args, **updated_kwargs)
+            generated_action = await self.factory(*args, **updated_kwargs)
             if not isinstance(generated_action, BaseAction):
                 raise TypeError(
                     f"[{self.name}] Factory must return a BaseAction, got "
@@ -94,7 +103,7 @@ class ActionFactoryAction(BaseAction):
         tree = parent.add(label) if parent else Tree(label)
 
         try:
-            generated = self.factory(*self.preview_args, **self.preview_kwargs)
+            generated = await self.factory(*self.preview_args, **self.preview_kwargs)
             if isinstance(generated, BaseAction):
                 await generated.preview(parent=tree)
             else:

falyx/action/menu_action.py

@@ -38,6 +38,7 @@ class MenuAction(BaseAction):
         never_prompt: bool = False,
         include_reserved: bool = True,
         show_table: bool = True,
+        custom_table: Table | None = None,
     ):
         super().__init__(
             name,
@@ -54,8 +55,11 @@ class MenuAction(BaseAction):
         self.prompt_session = prompt_session or PromptSession()
         self.include_reserved = include_reserved
         self.show_table = show_table
+        self.custom_table = custom_table
 
     def _build_table(self) -> Table:
+        if self.custom_table:
+            return self.custom_table
         table = render_table_base(
             title=self.title,
             columns=self.columns,

falyx/action/user_input_action.py

@@ -0,0 +1,94 @@
+from prompt_toolkit import PromptSession
+from prompt_toolkit.validation import Validator
+from rich.console import Console
+from rich.tree import Tree
+
+from falyx.action import BaseAction
+from falyx.context import ExecutionContext
+from falyx.execution_registry import ExecutionRegistry as er
+from falyx.hook_manager import HookType
+from falyx.themes.colors import OneColors
+
+
+class UserInputAction(BaseAction):
+    """
+    Prompts the user for input via PromptSession and returns the result.
+
+    Args:
+        name (str): Action name.
+        prompt_text (str): Prompt text (can include '{last_result}' for interpolation).
+        validator (Validator, optional): Prompt Toolkit validator.
+        console (Console, optional): Rich console for rendering.
+        prompt_session (PromptSession, optional): Reusable prompt session.
+        inject_last_result (bool): Whether to inject last_result into prompt.
+        inject_into (str): Key to use for injection (default: 'last_result').
+    """
+
+    def __init__(
+        self,
+        name: str,
+        *,
+        prompt_text: str = "Input > ",
+        validator: Validator | None = None,
+        console: Console | None = None,
+        prompt_session: PromptSession | None = None,
+        inject_last_result: bool = False,
+    ):
+        super().__init__(
+            name=name,
+            inject_last_result=inject_last_result,
+        )
+        self.prompt_text = prompt_text
+        self.validator = validator
+        self.console = console or Console(color_system="auto")
+        self.prompt_session = prompt_session or PromptSession()
+
+    async def _run(self, *args, **kwargs) -> str:
+        context = ExecutionContext(
+            name=self.name,
+            args=args,
+            kwargs=kwargs,
+            action=self,
+        )
+        context.start_timer()
+        try:
+            await self.hooks.trigger(HookType.BEFORE, context)
+
+            prompt_text = self.prompt_text
+            if self.inject_last_result and self.last_result:
+                prompt_text = prompt_text.format(last_result=self.last_result)
+
+            answer = await self.prompt_session.prompt_async(
+                prompt_text,
+                validator=self.validator,
+            )
+            context.result = answer
+            await self.hooks.trigger(HookType.ON_SUCCESS, context)
+            return answer
+        except Exception as error:
+            context.exception = error
+            await self.hooks.trigger(HookType.ON_ERROR, context)
+            raise
+        finally:
+            context.stop_timer()
+            await self.hooks.trigger(HookType.AFTER, context)
+            await self.hooks.trigger(HookType.ON_TEARDOWN, context)
+            er.record(context)
+
+    async def preview(self, parent: Tree | None = None):
+        label = f"[{OneColors.MAGENTA}]⌨ UserInputAction[/] '{self.name}'"
+        tree = parent.add(label) if parent else Tree(label)
+
+        prompt_text = (
+            self.prompt_text.replace("{last_result}", "<last_result>")
+            if "{last_result}" in self.prompt_text
+            else self.prompt_text
+        )
+        tree.add(f"[dim]Prompt:[/] {prompt_text}")
+        if self.validator:
+            tree.add("[dim]Validator:[/] Yes")
+        if not parent:
+            self.console.print(tree)
+
+    def __str__(self):
+        return f"UserInputAction(name={self.name!r}, prompt={self.prompt!r})"

falyx/command.py

@@ -30,7 +30,6 @@ from falyx.action.action import Action, ActionGroup, BaseAction, ChainedAction
 from falyx.action.io_action import BaseIOAction
 from falyx.context import ExecutionContext
 from falyx.debug import register_debug_hooks
-from falyx.exceptions import FalyxError
 from falyx.execution_registry import ExecutionRegistry as er
 from falyx.hook_manager import HookManager, HookType
 from falyx.logger import logger
@@ -38,8 +37,9 @@ from falyx.options_manager import OptionsManager
 from falyx.prompt_utils import confirm_async, should_prompt_user
 from falyx.retry import RetryPolicy
 from falyx.retry_utils import enable_retries_recursively
+from falyx.signals import CancelSignal
 from falyx.themes import OneColors
-from falyx.utils import _noop, ensure_async
+from falyx.utils import ensure_async
 
 console = Console(color_system="auto")
 
@@ -98,7 +98,7 @@ class Command(BaseModel):
 
     key: str
     description: str
-    action: BaseAction | Callable[[], Any] = _noop
+    action: BaseAction | Callable[[], Any]
     args: tuple = ()
     kwargs: dict[str, Any] = Field(default_factory=dict)
     hidden: bool = False
@@ -205,7 +205,7 @@ class Command(BaseModel):
                 await self.preview()
             if not await confirm_async(self.confirmation_prompt):
                 logger.info("[Command:%s] ❌ Cancelled by user.", self.key)
-                raise FalyxError(f"[Command:{self.key}] Cancelled by confirmation.")
+                raise CancelSignal(f"[Command:{self.key}] Cancelled by confirmation.")
 
         context.start_timer()
 

falyx/execution_registry.py

@@ -100,7 +100,7 @@ class ExecutionRegistry:
 
     @classmethod
     def summary(cls):
-        table = Table(title="[📊] Execution History", expand=True, box=box.SIMPLE)
+        table = Table(title="📊 Execution History", expand=True, box=box.SIMPLE)
 
         table.add_column("Name", style="bold cyan")
         table.add_column("Start", justify="right", style="dim")

falyx/falyx.py

@@ -57,9 +57,9 @@ from falyx.logger import logger
 from falyx.options_manager import OptionsManager
 from falyx.parsers import get_arg_parsers
 from falyx.retry import RetryPolicy
-from falyx.signals import BackSignal, QuitSignal
+from falyx.signals import BackSignal, CancelSignal, QuitSignal
 from falyx.themes import OneColors, get_nord_theme
-from falyx.utils import CaseInsensitiveDict, chunks, get_program_invocation
+from falyx.utils import CaseInsensitiveDict, _noop, chunks, get_program_invocation
 from falyx.version import __version__
 
 
@@ -237,8 +237,9 @@ class Falyx:
     def _get_exit_command(self) -> Command:
         """Returns the back command for the menu."""
         return Command(
-            key="Q",
+            key="X",
             description="Exit",
+            action=Action("Exit", action=_noop),
             aliases=["EXIT", "QUIT"],
             style=OneColors.DARK_RED,
         )
@@ -266,9 +267,9 @@ class Falyx:
                 help_text += " [dim](requires input)[/dim]"
             table.add_row(
                 f"[{command.style}]{command.key}[/]",
-                ", ".join(command.aliases) if command.aliases else "None",
+                ", ".join(command.aliases) if command.aliases else "",
                 help_text,
-                ", ".join(command.tags) if command.tags else "None",
+                ", ".join(command.tags) if command.tags else "",
             )
 
         table.add_row(
@@ -305,7 +306,7 @@ class Falyx:
             key="H",
             aliases=["HELP", "?"],
             description="Help",
-            action=self._show_help,
+            action=Action("Help", self._show_help),
             style=OneColors.LIGHT_YELLOW,
         )
 
@@ -507,18 +508,19 @@ class Falyx:
 
     def update_exit_command(
         self,
-        key: str = "Q",
+        key: str = "X",
         description: str = "Exit",
         aliases: list[str] | None = None,
-        action: Callable[[], Any] = lambda: None,
+        action: Callable[[], Any] | None = None,
         style: str = OneColors.DARK_RED,
         confirm: bool = False,
         confirm_message: str = "Are you sure?",
     ) -> None:
         """Updates the back command of the menu."""
+        self._validate_command_key(key)
+        action = action or Action(description, action=_noop)
         if not callable(action):
             raise InvalidActionError("Action must be a callable.")
-        self._validate_command_key(key)
         self.exit_command = Command(
             key=key,
             description=description,
@@ -537,7 +539,7 @@ class Falyx:
             raise NotAFalyxError("submenu must be an instance of Falyx.")
         self._validate_command_key(key)
         self.add_command(key, description, submenu.menu, style=style)
-        if submenu.exit_command.key == "Q":
+        if submenu.exit_command.key == "X":
             submenu.update_exit_command(key="B", description="Back", aliases=["BACK"])
 
     def add_commands(self, commands: list[Command] | list[dict]) -> None:
@@ -918,6 +920,8 @@ class Falyx:
                     break
                 except BackSignal:
                     logger.info("BackSignal received.")
+                except CancelSignal:
+                    logger.info("CancelSignal received.")
         finally:
             logger.info("Exiting menu: %s", self.get_title())
             if self.exit_message:

falyx/protocols.py

@@ -2,10 +2,10 @@
 """protocols.py"""
 from __future__ import annotations
 
-from typing import Any, Protocol
+from typing import Any, Awaitable, Protocol
 
 from falyx.action.action import BaseAction
 
 
 class ActionFactoryProtocol(Protocol):
-    def __call__(self, *args: Any, **kwargs: Any) -> BaseAction: ...
+    async def __call__(self, *args: Any, **kwargs: Any) -> Awaitable[BaseAction]: ...

falyx/signals.py

@@ -22,3 +22,10 @@ class BackSignal(FlowSignal):
 
     def __init__(self, message: str = "Back signal received."):
         super().__init__(message)
+
+
+class CancelSignal(FlowSignal):
+    """Raised to cancel the current command or action."""
+
+    def __init__(self, message: str = "Cancel signal received."):
+        super().__init__(message)

falyx/utils.py

@@ -48,6 +48,7 @@ def ensure_async(function: Callable[..., T]) -> Callable[..., Awaitable[T]]:
 
     if not callable(function):
         raise TypeError(f"{function} is not callable")
+
     return async_wrapper
 
 

falyx/version.py

@@ -1 +1 @@
-__version__ = "0.1.26"
+__version__ = "0.1.27"

{falyx-0.1.26.dist-info → falyx-0.1.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: falyx
-Version: 0.1.26
+Version: 0.1.27
 Summary: Reliable and introspectable async CLI action framework.
 License: MIT
 Author: Roland Thomas Jr

{falyx-0.1.26.dist-info → falyx-0.1.27.dist-info}/RECORD

@@ -1,25 +1,26 @@
 falyx/.pytyped,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 falyx/__init__.py,sha256=L40665QyjAqHQxHdxxY2_yPeDa4p0LE7Nu_2dkm08Ls,650
 falyx/__main__.py,sha256=g_LwJieofK3DJzCYtpkAMEeOXhzSLQenb7pRVUqcf-Y,2152
-falyx/action/__init__.py,sha256=P3Eh0lE2VunzxqwfLbZKxE6FEcdR_u5OROkDTBYgeP0,904
+falyx/action/__init__.py,sha256=zpOK5g4DybydV8d3QI0Zq52aWaKFPYi-J6szAQTsQ2c,974
 falyx/action/action.py,sha256=CJB9eeeEqBGkZHjMpG24eXHRjouKSfESCI1zWzoE7JQ,32488
-falyx/action/action_factory.py,sha256=qhlx8-BAEiNDJrbzF0HZzipY09Ple6J7FxxNvoBda9Y,4228
+falyx/action/action_factory.py,sha256=qNtEnsbKsNl-WijChbTQYfdI3k14fN-1bzDsGFx8yZI,4517
 falyx/action/http_action.py,sha256=aIieGHyZSkz1ZGay-fwgDYZ0QF17XypAWtKeVAYp5f4,5806
 falyx/action/io_action.py,sha256=zdDq07zSLlaShBQ3ztXTRC6aZL0JoERNZSmvHy1V22w,9718
-falyx/action/menu_action.py,sha256=8qttPuq0AUh_oFaa3A82e19dSl4ZhQ9Y_j5CU7zHAlc,5532
+falyx/action/menu_action.py,sha256=cboCpXyl0fZUxpFsvEPu0dGhFfr_vdfllceQnICA0gU,5683
 falyx/action/select_file_action.py,sha256=hHLhmTSacWaUXhRTeIIiXt8gR7zbjkXJ2MAkKQYCpp4,7799
 falyx/action/selection_action.py,sha256=22rF7UqRrQAMjGIheDqAbUizVMBg9aCl9e4VOLLZZJo,8811
 falyx/action/signal_action.py,sha256=5UMqvzy7fBnLANGwYUWoe1VRhrr7e-yOVeLdOnCBiJo,1350
 falyx/action/types.py,sha256=iVD-bHm1GRXOTIlHOeT_KcDBRZm4Hz5Xzl_BOalvEf4,961
+falyx/action/user_input_action.py,sha256=LSTzC_3TfsfXdz-qV3GlOIGpZWAOgO9J5DnNsHO7ee8,3398
 falyx/bottom_bar.py,sha256=iWxgOKWgn5YmREeZBuGA50FzqzEfz1-Vnqm0V_fhldc,7383
-falyx/command.py,sha256=s7r9aeUYEk9iUNE69JQtlFoPx9AehTxkHMPxpLKVIOA,12238
+falyx/command.py,sha256=CeleZJ039996d6qn895JXagLeh7gMZltx7jABecjSXY,12224
 falyx/config.py,sha256=8dkQfL-Ro-vWw1AcO2fD1PGZ92Cyfnwl885ZlpLkp4Y,9636
 falyx/config_schema.py,sha256=j5GQuHVlaU-VLxLF9t8idZRjqOP9MIKp1hyd9NhpAGU,3124
 falyx/context.py,sha256=FNF-IS7RMDxel2l3kskEqQImZ0mLO6zvGw_xC9cIzgI,10338
 falyx/debug.py,sha256=oWWTLOF8elrx_RGZ1G4pbzfFr46FjB0woFXpVU2wmjU,1567
 falyx/exceptions.py,sha256=Qxp6UScZWEyno-6Lgksrv3s9iwjbr2U-d6hun-_xpc0,798
-falyx/execution_registry.py,sha256=re56TImfL67p30ZlVBjqxz9Nn34SD4gvTlwFVPSzVCM,4712
-falyx/falyx.py,sha256=JvFbq_7tiyW5axGRIy4UDf3s0gBDbw1MZr_ivkUqH3k,40627
+falyx/execution_registry.py,sha256=rctsz0mrIHPToLZqylblVjDdKWdq1x_JBc8GwMP5sJ8,4710
+falyx/falyx.py,sha256=ECL6nDgqxS0s8lzOlMnBOSqwZEsLN0kYzeBCs0lUsYI,40860
 falyx/hook_manager.py,sha256=GuGxVVz9FXrU39Tk220QcsLsMXeut7ZDkGW3hU9GcwQ,2952
 falyx/hooks.py,sha256=IV2nbj5FjY2m3_L7x4mYBnaRDG45E8tWQU90i4butlw,2940
 falyx/init.py,sha256=abcSlPmxVeByLIHdUkNjqtO_tEkO3ApC6f9WbxsSEWg,3393
@@ -28,19 +29,19 @@ falyx/menu.py,sha256=faxGgocqQYY6HtzVbenHaFj8YqsmycBEyziC8Ahzqjo,2870
 falyx/options_manager.py,sha256=dFAnQw543tQ6Xupvh1PwBrhiSWlSACHw8K-sHP_lUh4,2842
 falyx/parsers.py,sha256=hxrBouQEqdgk6aWzNa7UwTg7u55vJffSEUUTiiQoI0U,5602
 falyx/prompt_utils.py,sha256=qgk0bXs7mwzflqzWyFhEOTpKQ_ZtMIqGhKeg-ocwNnE,1542
-falyx/protocols.py,sha256=dXNS-kh-5XB92PE5POy4uJ4KLT0O3ZAoiqw55jgR2IM,306
+falyx/protocols.py,sha256=ejSz18D8Qg63ONdgwbvn2YanKK9bGF0e3Bjxh9y3Buc,334
 falyx/retry.py,sha256=UUzY6FlKobr84Afw7yJO9rj3AIQepDk2fcWs6_1gi6Q,3788
 falyx/retry_utils.py,sha256=EAzc-ECTu8AxKkmlw28ioOW9y-Y9tLQ0KasvSkBRYgs,694
 falyx/selection.py,sha256=l2LLISqgP8xfHdcTAEbTTqs_Bae4-LVUKMN7VQH7tM0,10731
-falyx/signals.py,sha256=4PTuVRB_P_aWfnU8pANqhMxGTLq7TJDEyk9jCp0Bx2c,713
+falyx/signals.py,sha256=PGlc0Cm8DfUB3lCf58u_kwTwm2XUEFQ2joFq0Qc_GXI,906
 falyx/tagged_table.py,sha256=4SV-SdXFrAhy1JNToeBCvyxT-iWVf6cWY7XETTys4n8,1067
 falyx/themes/__init__.py,sha256=1CZhEUCin9cUk8IGYBUFkVvdHRNNJBEFXccHwpUKZCA,284
 falyx/themes/colors.py,sha256=4aaeAHJetmeNInI0Zytg4E3YqKfPFelpf04vtjSvsS8,19776
-falyx/utils.py,sha256=uss-FV8p164pmhoqYtQt8gNp5z8fGbuMAk4dRJ6RopI,6717
+falyx/utils.py,sha256=u3puR4Bh-unNBw9a0V9sw7PDTIzRaNLolap0oz5bVIk,6718
 falyx/validators.py,sha256=t5iyzVpY8tdC4rfhr4isEfWpD5gNTzjeX_Hbi_Uq6sA,1328
-falyx/version.py,sha256=3_QdGLpuk_SDY7k9PpNcHpSTjlPdhadPiEgF82wzkqk,23
-falyx-0.1.26.dist-info/LICENSE,sha256=B0yqgaHuSdhN7T3OBmgQSiDTy8HqT5Oe_dLypRe4Ra4,1073
-falyx-0.1.26.dist-info/METADATA,sha256=Z1v5YL-vgfSBwAaYzcaZI4oUq0ee_3ul2D6jHqbpv_M,5521
-falyx-0.1.26.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-falyx-0.1.26.dist-info/entry_points.txt,sha256=j8owOSl2j1Ss8DtGMnKfgehKaolqnIPhVFHaUBLUnMs,45
-falyx-0.1.26.dist-info/RECORD,,
+falyx/version.py,sha256=vEF032D64gj-9WJp4kp0yS1eFIq4XHIqJr91sJJNwWg,23
+falyx-0.1.27.dist-info/LICENSE,sha256=B0yqgaHuSdhN7T3OBmgQSiDTy8HqT5Oe_dLypRe4Ra4,1073
+falyx-0.1.27.dist-info/METADATA,sha256=rs1IR_MPVQKge3QAZjwHUbh3sOfIutI5qckcMIaVR5w,5521
+falyx-0.1.27.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+falyx-0.1.27.dist-info/entry_points.txt,sha256=j8owOSl2j1Ss8DtGMnKfgehKaolqnIPhVFHaUBLUnMs,45
+falyx-0.1.27.dist-info/RECORD,,