falyx 0.1.22__py3-none-any.whl → 0.1.24__py3-none-any.whl

falyx/falyx.py

@@ -51,12 +51,13 @@ from falyx.exceptions import (
 )
 from falyx.execution_registry import ExecutionRegistry as er
 from falyx.hook_manager import Hook, HookManager, HookType
+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.themes.colors import OneColors, get_nord_theme
-from falyx.utils import CaseInsensitiveDict, chunks, get_program_invocation, logger
+from falyx.utils import CaseInsensitiveDict, chunks, get_program_invocation
 from falyx.version import __version__
 
 
@@ -78,7 +79,8 @@ class Falyx:
     Key Features:
     - Interactive menu with Rich rendering and Prompt Toolkit input handling
     - Dynamic command management with alias and abbreviation matching
-    - Full lifecycle hooks (before, success, error, after, teardown) at both menu and command levels
+    - Full lifecycle hooks (before, success, error, after, teardown) at both menu and
+      command levels
     - Built-in retry support, spinner visuals, and confirmation prompts
     - Submenu nesting and action chaining
     - History tracking, help generation, and run key execution modes
@@ -99,12 +101,14 @@ class Falyx:
         force_confirm (bool): Seed default for `OptionsManager["force_confirm"]`
         cli_args (Namespace | None): Parsed CLI arguments, usually from argparse.
         options (OptionsManager | None): Declarative option mappings.
-        custom_table (Callable[[Falyx], Table] | Table | None): Custom menu table generator.
+        custom_table (Callable[[Falyx], Table] | Table | None): Custom menu table
+                                                                generator.
 
     Methods:
-        run(): Main entry point for CLI argument-based workflows. Most users will use this.
+        run(): Main entry point for CLI argument-based workflows. Suggested for
+               most use cases.
         menu(): Run the interactive menu loop.
-        run_key(command_key, return_context): Run a command directly without showing the menu.
+        run_key(command_key, return_context): Run a command directly without the menu.
         add_command(): Add a single command to the menu.
         add_commands(): Add multiple commands at once.
         register_all_hooks(): Register hooks across all commands and submenus.
@@ -184,8 +188,10 @@ class Falyx:
 
     @property
     def _name_map(self) -> dict[str, Command]:
