falyx 0.1.58__py3-none-any.whl → 0.1.59__py3-none-any.whl

falyx/action/confirm_action.py

@@ -56,13 +56,14 @@ class ConfirmAction(BaseAction):
         prompt_session (PromptSession | None): The session to use for input.
         confirm (bool): Whether to prompt the user for confirmation.
         word (str): The word to type for TYPE_WORD confirmation.
-        return_last_result (bool): Whether to return the last result of the action.
+        return_last_result (bool): Whether to return the last result of the action
+                                   instead of a boolean.
     """
 
     def __init__(
         self,
         name: str,
-        message: str = "Continue",
+        message: str = "Confirm?",
         confirm_type: ConfirmType | str = ConfirmType.YES_NO,
         prompt_session: PromptSession | None = None,
         confirm: bool = True,
@@ -114,16 +115,19 @@ class ConfirmAction(BaseAction):
                     session=self.prompt_session,
                 )
             case ConfirmType.YES_NO_CANCEL:
+                error_message = "Enter 'Y', 'y' to confirm, 'N', 'n' to decline, or 'C', 'c' to abort."
                 answer = await self.prompt_session.prompt_async(
-                    f"❓ {self.message} ([Y]es, [N]o, or [C]ancel to abort): ",
-                    validator=words_validator(["Y", "N", "C"]),
+                    f"❓ {self.message} [Y]es, [N]o, or [C]ancel to abort > ",
+                    validator=words_validator(
+                        ["Y", "N", "C"], error_message=error_message
+                    ),
                 )
                 if answer.upper() == "C":
                     raise CancelSignal(f"Action '{self.name}' was cancelled by the user.")
                 return answer.upper() == "Y"
             case ConfirmType.TYPE_WORD:
                 answer = await self.prompt_session.prompt_async(
-                    f"❓ {self.message} (type '{self.word}' to confirm or N/n): ",
+                    f"❓ {self.message} [{self.word}] to confirm or [N/n] > ",
                     validator=word_validator(self.word),
                 )
                 return answer.upper().strip() != "N"
@@ -138,9 +142,10 @@ class ConfirmAction(BaseAction):
                     raise CancelSignal(f"Action '{self.name}' was cancelled by the user.")
                 return answer
             case ConfirmType.OK_CANCEL:
+                error_message = "Enter 'O', 'o' to confirm or 'C', 'c' to abort."
                 answer = await self.prompt_session.prompt_async(
-                    f"❓ {self.message} ([O]k to continue, [C]ancel to abort): ",
-                    validator=words_validator(["O", "C"]),
+                    f"❓ {self.message} [O]k to confirm, [C]ancel to abort > ",
+                    validator=words_validator(["O", "C"], error_message=error_message),
                 )
                 if answer.upper() == "C":
                     raise CancelSignal(f"Action '{self.name}' was cancelled by the user.")
@@ -213,5 +218,5 @@ class ConfirmAction(BaseAction):
     def __str__(self) -> str:
         return (
             f"ConfirmAction(name={self.name}, message={self.message}, "
-            f"confirm_type={self.confirm_type})"
+            f"confirm_type={self.confirm_type}, return_last_result={self.return_last_result})"
         )

falyx/action/signal_action.py

@@ -14,7 +14,7 @@ class SignalAction(Action):
     Useful for exiting a menu, going back, or halting execution gracefully.
     """
 
-    def __init__(self, name: str, signal: Exception):
+    def __init__(self, name: str, signal: FlowSignal):
         self.signal = signal
         super().__init__(name, action=self.raise_signal)
 

falyx/bottom_bar.py

@@ -5,6 +5,7 @@ from typing import Any, Callable
 
 from prompt_toolkit.formatted_text import HTML, merge_formatted_text
 from prompt_toolkit.key_binding import KeyBindings
+from rich.console import Console
 
 from falyx.console import console
 from falyx.options_manager import OptionsManager

falyx/falyx.py

@@ -1,7 +1,5 @@
 # Falyx CLI Framework — (c) 2025 rtj.dev LLC — MIT Licensed
