falyx 0.1.23__tar.gz → 0.1.24__tar.gz

{falyx-0.1.23 → falyx-0.1.24}/PKG-INFO

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

{falyx-0.1.23 → falyx-0.1.24}/falyx/action.py

@@ -4,7 +4,8 @@
 Core action system for Falyx.
 
 This module defines the building blocks for executable actions and workflows,
-providing a structured way to compose, execute, recover, and manage sequences of operations.
+providing a structured way to compose, execute, recover, and manage sequences of
+operations.
 
 All actions are callable and follow a unified signature:
     result = action(*args, **kwargs)
@@ -14,7 +15,8 @@ Core guarantees:
 - Consistent timing and execution context tracking for each run.
 - Unified, predictable result handling and error propagation.
 - Optional last_result injection to enable flexible, data-driven workflows.
-- Built-in support for retries, rollbacks, parallel groups, chaining, and fallback recovery.
+- Built-in support for retries, rollbacks, parallel groups, chaining, and fallback
+  recovery.
 
 Key components:
 - Action: wraps a function or coroutine into a standard executable unit.
@@ -43,10 +45,11 @@ from falyx.debug import register_debug_hooks
 from falyx.exceptions import EmptyChainError
 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.retry import RetryHandler, RetryPolicy
 from falyx.themes.colors import OneColors
-from falyx.utils import ensure_async, logger
+from falyx.utils import ensure_async
 
 
 class BaseAction(ABC):
@@ -55,7 +58,8 @@ class BaseAction(ABC):
     complex actions like `ChainedAction` or `ActionGroup`. They can also
     be run independently or as part of Falyx.
 
-    inject_last_result (bool): Whether to inject the previous action's result into kwargs.
+    inject_last_result (bool): Whether to inject the previous action's result
+                               into kwargs.
     inject_into (str): The name of the kwarg key to inject the result as
                                  (default: 'last_result').
     _requires_injection (bool): Whether the action requires input injection.
@@ -104,7 +108,9 @@ class BaseAction(ABC):
         self.shared_context = shared_context
 
     def get_option(self, option_name: str, default: Any = None) -> Any:
-        """Resolve an option from the OptionsManager if present, otherwise use the fallback."""
+        """
+        Resolve an option from the OptionsManager if present, otherwise use the fallback.
+        """
         if self.options_manager:
             return self.options_manager.get(option_name, default)
         return default
@@ -288,8 +294,10 @@ class Action(BaseAction):
 
     def __str__(self):
         return (
-            f"Action(name={self.name!r}, action={getattr(self._action, '__name__', repr(self._action))}, "
-            f"args={self.args!r}, kwargs={self.kwargs!r}, retry={self.retry_policy.enabled})"
+            f"Action(name={self.name!r}, action="
+            f"{getattr(self._action, '__name__', repr(self._action))}, "
+            f"args={self.args!r}, kwargs={self.kwargs!r}, "
+            f"retry={self.retry_policy.enabled})"
         )
 
 
@@ -309,7 +317,7 @@ class LiteralInputAction(Action):
     def __init__(self, value: Any):
         self._value = value
 
-        async def literal(*args, **kwargs):
+        async def literal(*_, **__):
             return value
 
         super().__init__("Input", literal)