-        """Builds a mapping of all valid input names (keys, aliases, normalized names) to Command objects.
-        If a collision occurs, logs a warning and keeps the first registered command.
+        """
+        Builds a mapping of all valid input names (keys, aliases, normalized names) to
+        Command objects. If a collision occurs, logs a warning and keeps the first
+        registered command.
         """
         mapping: dict[str, Command] = {}
 
@@ -195,8 +201,11 @@ class Falyx:
                 existing = mapping[norm]
                 if existing is not cmd:
                     logger.warning(
-                        f"[alias conflict] '{name}' already assigned to '{existing.description}'."
-                        f" Skipping for '{cmd.description}'."
+                        "[alias conflict] '%s' already assigned to '%s'. "
+                        "Skipping for '%s'.",
+                        name,
+                        existing.description,
+                        cmd.description,
                     )
             else:
                 mapping[norm] = cmd
@@ -238,7 +247,7 @@ class Falyx:
             key="Y",
             description="History",
             aliases=["HISTORY"],
-            action=er.get_history_action(),
+            action=Action(name="View Execution History", action=er.summary),
             style=OneColors.DARK_YELLOW,
         )
 
@@ -283,7 +292,8 @@ class Falyx:
         self.console.print(table, justify="center")
         if self.mode == FalyxMode.MENU:
             self.console.print(
-                f"📦 Tip: '[{OneColors.LIGHT_YELLOW}]?[KEY][/]' to preview a command before running it.\n",
+                f"📦 Tip: '[{OneColors.LIGHT_YELLOW}]?[KEY][/]' to preview a command "
+                "before running it.\n",
                 justify="center",
             )
 
@@ -291,7 +301,7 @@ class Falyx:
         """Returns the help command for the menu."""
         return Command(
             key="H",
-            aliases=["HELP"],
+            aliases=["HELP", "?"],
             description="Help",
             action=self._show_help,
             style=OneColors.LIGHT_YELLOW,
@@ -346,7 +356,7 @@ class Falyx:
             is_preview, choice = self.get_command(text, from_validate=True)
             if is_preview and choice is None:
                 return True
-            return True if choice else False
+            return bool(choice)
 
         return Validator.from_callable(
             validator,
@@ -444,43 +454,10 @@ class Falyx:
 
     def debug_hooks(self) -> None:
         """Logs the names of all hooks registered for the menu and its commands."""
-
-        def hook_names(hook_list):
-            return [hook.__name__ for hook in hook_list]
-
-        logger.debug(
-            "Menu-level before hooks: "
-            f"{hook_names(self.hooks._hooks[HookType.BEFORE])}"
-        )
-        logger.debug(
-            f"Menu-level success hooks: {hook_names(self.hooks._hooks[HookType.ON_SUCCESS])}"
-        )
-        logger.debug(
-            f"Menu-level error hooks: {hook_names(self.hooks._hooks[HookType.ON_ERROR])}"
-        )
-        logger.debug(
-            f"Menu-level after hooks: {hook_names(self.hooks._hooks[HookType.AFTER])}"
-        )
-        logger.debug(
-            f"Menu-level on_teardown hooks: {hook_names(self.hooks._hooks[HookType.ON_TEARDOWN])}"
-        )
+        logger.debug("Menu-level hooks:\n%s", str(self.hooks))
 
         for key, command in self.commands.items():
-            logger.debug(
-                f"[Command '{key}'] before: {hook_names(command.hooks._hooks[HookType.BEFORE])}"
-            )
-            logger.debug(
-                f"[Command '{key}'] success: {hook_names(command.hooks._hooks[HookType.ON_SUCCESS])}"
-            )
-            logger.debug(
-                f"[Command '{key}'] error: {hook_names(command.hooks._hooks[HookType.ON_ERROR])}"
-            )
-            logger.debug(
-                f"[Command '{key}'] after: {hook_names(command.hooks._hooks[HookType.AFTER])}"
-            )
-            logger.debug(
-                f"[Command '{key}'] on_teardown: {hook_names(command.hooks._hooks[HookType.ON_TEARDOWN])}"
-            )
+            logger.debug("[Command '%s'] hooks:\n%s", key, str(command.hooks))
 
     def is_key_available(self, key: str) -> bool:
         key = key.upper()
@@ -560,10 +537,24 @@ class Falyx:
         self.add_command(key, description, submenu.menu, style=style)
         submenu.update_exit_command(key="B", description="Back", aliases=["BACK"])
 
-    def add_commands(self, commands: list[dict]) -> None:
-        """Adds multiple commands to the menu."""
+    def add_commands(self, commands: list[Command] | list[dict]) -> None:
+        """Adds a list of Command instances or config dicts."""
         for command in commands:
-            self.add_command(**command)
+            if isinstance(command, dict):
+                self.add_command(**command)
+            elif isinstance(command, Command):
+                self.add_command_from_command(command)
+            else:
+                raise FalyxError(
+                    "Command must be a dictionary or an instance of Command."
+                )
+
+    def add_command_from_command(self, command: Command) -> None:
+        """Adds a command to the menu from an existing Command object."""
+        if not isinstance(command, Command):
+            raise FalyxError("command must be an instance of Command.")
+        self._validate_command_key(command.key)
+        self.commands[command.key] = command
 
     def add_command(
         self,
@@ -572,7 +563,7 @@ class Falyx:
         action: BaseAction | Callable[[], Any],
         *,
         args: tuple = (),
-        kwargs: dict[str, Any] = {},
+        kwargs: dict[str, Any] | None = None,
         hidden: bool = False,
         aliases: list[str] | None = None,
         help_text: str = "",
@@ -605,7 +596,7 @@ class Falyx:
             description=description,
             action=action,
             args=args,
-            kwargs=kwargs,
+            kwargs=kwargs if kwargs else {},
             hidden=hidden,
             aliases=aliases if aliases else [],
             help_text=help_text,
@@ -651,20 +642,26 @@ class Falyx:
         bottom_row = []
         if self.history_command:
             bottom_row.append(
-                f"[{self.history_command.key}] [{self.history_command.style}]{self.history_command.description}"
+                f"[{self.history_command.key}] [{self.history_command.style}]"
+                f"{self.history_command.description}"
             )
         if self.help_command:
             bottom_row.append(
-                f"[{self.help_command.key}] [{self.help_command.style}]{self.help_command.description}"
+                f"[{self.help_command.key}] [{self.help_command.style}]"
+                f"{self.help_command.description}"
             )
         bottom_row.append(
-            f"[{self.exit_command.key}] [{self.exit_command.style}]{self.exit_command.description}"
+            f"[{self.exit_command.key}] [{self.exit_command.style}]"
+            f"{self.exit_command.description}"
         )
         return bottom_row
 
     def build_default_table(self) -> Table:
-        """Build the standard table layout. Developers can subclass or call this in custom tables."""
-        table = Table(title=self.title, show_header=False, box=box.SIMPLE, expand=True)
+        """
+        Build the standard table layout. Developers can subclass or call this
+        in custom tables.
+        """
+        table = Table(title=self.title, show_header=False, box=box.SIMPLE, expand=True)  # type: ignore[arg-type]
         visible_commands = [item for item in self.commands.items() if not item[1].hidden]
         for chunk in chunks(visible_commands, self.columns):
             row = []
@@ -694,12 +691,18 @@ class Falyx:
     def get_command(
         self, choice: str, from_validate=False
     ) -> tuple[bool, Command | None]:
-        """Returns the selected command based on user input. Supports keys, aliases, and abbreviations."""
+        """
+        Returns the selected command based on user input.
+        Supports keys, aliases, and abbreviations.
+        """
         is_preview, choice = self.parse_preview_command(choice)
-        if is_preview and not choice:
+        if is_preview and not choice and self.help_command:
+            is_preview = False
+            choice = "?"
+        elif is_preview and not choice:
             if not from_validate:
                 self.console.print(
-                    f"[{OneColors.DARK_RED}]❌ You must enter a command for preview mode.[/]"
+                    f"[{OneColors.DARK_RED}]❌ You must enter a command for preview mode."
                 )
             return is_preview, None
 
@@ -717,7 +720,8 @@ class Falyx:
         if fuzzy_matches:
             if not from_validate:
                 self.console.print(
-                    f"[{OneColors.LIGHT_YELLOW}]⚠️ Unknown command '{choice}'. Did you mean:[/] "
+                    f"[{OneColors.LIGHT_YELLOW}]⚠️ Unknown command '{choice}'. "
+                    "Did you mean:"
                 )
             for match in fuzzy_matches:
                 cmd = name_map[match]
@@ -742,7 +746,7 @@ class Falyx:
         self, selected_command: Command, error: Exception
     ) -> None:
         """Handles errors that occur during the action of the selected command."""
-        logger.exception(f"Error executing '{selected_command.description}': {error}")
+        logger.exception("Error executing '%s': %s", selected_command.description, error)
         self.console.print(
             f"[{OneColors.DARK_RED}]An error occurred while executing "
             f"{selected_command.description}:[/] {error}"
@@ -753,27 +757,27 @@ class Falyx:
         choice = await self.prompt_session.prompt_async()
         is_preview, selected_command = self.get_command(choice)
         if not selected_command:
-            logger.info(f"Invalid command '{choice}'.")
+            logger.info("Invalid command '%s'.", choice)
             return True
 
         if is_preview:
-            logger.info(f"Preview command '{selected_command.key}' selected.")
+            logger.info("Preview command '%s' selected.", selected_command.key)
             await selected_command.preview()
             return True
 
         if selected_command.requires_input:
             program = get_program_invocation()
             self.console.print(
-                f"[{OneColors.LIGHT_YELLOW}]⚠️ Command '{selected_command.key}' requires input "
-                f"and must be run via [{OneColors.MAGENTA}]'{program} run'[{OneColors.LIGHT_YELLOW}] "
-                "with proper piping or arguments.[/]"
+                f"[{OneColors.LIGHT_YELLOW}]⚠️ Command '{selected_command.key}' requires"
+                f" input and must be run via [{OneColors.MAGENTA}]'{program} run"
+                f"'[{OneColors.LIGHT_YELLOW}] with proper piping or arguments.[/]"
             )
             return True
 
         self.last_run_command = selected_command
 
         if selected_command == self.exit_command:
-            logger.info(f"🔙 Back selected: exiting {self.get_title()}")
+            logger.info("🔙 Back selected: exiting %s", self.get_title())
             return False
 
         context = self._create_context(selected_command)
@@ -804,7 +808,7 @@ class Falyx:
             return None
 
         if is_preview:
-            logger.info(f"Preview command '{selected_command.key}' selected.")
+            logger.info("Preview command '%s' selected.", selected_command.key)
             await selected_command.preview()
             return None
 
@@ -823,13 +827,13 @@ class Falyx:
 
             await self.hooks.trigger(HookType.ON_SUCCESS, context)
             logger.info("[run_key] ✅ '%s' complete.", selected_command.description)
-        except (KeyboardInterrupt, EOFError):
+        except (KeyboardInterrupt, EOFError) as error:
             logger.warning(
-                "[run_key] ⚠️ Interrupted by user: ", selected_command.description
+                "[run_key] ⚠️ Interrupted by user: %s", selected_command.description
             )
             raise FalyxError(
                 f"[run_key] ⚠️ '{selected_command.description}' interrupted by user."
-            )
+            ) from error
         except Exception as error:
             context.exception = error
             await self.hooks.trigger(HookType.ON_ERROR, context)
@@ -868,7 +872,8 @@ class Falyx:
                 selected_command.action.set_retry_policy(selected_command.retry_policy)
             else:
                 logger.warning(
-                    f"[Command:{selected_command.key}] Retry requested, but action is not an Action instance."
+                    "[Command:%s] Retry requested, but action is not an Action instance.",
+                    selected_command.key,
                 )
 
     def print_message(self, message: str | Markdown | dict[str, Any]) -> None:
@@ -887,32 +892,33 @@ class Falyx:
 
     async def menu(self) -> None:
         """Runs the menu and handles user input."""
-        logger.info(f"Running menu: {self.get_title()}")
+        logger.info("Running menu: %s", self.get_title())
         self.debug_hooks()
         if self.welcome_message:
             self.print_message(self.welcome_message)
-        while True:
-            if callable(self.render_menu):
-                self.render_menu(self)
-            else:
-                self.console.print(self.table, justify="center")
-            try:
-                task = asyncio.create_task(self.process_command())
-                should_continue = await task
-                if not should_continue:
+        try:
+            while True:
+                if callable(self.render_menu):
+                    self.render_menu(self)
+                else:
+                    self.console.print(self.table, justify="center")
+                try:
+                    task = asyncio.create_task(self.process_command())
+                    should_continue = await task
+                    if not should_continue:
+                        break
+                except (EOFError, KeyboardInterrupt):
+                    logger.info("EOF or KeyboardInterrupt. Exiting menu.")
+                    break
+                except QuitSignal:
+                    logger.info("QuitSignal received. Exiting menu.")
                     break
-            except (EOFError, KeyboardInterrupt):
-                logger.info("EOF or KeyboardInterrupt. Exiting menu.")
-                break
-            except QuitSignal:
-                logger.info("QuitSignal received. Exiting menu.")
-                break
-            except BackSignal:
-                logger.info("BackSignal received.")
-            finally:
-                logger.info(f"Exiting menu: {self.get_title()}")
-                if self.exit_message:
-                    self.print_message(self.exit_message)
+                except BackSignal:
+                    logger.info("BackSignal received.")
+        finally:
+            logger.info("Exiting menu: %s", self.get_title())
+            if self.exit_message:
+                self.print_message(self.exit_message)
 
     async def run(self) -> None:
         """Run Falyx CLI with structured subcommands."""
@@ -946,7 +952,7 @@ class Falyx:
             _, command = self.get_command(self.cli_args.name)
             if not command:
                 self.console.print(
-                    f"[{OneColors.DARK_RED}]❌ Command '{self.cli_args.name}' not found.[/]"
+                    f"[{OneColors.DARK_RED}]❌ Command '{self.cli_args.name}' not found."
                 )
                 sys.exit(1)
             self.console.print(
@@ -961,7 +967,7 @@ class Falyx:
             if is_preview:
                 if command is None:
                     sys.exit(1)
-                logger.info(f"Preview command '{command.key}' selected.")
+                logger.info("Preview command '%s' selected.", command.key)
                 await command.preview()
                 sys.exit(0)
             if not command:
@@ -986,12 +992,14 @@ class Falyx:
             ]
             if not matching:
                 self.console.print(
-                    f"[{OneColors.LIGHT_YELLOW}]⚠️ No commands found with tag: '{self.cli_args.tag}'[/]"
+                    f"[{OneColors.LIGHT_YELLOW}]⚠️ No commands found with tag: "
+                    f"'{self.cli_args.tag}'"
                 )
                 sys.exit(1)
 
             self.console.print(
-                f"[{OneColors.CYAN_b}]🚀 Running all commands with tag:[/] {self.cli_args.tag}"
+                f"[{OneColors.CYAN_b}]🚀 Running all commands with tag:[/] "
+                f"{self.cli_args.tag}"
             )
             for cmd in matching:
                 self._set_retry_policy(cmd)

falyx/hook_manager.py

@@ -7,7 +7,7 @@ from enum import Enum
 from typing import Awaitable, Callable, Dict, List, Optional, Union
 
 from falyx.context import ExecutionContext
-from falyx.utils import logger
+from falyx.logger import logger
 
 Hook = Union[
     Callable[[ExecutionContext], None], Callable[[ExecutionContext], Awaitable[None]]
@@ -34,6 +34,8 @@ class HookType(Enum):
 
 
 class HookManager:
+    """HookManager"""
+
     def __init__(self) -> None:
         self._hooks: Dict[HookType, List[Hook]] = {
             hook_type: [] for hook_type in HookType
@@ -62,8 +64,11 @@ class HookManager:
                     hook(context)
             except Exception as hook_error:
                 logger.warning(
-                    f"⚠️ Hook '{hook.__name__}' raised an exception during '{hook_type}'"
-                    f" for '{context.name}': {hook_error}"
+                    "⚠️ Hook '%s' raised an exception during '%s' for '%s': %s",
+                    hook.__name__,
+                    hook_type,
+                    context.name,
+                    hook_error,
                 )
 
                 if hook_type == HookType.ON_ERROR:
@@ -71,3 +76,15 @@ class HookManager:
                         context.exception, Exception
                     ), "Context exception should be set for ON_ERROR hook"
                     raise context.exception from hook_error
+
+    def __str__(self) -> str:
+        """Return a formatted string of registered hooks grouped by hook type."""
+
+        def format_hook_list(hooks: list[Hook]) -> str:
+            return ", ".join(h.__name__ for h in hooks) if hooks else "—"
+
+        lines = ["<HookManager>"]
+        for hook_type in HookType:
+            hook_list = self._hooks.get(hook_type, [])
+            lines.append(f"  {hook_type.value}: {format_hook_list(hook_list)}")
+        return "\n".join(lines)

falyx/hooks.py

@@ -5,11 +5,13 @@ from typing import Any, Callable
 
 from falyx.context import ExecutionContext
 from falyx.exceptions import CircuitBreakerOpen
+from falyx.logger import logger
 from falyx.themes.colors import OneColors
-from falyx.utils import logger
 
 
 class ResultReporter:
+    """Reports the success of an action."""
+
     def __init__(self, formatter: Callable[[Any], str] | None = None):
         """
         Optional result formatter. If not provided, uses repr(result).