-"""falyx.py
-
-Main class for constructing and running Falyx CLI menus.
+"""Main class for constructing and running Falyx CLI menus.
 
 Falyx provides a structured, customizable interactive menu system
 for running commands, actions, and workflows. It supports:

falyx/parser/parsers.py

@@ -56,6 +56,39 @@ def get_root_parser(
     allow_abbrev: bool = True,
     exit_on_error: bool = True,
 ) -> ArgumentParser:
+    """
+    Construct the root-level ArgumentParser for the Falyx CLI.
+
+    This parser handles global arguments shared across subcommands and can serve
+    as the base parser for the Falyx CLI or standalone applications. It includes
+    options for verbosity, debug logging, and version output.
+
+    Args:
+        prog (str | None): Name of the program (e.g., 'falyx').
+        usage (str | None): Optional custom usage string.
+        description (str | None): Description shown in the CLI help.
+        epilog (str | None): Message displayed at the end of help output.
+        parents (Sequence[ArgumentParser] | None): Optional parent parsers.
+        prefix_chars (str): Characters to denote optional arguments (default: "-").
+        fromfile_prefix_chars (str | None): Prefix to indicate argument file input.
+        argument_default (Any): Global default value for arguments.
+        conflict_handler (str): Strategy to resolve conflicting argument names.
+        add_help (bool): Whether to include help (`-h/--help`) in this parser.
+        allow_abbrev (bool): Allow abbreviated long options.
+        exit_on_error (bool): Exit immediately on error or raise an exception.
+
+    Returns:
+        ArgumentParser: The root parser with global options attached.
+
+    Notes:
+        ```
+        Includes the following arguments:
+            --never-prompt       : Run in non-interactive mode.
+            -v / --verbose       : Enable debug logging.
+            --debug-hooks        : Enable hook lifecycle debug logs.
+            --version            : Print the Falyx version.
+        ```
+    """
     parser = ArgumentParser(
         prog=prog,
         usage=usage,
@@ -92,7 +125,30 @@ def get_subparsers(
     title: str = "Falyx Commands",
     description: str | None = "Available commands for the Falyx CLI.",
 ) -> _SubParsersAction:
-    """Create and return a subparsers action for the given parser."""
+    """
+    Create and return a subparsers object for registering Falyx CLI subcommands.
+
+    This function adds a `subparsers` block to the given root parser, enabling
+    structured subcommands such as `run`, `run-all`, `preview`, etc.
+
+    Args:
+        parser (ArgumentParser): The root parser to attach the subparsers to.
+        title (str): Title used in help output to group subcommands.
+        description (str | None): Optional text describing the group of subcommands.
+
+    Returns:
+        _SubParsersAction: The subparsers object that can be used to add new CLI subcommands.
+
+    Raises:
+        TypeError: If `parser` is not an instance of `ArgumentParser`.
+
+    Example:
+        ```python
+        >>> parser = get_root_parser()
+        >>> subparsers = get_subparsers(parser, title="Available Commands")
+        >>> subparsers.add_parser("run", help="Run a Falyx command")
+        ```
+    """
     if not isinstance(parser, ArgumentParser):
         raise TypeError("parser must be an instance of ArgumentParser")
     subparsers = parser.add_subparsers(
@@ -122,7 +178,54 @@ def get_arg_parsers(
     root_parser: ArgumentParser | None = None,
     subparsers: _SubParsersAction | None = None,
 ) -> FalyxParsers:
-    """Returns the argument parser for the CLI."""
+    """
+    Create and return the full suite of argument parsers used by the Falyx CLI.
+
+    This function builds the root parser and all subcommand parsers used for structured
+    CLI workflows in Falyx. It supports standard subcommands including `run`, `run-all`,
+    `preview`, `list`, and `version`, and integrates with registered `Command` objects
+    to populate dynamic help and usage documentation.
+
+    Args:
+        prog (str | None): Program name to display in help and usage messages.
+        usage (str | None): Optional usage message to override the default.
+        description (str | None): Description for the CLI root parser.
+        epilog (str | None): Epilog message shown after the help text.
+        parents (Sequence[ArgumentParser] | None): Optional parent parsers.
+        prefix_chars (str): Characters that prefix optional arguments.
+        fromfile_prefix_chars (str | None): Prefix character for reading args from file.
+        argument_default (Any): Default value for arguments if not specified.
+        conflict_handler (str): Strategy for resolving conflicting arguments.
+        add_help (bool): Whether to add the `-h/--help` option to the root parser.
+        allow_abbrev (bool): Whether to allow abbreviated long options.
+        exit_on_error (bool): Whether the parser exits on error or raises.
+        commands (dict[str, Command] | None): Optional dictionary of registered commands
+            to populate help and subcommand descriptions dynamically.
+        root_parser (ArgumentParser | None): Custom root parser to use instead of building one.
+        subparsers (_SubParsersAction | None): Optional existing subparser object to extend.
+
+    Returns:
+        FalyxParsers: A structured container of all parsers, including `run`, `run-all`,
+                      `preview`, `list`, `version`, and the root parser.
+
+    Raises:
+        TypeError: If `root_parser` is not an instance of ArgumentParser or
+                   `subparsers` is not an instance of _SubParsersAction.
+
+    Example:
+        ```python
+        >>> parsers = get_arg_parsers(commands=my_command_dict)
+        >>> args = parsers.root.parse_args()
+        ```
+
+    Notes:
+        - This function integrates dynamic command usage and descriptions if the
+          `commands` argument is provided.
+        - The `run` parser supports additional options for retry logic and confirmation
+          prompts.
+        - The `run-all` parser executes all commands matching a tag.
+        - Use `falyx run ?[COMMAND]` from the CLI to preview a command.
+    """
     if epilog is None:
         epilog = f"Tip: Use '{prog} run ?[COMMAND]' to preview any command from the CLI."
     if root_parser is None:

falyx/validators.py

@@ -44,10 +44,12 @@ def yes_no_validator() -> Validator:
             return False
         return True
 
-    return Validator.from_callable(validate, error_message="Enter 'Y' or 'n'.")
+    return Validator.from_callable(validate, error_message="Enter 'Y', 'y' or 'N', 'n'.")
 
 
-def words_validator(keys: Sequence[str] | KeysView[str]) -> Validator:
+def words_validator(
+    keys: Sequence[str] | KeysView[str], error_message: str | None = None
+) -> Validator:
     """Validator for specific word inputs."""
 
     def validate(text: str) -> bool:
@@ -55,9 +57,10 @@ def words_validator(keys: Sequence[str] | KeysView[str]) -> Validator:
             return False
         return True
 
-    return Validator.from_callable(
-        validate, error_message=f"Invalid input. Choices: {{{', '.join(keys)}}}."
-    )
+    if error_message is None:
+        error_message = f"Invalid input. Choices: {{{', '.join(keys)}}}."
+
+    return Validator.from_callable(validate, error_message=error_message)
 
 
 def word_validator(word: str) -> Validator:
@@ -68,7 +71,7 @@ def word_validator(word: str) -> Validator:
             return True
         return text.upper().strip() == word.upper()
 
-    return Validator.from_callable(validate, error_message=f"Enter '{word}' or 'N'.")
+    return Validator.from_callable(validate, error_message=f"Enter '{word}' or 'N', 'n'.")
 
 
 class MultiIndexValidator(Validator):

falyx/version.py

@@ -1 +1 @@
-__version__ = "0.1.58"
+__version__ = "0.1.59"

{falyx-0.1.58.dist-info → falyx-0.1.59.dist-info}/METADATA

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

{falyx-0.1.58.dist-info → falyx-0.1.59.dist-info}/RECORD

@@ -10,7 +10,7 @@ falyx/action/action_mixins.py,sha256=oUrjbweCeateshg3tqtbQiGuV8u4GvlioIZCUr9D1m4
 falyx/action/action_types.py,sha256=oG8qIFObZdiU1VZQlnWzR8uBDq8rcxzkCli9A31_tMI,1460
 falyx/action/base_action.py,sha256=o9Nml70-SEVTXnu9J0-VYnO-t5wZZM0o59lYDth24Po,5829
 falyx/action/chained_action.py,sha256=oknG4ACr79Yf7jb4jvpp6Au7VJLz3PRqABzUKJLn_eY,9274
-falyx/action/confirm_action.py,sha256=HCzDBQMX1I_cquV_26ppKPfB0GJjr24v12kaZ4Q6bSU,8700
+falyx/action/confirm_action.py,sha256=oXPnZswkQFJ-F-s73vddpF-BRg1wJeVnHjR4K2yN7ow,9085
 falyx/action/fallback_action.py,sha256=3FGWfoR1MIgY0ZkDNOpKu8p3JqPWzh5ON3943mfgDGs,1708
 falyx/action/http_action.py,sha256=DNeSBWh58UTFGlfFyTk2GnhS54hpLAJLC0QNbq2cYic,5799
 falyx/action/io_action.py,sha256=V888tQgAynqsVvkhICnEeE4wRs2vvdTcdlEpDSEbHqo,6128
@@ -24,9 +24,9 @@ falyx/action/save_file_action.py,sha256=Pe_j0hZjDNsO14bykzVYM0gkWB3zmpB1cExSN01I
 falyx/action/select_file_action.py,sha256=PcV22_wiPeDoJLIhHRiEUmW8N3pYeqQZMVTscQKXuas,9867
 falyx/action/selection_action.py,sha256=L1evMm7oAQFGMviZ8nMwFKhWKWe8X7wW6dJPHGxpqAE,15398
 falyx/action/shell_action.py,sha256=0A_kvZLsYmeLHInMM_4Jpe8GCSnXzGBm7H9PnXPvbAs,4055
-falyx/action/signal_action.py,sha256=5UMqvzy7fBnLANGwYUWoe1VRhrr7e-yOVeLdOnCBiJo,1350
+falyx/action/signal_action.py,sha256=GxV-0zqYqODOQUa3-tvFTZ2AS1W1QpW6ExonxmWNWbs,1351
 falyx/action/user_input_action.py,sha256=Up47lumscxnhORMvaft0X-NWpxTXc2GmMZMua__pGhA,3524
-falyx/bottom_bar.py,sha256=QYAuWWOM_FVObuRrGrZWOYvuvL45cnYDtV34s5B1qFU,7372
+falyx/bottom_bar.py,sha256=B62N3YCQF_h2Rw_hpc2_FUuLNARI-XIGbQkg-1XvaYE,7405
 falyx/command.py,sha256=QdcwLEFIaq3a4Lfot4cV3zHbVJNQxwSpShprBgLBkh8,16891
 falyx/completer.py,sha256=EODbakx5PFAwjNcfuUZPFuSx2Q9MXBlWRZJ2LejF6DI,1686
 falyx/config.py,sha256=OFEq9pFhV39o6_D7dP_QUDjqEusSQNpgomRsh5AAZYY,9621
@@ -35,7 +35,7 @@ falyx/context.py,sha256=SuQxxYuv1cb__EieJyRHp7opO-9T5KsMPxruEjVN36Q,10784
 falyx/debug.py,sha256=pguI0XQcZ-7jte5YUPexAufa1oxxalYO1JgmO6GU3rI,1557
 falyx/exceptions.py,sha256=58D4BYkyJ7PlpZoNk37GsUsFThm_gIlb2Ex2XXhLklI,1099
 falyx/execution_registry.py,sha256=RLRMOEmfDElFy4tuC8L9tRyNToX7GJ4GoEBh2Iri8zo,7662
-falyx/falyx.py,sha256=5pOpYHuw6VZqjC9tszA6wgvahOfxmmIPDtzphcVOVi4,49342
+falyx/falyx.py,sha256=6hKcD1RC-jTPA0WiF9JJ31QkacNJAJwqoqO1zhegwoM,49332
 falyx/falyx_completer.py,sha256=MsfuZXpfGwbsGG-4Zp-j-vNsNnaote-UAJkJh0s2NZI,5236
 falyx/hook_manager.py,sha256=TFuHQnAncS_rk6vuw-VSx8bnAppLuHfrZCrzLwqcO9o,2979
 falyx/hooks.py,sha256=xMfQROib0BNsaQF4AXJpmCiGePoE1f1xpcdibgnVZWM,2913
@@ -48,7 +48,7 @@ falyx/parser/__init__.py,sha256=NbxAovKIY-duFTs6DAsdM_OzL7s3VIu19KMOmltX9ts,512
 falyx/parser/argument.py,sha256=MIKUj-hrdLDUK8xuW84_l9ms_t5CoNFpVDmxMZIbW-I,4105
 falyx/parser/argument_action.py,sha256=rNVeth0eMpkZRU_eT1RPVxOGzD4pbdAMx9Kq07T4mG4,709
 falyx/parser/command_argument_parser.py,sha256=Ej4gYOxSUOYfLr5b0KkZkC0OkuSUrj54JpuI0D0C6h4,37504
-falyx/parser/parsers.py,sha256=X3eEltxBbwRwWG5Q1A1GqSdQCJZAYN5Eub0_U6dlBN4,9159
+falyx/parser/parsers.py,sha256=vb-l_NNh5O9L98Lcafhz91flRLxC1BnW6U8JdeabRCw,14118
 falyx/parser/signature.py,sha256=fSltLEr8ctj1qpbU-OvTMnREjlb8OTG5t-guJFR7j4E,2529
 falyx/parser/utils.py,sha256=km6WvoPUgVdoIpPwDfr6axyjyy8iZy8xndwBNprI2Lk,2996
 falyx/prompt_utils.py,sha256=qgk0bXs7mwzflqzWyFhEOTpKQ_ZtMIqGhKeg-ocwNnE,1542
@@ -61,10 +61,10 @@ 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=U45xnZFUdoFC4xiji_9S1jHS5V7MvxSDtufP8EgB0SM,6732
-falyx/validators.py,sha256=DHq-ELpeYVHvRg9daY4Te6ufAf4ryUAM7i_uF7B15Sc,5919
-falyx/version.py,sha256=ujgZXX_cw13M2UkyXWVg5j1fgdE25Qb3rUzLZVokSKg,23
-falyx-0.1.58.dist-info/LICENSE,sha256=B0yqgaHuSdhN7T3OBmgQSiDTy8HqT5Oe_dLypRe4Ra4,1073
-falyx-0.1.58.dist-info/METADATA,sha256=Kz5boaWHPPVBRUvQEJFrOOnQZdwUcGGTnwwQ5lsTaTg,5561
-falyx-0.1.58.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-falyx-0.1.58.dist-info/entry_points.txt,sha256=j8owOSl2j1Ss8DtGMnKfgehKaolqnIPhVFHaUBLUnMs,45
-falyx-0.1.58.dist-info/RECORD,,
+falyx/validators.py,sha256=AXpMGnk1_7J7MAbbol6pkMAiSIdNHoF5pwtA2-xS6H8,6029
+falyx/version.py,sha256=6ejKyHgulDwYDrT6JBlbHrh83UmxgavrhSuOolniIfI,23
+falyx-0.1.59.dist-info/LICENSE,sha256=B0yqgaHuSdhN7T3OBmgQSiDTy8HqT5Oe_dLypRe4Ra4,1073
+falyx-0.1.59.dist-info/METADATA,sha256=8C_QBe_shgMdk33zg8PXtdp064Sl0icvqExl8yyGNXY,5561
+falyx-0.1.59.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+falyx-0.1.59.dist-info/entry_points.txt,sha256=j8owOSl2j1Ss8DtGMnKfgehKaolqnIPhVFHaUBLUnMs,45
+falyx-0.1.59.dist-info/RECORD,,

{falyx-0.1.58.dist-info → falyx-0.1.59.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any