bear-utils 0.8.23__tar.gz → 0.8.24__tar.gz

{bear_utils-0.8.23 → bear_utils-0.8.24}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.23
+current_version = 0.8.24
 
 [bumpversion:file:pyproject.toml]
 

{bear_utils-0.8.23 → bear_utils-0.8.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bear-utils
-Version: 0.8.23
+Version: 0.8.24
 Summary: Various utilities for Bear programmers, including a rich logging utility, a disk cache, and a SQLite database wrapper amongst other things.
 Author-email: chaz <bright.lid5647@fastmail.com>
 Requires-Python: >=3.12
@@ -19,12 +19,13 @@ Requires-Dist: singleton-base>=1.0.5
 Requires-Dist: sqlalchemy<3.0.0,>=2.0.40
 Requires-Dist: tinydb>=4.8.2
 Requires-Dist: toml>=0.10.2
+Requires-Dist: typer>=0.16.0
 Requires-Dist: uvicorn>=0.35.0
 Provides-Extra: gui
 Requires-Dist: pyqt6>=6.9.0; extra == 'gui'
 Description-Content-Type: text/markdown
 
-# Bear Utils v# Bear Utils v0.8.23
+# Bear Utils v# Bear Utils v0.8.24
 
 Personal set of tools and utilities for Python projects, focusing on modularity and ease of use. This library includes components for caching, database management, logging, time handling, file operations, CLI prompts, image processing, clipboard interaction, gradient utilities, event systems, and async helpers.
 

{bear_utils-0.8.23 → bear_utils-0.8.24}/README.md

@@ -1,4 +1,4 @@
-# Bear Utils v# Bear Utils v0.8.23
+# Bear Utils v# Bear Utils v0.8.24
 
 Personal set of tools and utilities for Python projects, focusing on modularity and ease of use. This library includes components for caching, database management, logging, time handling, file operations, CLI prompts, image processing, clipboard interaction, gradient utilities, event systems, and async helpers.
 

{bear_utils-0.8.23 → bear_utils-0.8.24}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bear-utils"
-version = "0.8.23"
+version = "0.8.24"
 description = "Various utilities for Bear programmers, including a rich logging utility, a disk cache, and a SQLite database wrapper amongst other things."
 authors = [{ name = "chaz", email = "bright.lid5647@fastmail.com" }]
 readme = "README.md"
@@ -22,6 +22,7 @@ dependencies = [
     "fastapi>=0.116.0",
     "uvicorn>=0.35.0",
     "bear-epoch-time>=1.1.1",
+    "typer>=0.16.0",
 ]
 
 [project.optional-dependencies]

{bear_utils-0.8.23 → bear_utils-0.8.24}/src/bear_utils/cli/prompt_helpers.py

@@ -10,7 +10,11 @@ from bear_utils.constants._exceptions import UserCancelledError
 from bear_utils.constants._lazy_typing import OptBool, OptFloat, OptInt, OptStr
 from bear_utils.logger_manager import get_console
 
-# TODO: ehhhhhhhh, it is okay
+
+def _parse_exit(value: str) -> bool:
+    """Parse a string into a boolean indicating if the user wants to exit."""
+    lower_value: str = value.lower().strip()
+    return lower_value in ("exit", "quit", "q")
 
 
 def _parse_bool(value: str) -> bool:
@@ -70,7 +74,7 @@ def ask_question(question: str, expected_type: type, default: Any = None) -> Any
         UserCancelledError: If the user cancels input with Ctrl+C
         ValueError: If an unsupported type is specified
     """
-    console, sub = get_console("prompt_helpers.py")
+    console, _ = get_console("prompt_helpers.py")
 
     try:
         while True:
@@ -80,14 +84,14 @@ def ask_question(question: str, expected_type: type, default: Any = None) -> Any
             if not response:
                 if default is not None:
                     return default
-                sub.error("Input required. Please enter a value.")
+                console.error("Input required. Please enter a value.")
                 continue
             try:
                 result: str | int | float | bool = _convert_value(response, expected_type)
-                sub.verbose(f"{expected_type.__name__} detected")
+                console.verbose(f"{expected_type.__name__} detected")
                 return result
             except ValueError as e:
-                sub.error(f"Invalid input: {e}. Please enter a valid {expected_type.__name__}.")
+                console.error(f"Invalid input: {e}. Please enter a valid {expected_type.__name__}.")
 
     except KeyboardInterrupt:
         raise UserCancelledError("User cancelled input") from None
@@ -108,15 +112,13 @@ def ask_yes_no(question: str, default: bool | None = None) -> bool | None:
     try:
         while True:
             console.print(question)
-            response = prompt("> ").strip().lower()
-
+            response: str = prompt("> ").strip().lower()
             if not response:
                 if default is not None:
                     return default
                 sub.error("Please enter 'yes', 'no', or 'exit'.")
                 continue
-
-            if response in ("exit", "quit"):
+            if _parse_exit(response):
                 return None
             try:
                 return _parse_bool(response)
@@ -128,7 +130,10 @@ def ask_yes_no(question: str, default: bool | None = None) -> bool | None:
 
 
 def restricted_prompt(
-    question: str, valid_options: list[str], exit_command: str = "exit", case_sensitive: bool = False
+    question: str,
+    valid_options: list[str],
+    exit_command: str = "exit",
+    case_sensitive: bool = False,
 ) -> str | None:
     """Continuously prompt the user until they provide a valid response or exit.
 
@@ -141,12 +146,12 @@ def restricted_prompt(
     Returns:
         The user's response or None if they chose to exit
     """
-    console, sub = get_console("prompt_helpers.py")
-    completer_options = [*valid_options, exit_command]
+    console, _ = get_console("prompt_helpers.py")
+    completer_options: list[str] = [*valid_options, exit_command]
     completer = WordCompleter(completer_options)
 
-    comparison_options = valid_options if case_sensitive else [opt.lower() for opt in valid_options]
-    comparison_exit = exit_command if case_sensitive else exit_command.lower()
+    comparison_options: list[str] = valid_options if case_sensitive else [opt.lower() for opt in valid_options]
+    comparison_exit: str = exit_command if case_sensitive else exit_command.lower()
 
     class OptionValidator(Validator):
         def validate(self, document: Any) -> None:
@@ -162,11 +167,14 @@ def restricted_prompt(
         while True:
             console.print(question)
             response: str = prompt(
-                "> ", completer=completer, validator=OptionValidator(), complete_while_typing=True
+                "> ",
+                completer=completer,
+                validator=OptionValidator(),
+                complete_while_typing=True,
             ).strip()
             comparison_response: str = response if case_sensitive else response.lower()
             if not response:
-                sub.error("Please enter a valid option or 'exit'.")
+                console.error("Please enter a valid option or 'exit'.")
                 continue
             if comparison_response == comparison_exit:
                 return None
@@ -175,7 +183,6 @@ def restricted_prompt(
                     idx: int = comparison_options.index(comparison_response)
                     return valid_options[idx]
                 return response
-
     except KeyboardInterrupt:
-        sub.warning("KeyboardInterrupt: Exiting the prompt.")
+        console.warning("KeyboardInterrupt: Exiting the prompt.")
         return None

bear_utils-0.8.24/src/bear_utils/cli/typer_bridge.py

@@ -0,0 +1,90 @@
+"""A simple bridge for augmenting Typer with alias support and command execution for interactive use."""
+
+from collections.abc import Callable
+import shlex
+from typing import Any, TypedDict
+
+from rich.console import Console
+from singleton_base import SingletonBase
+from typer import Exit, Typer
+from typer.models import CommandInfo
+
+from bear_utils.logger_manager import AsyncLoggerProtocol, LoggerProtocol
+
+
+class CommandMeta(TypedDict):
+    """Metadata for a Typer command."""
+
+    name: str
+    help: str
+    hidden: bool
+
+
+def get_command_meta(command: CommandInfo) -> CommandMeta:
+    """Extract metadata from a Typer command."""
+    return {
+        "name": command.name or (command.callback.__name__ if command.callback else "unknown"),
+        "help": (command.callback.__doc__ if command.callback else None) or "No description available",
+        "hidden": command.hidden,
+    }
+
+
+# TODO: Add support for usage statements for a more robust help system
+
+
+class TyperBridge(SingletonBase):
+    """Simple bridge for Typer command execution."""
+
+    def __init__(self, typer_app: Typer, console: AsyncLoggerProtocol | LoggerProtocol | Console) -> None:
+        """Initialize the TyperBridge with a Typer app instance."""
+        self.app: Typer = typer_app
+        self.console: AsyncLoggerProtocol | LoggerProtocol | Console = console or Console()
+        self.command_meta: dict[str, CommandMeta] = {}
+
+    def metadata(self, *alias_names: str) -> Callable[..., Callable[..., Any]]:
+        """Register aliases as hidden Typer commands."""
+
+        def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
+            for alias in alias_names:
+                self.app.command(name=alias, hidden=True)(func)
+            return func
+
+        return decorator
+
+    def execute_command(self, command_string: str) -> bool:
+        """Execute command via Typer. Return True if successful."""
+        try:
+            parts: list[str] = shlex.split(command_string.strip())
+            if not parts:
+                return False
+            self.app(parts, standalone_mode=False)
+            return True
+        except Exit:
+            return True
+        except Exception as e:
+            if isinstance(self.console, Console):
+                self.console.print(f"[red]Error executing command: {e}[/red]")
+            else:
+                self.console.error(f"Error executing command: {e}", exc_info=True)
+            return False
+
+    def bootstrap_command_meta(self) -> None:
+        """Bootstrap command metadata from the Typer app."""
+        if not self.command_meta:
+            for cmd in self.app.registered_commands:
+                cmd_meta: CommandMeta = get_command_meta(command=cmd)
+                self.command_meta[cmd_meta["name"]] = cmd_meta
+
+    def get_all_command_info(self, show_hidden: bool = False) -> dict[str, CommandMeta]:
+        """Get all command information from the Typer app."""
+        if not self.command_meta:
+            self.bootstrap_command_meta()
+        if not show_hidden:
+            return {name: meta for name, meta in self.command_meta.items() if not meta["hidden"]}
+        return self.command_meta
+
+    def get_command_info(self, command_name: str) -> CommandMeta | None:
+        """Get metadata for a specific command."""
+        if not self.command_meta:
+            self.bootstrap_command_meta()
+        return self.command_meta.get(command_name)

{bear_utils-0.8.23 → bear_utils-0.8.24}/tests/test_function_response.py

@@ -597,11 +597,11 @@ class TestConstants:
 
     def test_success_constant(self):
         """Test SUCCESS constant values."""
-        assert SUCCESS == ["name", "success"]
+        assert SUCCESS == ["name", "success", "number_of_tasks"]
 
     def test_failure_constant(self):
         """Test FAILURE constant values."""
-        assert FAILURE == ["name"]
+        assert FAILURE == ["name", "number_of_tasks"]
 
 
 class TestComplexScenarios:
@@ -635,13 +635,13 @@ class TestComplexScenarios:
         response.successful("Cleared 5 completed tasks")
         response.add(content="Operation summary generated")
 
-        result = response.done(to_dict=True, suppress=SUCCESS)
+        result = response.done(to_dict=True)
 
         # SUCCESS suppresses "name" and "success", so check what actually remains
         assert "content" in result
         assert "number_of_tasks" not in result  # This will only be here in failures
-        assert "name" not in result
-        assert "success" not in result
+        assert "name" in result
+        assert "success" in result
 
     def test_mcp_server_response_format_error(self):
         """Test formatting response for MCP server consumption."""
@@ -651,12 +651,12 @@ class TestComplexScenarios:
         response.fail("Failed to clear tasks")
         response.add(content="Error summary generated")
 
-        result = response.done(to_dict=True, suppress=FAILURE)
+        result = response.done(to_dict=True)
 
         # SUCCESS suppresses "name" and "success", so check what actually remains
         assert "content" in result
         assert "number_of_tasks" in result
-        assert "name" not in result
+        assert "name" in result
         assert "success" in result
 
     def test_error_handling_in_add_method(self):

{bear_utils-0.8.23 → bear_utils-0.8.24}/uv.lock

@@ -73,7 +73,7 @@ wheels = [
 
 [[package]]
 name = "bear-utils"
-version = "0.8.19"
+version = "0.8.23"
 source = { editable = "." }
 dependencies = [
     { name = "bear-epoch-time" },
@@ -91,9 +91,15 @@ dependencies = [
     { name = "sqlalchemy" },
     { name = "tinydb" },
     { name = "toml" },
+    { name = "typer" },
     { name = "uvicorn" },
 ]
 
+[package.optional-dependencies]
+gui = [
+    { name = "pyqt6" },
+]
+
 [package.dev-dependencies]
 ci = [
     { name = "bump2version" },
@@ -129,14 +135,17 @@ requires-dist = [
     { name = "prompt-toolkit", specifier = ">=3.0.51,<4.0.0" },
     { name = "pydantic", specifier = ">=2.11.5" },
     { name = "pyglm", specifier = ">=2.8.2,<3.0.0" },
+    { name = "pyqt6", marker = "extra == 'gui'", specifier = ">=6.9.0" },
     { name = "pyyaml", specifier = ">=6.0.2" },
     { name = "rich", specifier = ">=14.0.0,<15.0.0" },
     { name = "singleton-base", specifier = ">=1.0.5" },
     { name = "sqlalchemy", specifier = ">=2.0.40,<3.0.0" },
     { name = "tinydb", specifier = ">=4.8.2" },
     { name = "toml", specifier = ">=0.10.2" },
+    { name = "typer", specifier = ">=0.16.0" },
     { name = "uvicorn", specifier = ">=0.35.0" },
 ]
+provides-extras = ["gui"]
 
 [package.metadata.requires-dev]
 ci = [
@@ -1252,6 +1261,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/a6/24/4d91e05817e92e3a61c8a21e08fd0f390f5301f1c448b137c57c4bc6e543/semver-3.0.4-py3-none-any.whl", hash = "sha256:9c824d87ba7f7ab4a1890799cec8596f15c1241cb473404ea1cb0c55e4b04746", size = 17912, upload_time = "2025-01-24T13:19:24.949Z" },
 ]
 
+[[package]]
+name = "shellingham"
+version = "1.5.4"
+source = { registry = "https://pypi.org/simple/" }
+sdist = { url = "https://files.pythonhosted.org/packages/58/15/8b3609fd3830ef7b27b655beb4b4e9c62313a4e8da8c676e142cc210d58e/shellingham-1.5.4.tar.gz", hash = "sha256:8dbca0739d487e5bd35ab3ca4b36e11c4078f3a234bfce294b0a0291363404de", size = 10310, upload_time = "2023-10-24T04:13:40.426Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/e0/f9/0595336914c5619e5f28a1fb793285925a8cd4b432c9da0a987836c7f822/shellingham-1.5.4-py2.py3-none-any.whl", hash = "sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686", size = 9755, upload_time = "2023-10-24T04:13:38.866Z" },
+]
+
 [[package]]
 name = "singleton-base"
 version = "1.0.8"
@@ -1370,6 +1388,21 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/56/56/2d2a9139ec6c470836fc2b8c0a5c3c781d50b22c90c47c3f578902080a83/type_lens-0.2.3-py3-none-any.whl", hash = "sha256:3c1850545de595a5d5df4e24f8ea8c0f6d9aff42317ca9941d5069b9ad5c1e2e", size = 14288, upload_time = "2024-10-02T14:52:43.191Z" },
 ]
 
+[[package]]
+name = "typer"
+version = "0.16.0"
+source = { registry = "https://pypi.org/simple/" }
+dependencies = [
+    { name = "click" },
+    { name = "rich" },
+    { name = "shellingham" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/c5/8c/7d682431efca5fd290017663ea4588bf6f2c6aad085c7f108c5dbc316e70/typer-0.16.0.tar.gz", hash = "sha256:af377ffaee1dbe37ae9440cb4e8f11686ea5ce4e9bae01b84ae7c63b87f1dd3b", size = 102625, upload_time = "2025-05-26T14:30:31.824Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/76/42/3efaf858001d2c2913de7f354563e3a3a2f0decae3efe98427125a8f441e/typer-0.16.0-py3-none-any.whl", hash = "sha256:1f79bed11d4d02d4310e3c1b7ba594183bcedb0ac73b27a9e5f28f6fb5b98855", size = 46317, upload_time = "2025-05-26T14:30:30.523Z" },
+]
+
 [[package]]
 name = "types-markdown"
 version = "3.8.0.20250708"