@@ -41,6 +43,8 @@ class ResultReporter:
 
 
 class CircuitBreaker:
+    """Circuit Breaker pattern to prevent repeated failures."""
+
     def __init__(self, max_failures=3, reset_timeout=10):
         self.max_failures = max_failures
         self.reset_timeout = reset_timeout
@@ -55,7 +59,7 @@ class CircuitBreaker:
                     f"🔴 Circuit open for '{name}' until {time.ctime(self.open_until)}."
                 )
             else:
-                logger.info(f"🟢 Circuit closed again for '{name}'.")
+                logger.info("🟢 Circuit closed again for '%s'.")
                 self.failures = 0
                 self.open_until = None
 
@@ -63,15 +67,18 @@ class CircuitBreaker:
         name = context.name
         self.failures += 1
         logger.warning(
-            f"⚠️ CircuitBreaker: '{name}' failure {self.failures}/{self.max_failures}."
+            "⚠️ CircuitBreaker: '%s' failure %s/%s.",
+            name,
+            self.failures,
+            self.max_failures,
         )
         if self.failures >= self.max_failures:
             self.open_until = time.time() + self.reset_timeout
             logger.error(
-                f"🔴 Circuit opened for '{name}' until {time.ctime(self.open_until)}."
+                "🔴 Circuit opened for '%s' until %s.", name, time.ctime(self.open_until)
             )
 