@@ -333,14 +341,16 @@ class LiteralInputAction(Action):
 
 class FallbackAction(Action):
     """
-    FallbackAction provides a default value if the previous action failed or returned None.
+    FallbackAction provides a default value if the previous action failed or
+    returned None.
 
     It injects the last result and checks:
     - If last_result is not None, it passes it through unchanged.
     - If last_result is None (e.g., due to failure), it replaces it with a fallback value.
 
     Used in ChainedAction pipelines to gracefully recover from errors or missing data.
-    When activated, it consumes the preceding error and allows the chain to continue normally.
+    When activated, it consumes the preceding error and allows the chain to continue
+    normally.
 
     Args:
         fallback (Any): The fallback value to use if last_result is None.
@@ -413,16 +423,19 @@ class ChainedAction(BaseAction, ActionListMixin):
     - Rolls back all previously executed actions if a failure occurs.
     - Handles literal values with LiteralInputAction.
 
-    Best used for defining robust, ordered workflows where each step can depend on previous results.
+    Best used for defining robust, ordered workflows where each step can depend on
+    previous results.
 
     Args:
         name (str): Name of the chain.
         actions (list): List of actions or literals to execute.
         hooks (HookManager, optional): Hooks for lifecycle events.
-        inject_last_result (bool, optional): Whether to inject last results into kwargs by default.
+        inject_last_result (bool, optional): Whether to inject last results into kwargs
+                                             by default.
         inject_into (str, optional): Key name for injection.
         auto_inject (bool, optional): Auto-enable injection for subsequent actions.
-        return_list (bool, optional): Whether to return a list of all results. False returns the last result.
+        return_list (bool, optional): Whether to return a list of all results. False
+                                      returns the last result.
     """
 
     def __init__(
@@ -468,7 +481,7 @@ class ChainedAction(BaseAction, ActionListMixin):
         if not self.actions:
             raise EmptyChainError(f"[{self.name}] No actions to execute.")
 
-        shared_context = SharedContext(name=self.name)
+        shared_context = SharedContext(name=self.name, action=self)
         if self.shared_context:
             shared_context.add_result(self.shared_context.last_result())
         updated_kwargs = self._maybe_inject_last_result(kwargs)
@@ -503,7 +516,8 @@ class ChainedAction(BaseAction, ActionListMixin):
                         self.actions[index + 1], FallbackAction
                     ):
                         logger.warning(
-                            "[%s] ⚠️ Fallback triggered: %s, recovering with fallback '%s'.",
+                            "[%s] ⚠️ Fallback triggered: %s, recovering with fallback "
+                            "'%s'.",
                             self.name,
                             error,
                             self.actions[index + 1].name,
@@ -579,7 +593,8 @@ class ChainedAction(BaseAction, ActionListMixin):
 
     def __str__(self):
         return (
-            f"ChainedAction(name={self.name!r}, actions={[a.name for a in self.actions]!r}, "
+            f"ChainedAction(name={self.name!r}, "
+            f"actions={[a.name for a in self.actions]!r}, "
             f"auto_inject={self.auto_inject}, return_list={self.return_list})"
         )
 
@@ -613,7 +628,8 @@ class ActionGroup(BaseAction, ActionListMixin):
         name (str): Name of the chain.
         actions (list): List of actions or literals to execute.
         hooks (HookManager, optional): Hooks for lifecycle events.
-        inject_last_result (bool, optional): Whether to inject last results into kwargs by default.
+        inject_last_result (bool, optional): Whether to inject last results into kwargs
+                                             by default.
         inject_into (str, optional): Key name for injection.
     """
 
@@ -643,7 +659,8 @@ class ActionGroup(BaseAction, ActionListMixin):
             return Action(name=action.__name__, action=action)
         else:
             raise TypeError(
-                f"ActionGroup only accepts BaseAction or callable, got {type(action).__name__}"
+                "ActionGroup only accepts BaseAction or callable, got "
+                f"{type(action).__name__}"
             )
 
     def add_action(self, action: BaseAction | Any) -> None:
@@ -653,7 +670,7 @@ class ActionGroup(BaseAction, ActionListMixin):
             action.register_teardown(self.hooks)
 
     async def _run(self, *args, **kwargs) -> list[tuple[str, Any]]:
-        shared_context = SharedContext(name=self.name, is_parallel=True)
+        shared_context = SharedContext(name=self.name, action=self, is_parallel=True)
         if self.shared_context:
             shared_context.set_shared_result(self.shared_context.last_result())
         updated_kwargs = self._maybe_inject_last_result(kwargs)
@@ -721,8 +738,8 @@ class ActionGroup(BaseAction, ActionListMixin):
 
     def __str__(self):
         return (
-            f"ActionGroup(name={self.name!r}, actions={[a.name for a in self.actions]!r}, "
-            f"inject_last_result={self.inject_last_result})"
+            f"ActionGroup(name={self.name!r}, actions={[a.name for a in self.actions]!r},"
+            f" inject_last_result={self.inject_last_result})"
         )
 
 
@@ -831,6 +848,7 @@ class ProcessAction(BaseAction):
 
     def __str__(self) -> str:
         return (
-            f"ProcessAction(name={self.name!r}, action={getattr(self.action, '__name__', repr(self.action))}, "
+            f"ProcessAction(name={self.name!r}, "
+            f"action={getattr(self.action, '__name__', repr(self.action))}, "
             f"args={self.args!r}, kwargs={self.kwargs!r})"
         )

{falyx-0.1.23 → falyx-0.1.24}/falyx/action_factory.py

@@ -1,4 +1,5 @@
 # Falyx CLI Framework — (c) 2025 rtj.dev LLC — MIT Licensed
+"""action_factory.py"""
 from typing import Any
 
 from rich.tree import Tree
@@ -7,6 +8,7 @@ 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.logger import logger
 from falyx.protocols import ActionFactoryProtocol
 from falyx.themes.colors import OneColors
 
@@ -33,7 +35,7 @@ class ActionFactoryAction(BaseAction):
         inject_last_result: bool = False,
         inject_into: str = "last_result",
         preview_args: tuple[Any, ...] = (),
-        preview_kwargs: dict[str, Any] = {},
+        preview_kwargs: dict[str, Any] | None = None,
     ):
         super().__init__(
             name=name,
@@ -42,7 +44,7 @@ class ActionFactoryAction(BaseAction):
         )
         self.factory = factory
         self.preview_args = preview_args
-        self.preview_kwargs = preview_kwargs
+        self.preview_kwargs = preview_kwargs or {}
 
     async def _run(self, *args, **kwargs) -> Any:
         updated_kwargs = self._maybe_inject_last_result(kwargs)
@@ -58,10 +60,20 @@ class ActionFactoryAction(BaseAction):
             generated_action = self.factory(*args, **updated_kwargs)
             if not isinstance(generated_action, BaseAction):
                 raise TypeError(
-                    f"[{self.name}] Factory must return a BaseAction, got {type(generated_action).__name__}"
+                    f"[{self.name}] Factory must return a BaseAction, got "
+                    f"{type(generated_action).__name__}"
                 )
             if self.shared_context:
                 generated_action.set_shared_context(self.shared_context)
+                if hasattr(generated_action, "register_teardown") and callable(
+                    generated_action.register_teardown
+                ):
+                    generated_action.register_teardown(self.shared_context.action.hooks)
+                    logger.debug(
+                        "[%s] Registered teardown for %s",
+                        self.name,
+                        generated_action.name,
+                    )
             if self.options_manager:
                 generated_action.set_options_manager(self.options_manager)
             context.result = await generated_action(*args, **kwargs)

{falyx-0.1.23 → falyx-0.1.24}/falyx/bottom_bar.py

@@ -146,7 +146,7 @@ class BottomBar:
         for k in (key.upper(), key.lower()):
 
             @self.key_bindings.add(k)
-            def _(event):
+            def _(_):
                 toggle_state()
 
     def add_toggle_from_option(
@@ -204,6 +204,6 @@ class BottomBar:
         """Render the bottom bar."""
         lines = []
         for chunk in chunks(self._named_items.values(), self.columns):
-            lines.extend([fn for fn in chunk])
+            lines.extend(list(chunk))
             lines.append(lambda: HTML("\n"))
         return merge_formatted_text([fn() for fn in lines[:-1]])

{falyx-0.1.23 → falyx-0.1.24}/falyx/command.py

@@ -33,12 +33,13 @@ from falyx.exceptions import FalyxError
 from falyx.execution_registry import ExecutionRegistry as er
 from falyx.hook_manager import HookManager, HookType
 from falyx.io_action import BaseIOAction
+from falyx.logger import logger
 from falyx.options_manager import OptionsManager
-from falyx.prompt_utils import should_prompt_user
+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.themes.colors import OneColors
-from falyx.utils import _noop, confirm_async, ensure_async, logger
+from falyx.utils import _noop, ensure_async
 
 console = Console(color_system="auto")
 
@@ -134,7 +135,7 @@ class Command(BaseModel):
             return ensure_async(action)
         raise TypeError("Action must be a callable or an instance of BaseAction")
 
-    def model_post_init(self, __context: Any) -> None:
+    def model_post_init(self, _: Any) -> None:
         """Post-initialization to set up the action and hooks."""
         if self.retry and isinstance(self.action, Action):
             self.action.enable_retry()
@@ -142,14 +143,16 @@ class Command(BaseModel):
             self.action.set_retry_policy(self.retry_policy)
         elif self.retry:
             logger.warning(
-                f"[Command:{self.key}] Retry requested, but action is not an Action instance."
+                "[Command:%s] Retry requested, but action is not an Action instance.",
+                self.key,
             )
         if self.retry_all and isinstance(self.action, BaseAction):
             self.retry_policy.enabled = True
             enable_retries_recursively(self.action, self.retry_policy)
         elif self.retry_all:
             logger.warning(
-                f"[Command:{self.key}] Retry all requested, but action is not a BaseAction instance."
+                "[Command:%s] Retry all requested, but action is not a BaseAction.",
+                self.key,
             )
 
         if self.logging_hooks and isinstance(self.action, BaseAction):
@@ -201,7 +204,7 @@ class Command(BaseModel):
             if self.preview_before_confirm:
                 await self.preview()
             if not await confirm_async(self.confirmation_prompt):
-                logger.info(f"[Command:{self.key}] ❌ Cancelled by user.")
+                logger.info("[Command:%s] ❌ Cancelled by user.", self.key)
                 raise FalyxError(f"[Command:{self.key}] Cancelled by confirmation.")
 
         context.start_timer()
@@ -288,7 +291,7 @@ class Command(BaseModel):
             if self.help_text:
                 console.print(f"[dim]💡 {self.help_text}[/dim]")
             console.print(
-                f"[{OneColors.DARK_RED}]⚠️ Action is not callable or lacks a preview method.[/]"
+                f"[{OneColors.DARK_RED}]⚠️ No preview available for this action.[/]"
             )
 
     def __str__(self) -> str:

{falyx-0.1.23 → falyx-0.1.24}/falyx/config.py

@@ -16,9 +16,9 @@ from rich.console import Console
 from falyx.action import Action, BaseAction
 from falyx.command import Command
 from falyx.falyx import Falyx
+from falyx.logger import logger
 from falyx.retry import RetryPolicy
 from falyx.themes.colors import OneColors
-from falyx.utils import logger
 
 console = Console(color_system="auto")
 
@@ -47,7 +47,8 @@ def import_action(dotted_path: str) -> Any:
         logger.error("Failed to import module '%s': %s", module_path, error)
         console.print(
             f"[{OneColors.DARK_RED}]❌ Could not import '{dotted_path}': {error}[/]\n"
-            f"[{OneColors.COMMENT_GREY}]Ensure the module is installed and discoverable via PYTHONPATH."
+            f"[{OneColors.COMMENT_GREY}]Ensure the module is installed and discoverable "
+            "via PYTHONPATH."
         )
         sys.exit(1)
     try:
@@ -57,13 +58,16 @@ def import_action(dotted_path: str) -> Any:
             "Module '%s' does not have attribute '%s': %s", module_path, attr, error
         )
         console.print(
-            f"[{OneColors.DARK_RED}]❌ Module '{module_path}' has no attribute '{attr}': {error}[/]"
+            f"[{OneColors.DARK_RED}]❌ Module '{module_path}' has no attribute "
+            f"'{attr}': {error}[/]"
         )
         sys.exit(1)
     return action
 
 
 class RawCommand(BaseModel):
+    """Raw command model for Falyx CLI configuration."""
+
     key: str
     description: str
     action: str
@@ -72,7 +76,7 @@ class RawCommand(BaseModel):
     kwargs: dict[str, Any] = {}
     aliases: list[str] = []
     tags: list[str] = []
-    style: str = "white"
+    style: str = OneColors.WHITE
 
     confirm: bool = False
     confirm_message: str = "Are you sure?"
@@ -81,7 +85,7 @@ class RawCommand(BaseModel):
     spinner: bool = False
     spinner_message: str = "Processing..."
     spinner_type: str = "dots"
-    spinner_style: str = "cyan"
+    spinner_style: str = OneColors.CYAN
     spinner_kwargs: dict[str, Any] = {}
 
     before_hooks: list[Callable] = []
@@ -126,6 +130,8 @@ def convert_commands(raw_commands: list[dict[str, Any]]) -> list[Command]:
 
 
 class FalyxConfig(BaseModel):
+    """Falyx CLI configuration model."""
+
     title: str = "Falyx CLI"
     prompt: str | list[tuple[str, str]] | list[list[str]] = [
         (OneColors.BLUE_b, "FALYX > ")
@@ -148,7 +154,7 @@ class FalyxConfig(BaseModel):
     def to_falyx(self) -> Falyx:
         flx = Falyx(
             title=self.title,
-            prompt=self.prompt,
+            prompt=self.prompt,  # type: ignore[arg-type]
             columns=self.columns,
             welcome_message=self.welcome_message,
             exit_message=self.exit_message,
@@ -159,7 +165,9 @@ class FalyxConfig(BaseModel):
 
 def loader(file_path: Path | str) -> Falyx:
     """
-    Load command definitions from a YAML or TOML file.
+    Load Falyx CLI configuration from a YAML or TOML file.
+
+    The file should contain a dictionary with a list of commands.
 
     Each command should be defined as a dictionary with at least:
     - key: a unique single-character key

{falyx-0.1.23 → falyx-0.1.24}/falyx/context.py

@@ -29,10 +29,10 @@ class ExecutionContext(BaseModel):
     """
     Represents the runtime metadata and state for a single action execution.
 
-    The `ExecutionContext` tracks arguments, results, exceptions, timing, and additional
-    metadata for each invocation of a Falyx `BaseAction`. It provides integration with the
-    Falyx hook system and execution registry, enabling lifecycle management, diagnostics,
-    and structured logging.
+    The `ExecutionContext` tracks arguments, results, exceptions, timing, and
+    additional metadata for each invocation of a Falyx `BaseAction`. It provides
+    integration with the Falyx hook system and execution registry, enabling lifecycle
+    management, diagnostics, and structured logging.
 
     Attributes:
         name (str): The name of the action being executed.
@@ -47,7 +47,8 @@ class ExecutionContext(BaseModel):
         end_wall (datetime | None): Wall-clock timestamp when execution ended.
         extra (dict): Metadata for custom introspection or special use by Actions.
         console (Console): Rich console instance for logging or UI output.
-        shared_context (SharedContext | None): Optional shared context when running in a chain or group.
+        shared_context (SharedContext | None): Optional shared context when running in
+                                               a chain or group.
 
     Properties:
         duration (float | None): The execution duration in seconds.
@@ -95,7 +96,11 @@ class ExecutionContext(BaseModel):
         self.end_wall = datetime.now()
 
     def get_shared_context(self) -> SharedContext:
-        return self.shared_context or SharedContext(name="default")
+        if not self.shared_context:
+            raise ValueError(
+                "SharedContext is not set. This context is not part of a chain or group."
+            )
+        return self.shared_context
 
     @property
     def duration(self) -> float | None:
@@ -190,8 +195,10 @@ class SharedContext(BaseModel):
         errors (list[tuple[int, Exception]]): Indexed list of errors from failed actions.
         current_index (int): Index of the currently executing action (used in chains).
         is_parallel (bool): Whether the context is used in parallel mode (ActionGroup).
-        shared_result (Any | None): Optional shared value available to all actions in parallel mode.
-        share (dict[str, Any]): Custom shared key-value store for user-defined communication
+        shared_result (Any | None): Optional shared value available to all actions in
+                                    parallel mode.
+        share (dict[str, Any]): Custom shared key-value store for user-defined
+                                communication
             between actions (e.g., flags, intermediate data, settings).
 
     Note:
@@ -208,6 +215,7 @@ class SharedContext(BaseModel):
     """
 
     name: str
+    action: Any
     results: list[Any] = Field(default_factory=list)
     errors: list[tuple[int, Exception]] = Field(default_factory=list)
     current_index: int = -1

{falyx-0.1.23 → falyx-0.1.24}/falyx/debug.py

@@ -1,7 +1,8 @@
 # Falyx CLI Framework — (c) 2025 rtj.dev LLC — MIT Licensed
+"""debug.py"""
 from falyx.context import ExecutionContext
 from falyx.hook_manager import HookManager, HookType
-from falyx.utils import logger
+from falyx.logger import logger
 
 
 def log_before(context: ExecutionContext):

{falyx-0.1.23 → falyx-0.1.24}/falyx/exceptions.py

@@ -1,4 +1,7 @@
 # Falyx CLI Framework — (c) 2025 rtj.dev LLC — MIT Licensed
+"""exceptions.py"""
+
+
 class FalyxError(Exception):
     """Custom exception for the Menu class."""
 

{falyx-0.1.23 → falyx-0.1.24}/falyx/execution_registry.py

@@ -1,5 +1,32 @@
 # Falyx CLI Framework — (c) 2025 rtj.dev LLC — MIT Licensed
-"""execution_registry.py"""
+"""
+execution_registry.py
+
+This module provides the `ExecutionRegistry`, a global class for tracking and
+introspecting the execution history of Falyx actions.
+
+The registry captures `ExecutionContext` instances from all executed actions, making it
+easy to debug, audit, and visualize workflow behavior over time. It supports retrieval,
+filtering, clearing, and formatted summary display.
+
+Core Features:
+- Stores all action execution contexts globally (with access by name).
+- Provides live execution summaries in a rich table format.
+- Enables creation of a built-in Falyx Action to print history on demand.
+- Integrates with Falyx's introspectable and hook-driven execution model.
+
+Intended for:
+- Debugging and diagnostics
+- Post-run inspection of CLI workflows
+- Interactive tools built with Falyx
+
+Example:
+    from falyx.execution_registry import ExecutionRegistry as er
+    er.record(context)
+    er.summary()
+"""
+from __future__ import annotations
+
 from collections import defaultdict
 from datetime import datetime
 from typing import Dict, List
@@ -9,11 +36,40 @@ from rich.console import Console
 from rich.table import Table
 
 from falyx.context import ExecutionContext
+from falyx.logger import logger
 from falyx.themes.colors import OneColors
-from falyx.utils import logger
 
 
 class ExecutionRegistry:
+    """
+    Global registry for recording and inspecting Falyx action executions.
+
+    This class captures every `ExecutionContext` generated by a Falyx `Action`,
+    `ChainedAction`, or `ActionGroup`, maintaining both full history and
+    name-indexed access for filtered analysis.
+
+    Methods:
+        - record(context): Stores an ExecutionContext, logging a summary line.
+        - get_all(): Returns the list of all recorded executions.
+        - get_by_name(name): Returns all executions with the given action name.
+        - get_latest(): Returns the most recent execution.
+        - clear(): Wipes the registry for a fresh run.
+        - summary(): Renders a formatted Rich table of all execution results.
+
+    Use Cases:
+        - Debugging chained or factory-generated workflows
+        - Viewing results and exceptions from multiple runs
+        - Embedding a diagnostic command into your CLI for user support
+
+    Note:
+        This registry is in-memory and not persistent. It's reset each time the process
+        restarts or `clear()` is called.
+
+    Example:
+        ExecutionRegistry.record(context)
+        ExecutionRegistry.summary()
+    """
+
     _store_by_name: Dict[str, List[ExecutionContext]] = defaultdict(list)
     _store_all: List[ExecutionContext] = []
     _console = Console(color_system="auto")
@@ -78,13 +134,3 @@ class ExecutionRegistry:
             table.add_row(ctx.name, start, end, duration, status, result)
 
         cls._console.print(table)
-
-    @classmethod
-    def get_history_action(cls) -> "Action":
-        """Return an Action that prints the execution summary."""
-        from falyx.action import Action
-
-        async def show_history():
-            cls.summary()
-
-        return Action(name="View Execution History", action=show_history)