-    def after_hook(self, context: ExecutionContext):
+    def after_hook(self, _: ExecutionContext):
         self.failures = 0
 
     def is_open(self):

falyx/http_action.py

@@ -16,8 +16,8 @@ from rich.tree import Tree
 from falyx.action import Action
 from falyx.context import ExecutionContext, SharedContext
 from falyx.hook_manager import HookManager, HookType
+from falyx.logger import logger
 from falyx.themes.colors import OneColors
-from falyx.utils import logger
 
 
 async def close_shared_http_session(context: ExecutionContext) -> None:
@@ -35,9 +35,9 @@ class HTTPAction(Action):
     """
     An Action for executing HTTP requests using aiohttp with shared session reuse.
 
-    This action integrates seamlessly into Falyx pipelines, with automatic session management,
-    result injection, and lifecycle hook support. It is ideal for CLI-driven API workflows
-    where you need to call remote services and process their responses.
+    This action integrates seamlessly into Falyx pipelines, with automatic session
+    management, result injection, and lifecycle hook support. It is ideal for CLI-driven
+    API workflows where you need to call remote services and process their responses.
 
     Features:
     - Uses aiohttp for asynchronous HTTP requests
@@ -97,7 +97,7 @@ class HTTPAction(Action):
             retry_policy=retry_policy,
         )
 
-    async def _request(self, *args, **kwargs) -> dict[str, Any]:
+    async def _request(self, *_, **__) -> dict[str, Any]:
         if self.shared_context:
             context: SharedContext = self.shared_context
             session = context.get("http_session")
@@ -153,6 +153,7 @@ class HTTPAction(Action):
     def __str__(self):
         return (
             f"HTTPAction(name={self.name!r}, method={self.method!r}, url={self.url!r}, "
-            f"headers={self.headers!r}, params={self.params!r}, json={self.json!r}, data={self.data!r}, "
-            f"retry={self.retry_policy.enabled}, inject_last_result={self.inject_last_result})"
+            f"headers={self.headers!r}, params={self.params!r}, json={self.json!r}, "
+            f"data={self.data!r}, retry={self.retry_policy.enabled}, "
+            f"inject_last_result={self.inject_last_result})"
         )