bear-utils 0.7.20__py3-none-any.whl → 0.7.22__py3-none-any.whl

bear_utils/gui/gui_tools/qt_file_handler.py

@@ -1,3 +1,5 @@
+"""A module for file handling dialogs using PyQt6."""
+
 from PyQt6.QtWidgets import QFileDialog
 
 from .qt_app import QTApplication
@@ -6,9 +8,8 @@ from .qt_app import QTApplication
 class QTFileHandler(QTApplication):
     """A singleton class to handle file selection dialogs using PyQt6."""
 
-    def select_file(self, caption="Select File", directory="", filter="All Files (*)"):
-        """
-        Shows a file selection dialog and returns the selected file path.
+    def select_file(self, caption: str = "Select File", directory: str = "", fil: str = "All Files (*)"):
+        """Shows a file selection dialog and returns the selected file path.
 
         Args:
             caption (str): The dialog window title
@@ -18,76 +19,68 @@ class QTFileHandler(QTApplication):
         Returns:
             str: Selected file path or empty string if canceled
         """
-        file_path, _ = QFileDialog.getOpenFileName(None, caption, directory, filter)
+        file_path, _ = QFileDialog.getOpenFileName(None, caption, directory, fil)
         return file_path
 
-    def select_files(self, caption="Select Files", directory="", filter="All Files (*)"):
-        """
-        Shows a file selection dialog that allows multiple selections.
+    def select_files(self, caption: str = "Select Files", directory: str = "", fil: str = "All Files (*)"):
+        """Shows a file selection dialog that allows multiple selections.
 
         Returns:
             list: List of selected file paths
         """
-        file_paths, _ = QFileDialog.getOpenFileNames(None, caption, directory, filter)
+        file_paths, _ = QFileDialog.getOpenFileNames(None, caption, directory, fil)
         return file_paths
 
-    def select_directory(self, caption="Select Directory", directory=""):
-        """
-        Shows a directory selection dialog.
+    def select_directory(self, caption: str = "Select Directory", directory: str = ""):
+        """Shows a directory selection dialog.
 
         Returns:
             str: Selected directory path or empty string if canceled
         """
-        dir_path = QFileDialog.getExistingDirectory(None, caption, directory)
-        return dir_path
+        return QFileDialog.getExistingDirectory(None, caption, directory)
 
-    def save_file_dialog(self, caption="Save File", directory="", filter="All Files (*)"):
-        """
-        Shows a save file dialog.
+    def save_file_dialog(self, caption: str = "Save File", directory: str = "", fil: str = "All Files (*)"):
+        """Shows a save file dialog.
 
         Returns:
             str: Selected save file path or empty string if canceled
         """
-
-        file_path, _ = QFileDialog.getSaveFileName(None, caption, directory, filter)
+        file_path, _ = QFileDialog.getSaveFileName(None, caption, directory, fil)
         return file_path
 
 
-def select_file(caption="Select File", directory="", filter="All Files (*)"):
-    """
-    Select a file using the QTApplication singleton instance.
+def select_file(caption: str = "Select File", directory: str = "", fil: str = "All Files (*)"):
+    """Select a file using the QTApplication singleton instance.
 
     Args:
         caption (str): The dialog window title
         directory (str): The starting directory
-        filter (str): File filter pattern (e.g., "Images (*.png *.jpg);;Text files (*.txt)")
+        fil (str): File filter pattern (e.g., "Images (*.png *.jpg);;Text files (*.txt)")
 
     Returns:
         str: Selected file path or empty string if canceled
     """
     qt_app = QTFileHandler()
-    return qt_app.select_file(caption, directory, filter)
+    return qt_app.select_file(caption, directory, fil)
 
 
-def select_files(caption="Select Files", directory="", filter="All Files (*)"):
-    """
-    Select multiple files using the QTApplication singleton instance.
+def select_files(caption: str = "Select Files", directory: str = "", fil: str = "All Files (*)"):
+    """Select multiple files using the QTApplication singleton instance.
 
     Args:
         caption (str): The dialog window title
         directory (str): The starting directory
-        filter (str): File filter pattern (e.g., "Images (*.png *.jpg);;Text files (*.txt)")
+        fil (str): File filter pattern (e.g., "Images (*.png *.jpg);;Text files (*.txt)")
 
     Returns:
         list: List of selected file paths
     """
     qt_app = QTFileHandler()
-    return qt_app.select_files(caption, directory, filter)
+    return qt_app.select_files(caption, directory, fil)
 
 
-def select_directory(caption="Select Directory", directory=""):
-    """
-    Select a directory using the QTApplication singleton instance.
+def select_directory(caption: str = "Select Directory", directory: str = ""):
+    """Select a directory using the QTApplication singleton instance.
 
     Args:
         caption (str): The dialog window title
@@ -100,28 +93,27 @@ def select_directory(caption="Select Directory", directory=""):
     return qt_app.select_directory(caption, directory)
 
 
-def save_file_dialog(caption="Save File", directory="", filter="All Files (*)"):
-    """
-    Show a save file dialog using the QTApplication singleton instance.
+def save_file_dialog(caption: str = "Save File", directory: str = "", fil: str = "All Files (*)"):
+    """Show a save file dialog using the QTApplication singleton instance.
 
     Args:
         caption (str): The dialog window title
         directory (str): The starting directory
-        filter (str): File filter pattern (e.g., "Images (*.png *.jpg);;Text files (*.txt)")
+        fil (str): File filter pattern (e.g., "Images (*.png *.jpg);;Text files (*.txt)")
 
     Returns:
         str: Selected save file path or empty string if canceled
     """
     qt_app = QTFileHandler()
-    return qt_app.save_file_dialog(caption, directory, filter)
+    return qt_app.save_file_dialog(caption, directory, fil)
 
 
 __all__ = [
     "QTFileHandler",
+    "save_file_dialog",
+    "select_directory",
     "select_file",
     "select_files",
-    "select_directory",
-    "save_file_dialog",
 ]
 
 

bear_utils/gui/gui_tools/qt_input_dialog.py

@@ -1,3 +1,5 @@
+"""A module for input dialogs using PyQt6."""
+
 from PyQt6.QtCore import Qt
 from PyQt6.QtWidgets import QInputDialog, QLineEdit
 
@@ -5,6 +7,8 @@ from .qt_app import QTApplication
 
 
 class InputDialog(QTApplication):
+    """A class for displaying various input dialogs using PyQt6."""
+
     def get_text(
         self,
         title: str = "Input",
@@ -12,8 +16,7 @@ class InputDialog(QTApplication):
         default: str = "",
         echo_mode: QLineEdit.EchoMode = QLineEdit.EchoMode.Normal,
     ) -> str | None:
-        """
-        Shows a text input dialog.
+        """Shows a text input dialog.
 
         Args:
             title: Dialog window title
@@ -45,8 +48,7 @@ class InputDialog(QTApplication):
         label: str = "Enter password:",
         default: str = "",
     ) -> str | None:
-        """
-        Shows a password input dialog with masked text.
+        """Shows a password input dialog with masked text.
 
         Args:
             title: Dialog window title
@@ -72,8 +74,7 @@ class InputDialog(QTApplication):
         max_value: int = 2147483647,
         step: int = 1,
     ) -> int | None:
-        """
-        Shows an integer input dialog with spinner.
+        """Shows an integer input dialog with spinner.
 
         Args:
             title: Dialog window title
@@ -111,8 +112,7 @@ class InputDialog(QTApplication):
         max_value: float = 2147483647.0,
         decimals: int = 2,
     ) -> float | None:
-        """
-        Shows a floating-point input dialog with spinner.
+        """Shows a floating-point input dialog with spinner.
 
         Args:
             title: Dialog window title
@@ -149,8 +149,7 @@ class InputDialog(QTApplication):
         current: int = 0,
         editable: bool = False,
     ) -> str | None:
-        """
-        Shows a dropdown selection dialog.
+        """Shows a dropdown selection dialog.
 
         Args:
             title: Dialog window title
@@ -181,8 +180,7 @@ class InputDialog(QTApplication):
             return None
 
     def get_multiline_text(self, title: str = "Input", label: str = "Enter text:", default: str = "") -> str | None:
-        """
-        Shows a multi-line text input dialog.
+        """Shows a multi-line text input dialog.
 
         Args:
             title: Dialog window title
@@ -229,8 +227,7 @@ def get_api_key(
     default: str = "",
     service_name: str = "",
 ) -> str | None:
-    """
-    Shows a secure input dialog optimized for entering API keys.
+    """Shows a secure input dialog optimized for entering API keys.
 
     Args:
         title: Dialog window title

bear_utils/logging/__init__.py

@@ -1,3 +1,5 @@
+"""Logging utilities for Bear Utils."""
+
 from .logger_manager._common import VERBOSE_CONSOLE_FORMAT
 from .logger_manager._styles import VERBOSE
 from .loggers import (
@@ -12,14 +14,14 @@ from .loggers import (
 )
 
 __all__ = [
+    "VERBOSE",
+    "VERBOSE_CONSOLE_FORMAT",
     "BaseLogger",
-    "ConsoleLogger",
     "BufferLogger",
-    "SubConsoleLogger",
+    "ConsoleLogger",
     "FileLogger",
+    "SubConsoleLogger",
     "get_console",
     "get_logger",
     "get_sub_logger",
-    "VERBOSE",
-    "VERBOSE_CONSOLE_FORMAT",
 ]

bear_utils/logging/logger_manager/__init__.py

@@ -0,0 +1 @@
+"""Logging Manager for Bear Utils."""

bear_utils/logging/logger_manager/_common.py

@@ -4,7 +4,6 @@ from typing import Required, TypedDict
 
 
 class ExecValues(TypedDict, total=True):
-
     exc_type: Required[type[BaseException]]
     exc_value: Required[BaseException]
     exc_traceback: Required[TracebackType]

bear_utils/logging/logger_manager/_console_junk.py

@@ -1,14 +1,16 @@
-import threading
 from collections.abc import Callable
 from io import StringIO
 from logging import Formatter, Handler, LogRecord
 from logging.handlers import BufferingHandler
+import threading
+from typing import Any
 
 from prompt_toolkit import print_formatted_text
 from prompt_toolkit.output.defaults import create_output
 from rich.text import Text
 
-from ...constants.date_related import DATE_TIME_FORMAT
+from bear_utils.constants.date_related import DATE_TIME_FORMAT
+
 from ._common import SIMPLE_FORMAT, VERBOSE_CONSOLE_FORMAT, ExecValues
 from ._styles import LoggerExtraInfo
 
@@ -34,14 +36,13 @@ def extract_exec_info(record: LogRecord) -> dict[str, ExecValues] | None:
 
 
 class ConsoleHandler(Handler):
-    def __init__(self, print_func, buffer_output):
+    def __init__(self, print_func: Callable, buffer_output: Callable):
         super().__init__()
         self.print_func: Callable = print_func
         self.buffer_func: Callable = buffer_output
 
-    def emit(self, record: LogRecord, return_str: bool = False):
-        """
-        Emit a log record either to console or return as string.
+    def emit(self, record: LogRecord, return_str: bool = False) -> Any:
+        """Emit a log record either to console or return as string.
 
         Args:
             record: The LogRecord to emit
@@ -53,13 +54,13 @@ class ConsoleHandler(Handler):
         formatted_msg: str = self.format(record)
         extra: LoggerExtraInfo = get_extra(record)
         exec_values: dict[str, ExecValues] | None = extract_exec_info(record)
-        exc_info: bool = True if exec_values is not None else False
+        exc_info: bool = bool(exec_values)
         style_name = extra.get("style_name", "")
 
         print_kwargs = {
             "msg": formatted_msg,
             "style": style_name,
-            "exc_info": exc_info if exc_info is not None else False,
+            "exc_info": bool(exc_info),
             "exec_values": exec_values,
             "return_str": return_str,
         }
@@ -97,11 +98,14 @@ class ConsoleBuffering(BufferingHandler):
     def __init__(
         self,
         capacity: int = 9999,
-        console_handler=ConsoleHandler(print_func=lambda **kwargs: None, buffer_output=lambda **kwargs: ""),
+        console_handler: ConsoleHandler | None = None,
         return_auto: bool = False,
     ):
         super().__init__(capacity=capacity)
-        self.console_handler: ConsoleHandler = console_handler  # should come with a formatter before getting here
+        # should come with a formatter before getting here
+        self.console_handler: ConsoleHandler = console_handler or ConsoleHandler(
+            print_func=lambda **kwargs: None, buffer_output=lambda **kwargs: ""
+        )
         self._lock = threading.RLock()
         self.flush_auto = return_auto
 
@@ -118,7 +122,7 @@ class ConsoleBuffering(BufferingHandler):
         self.buffer.clear()
         return Text.from_ansi(output)
 
-    def trigger_flush(self):
+    def trigger_flush(self) -> None:
         """Immediately flush all buffered records to console."""
         self.flush()
 

bear_utils/logging/logger_manager/_styles.py

@@ -71,8 +71,7 @@ LOGGER_METHODS: dict[str, LoggerExtraInfo] = {
 
 
 def get_method(name: str) -> LoggerExtraInfo:
-    """
-    Get the name info from the logger methods.
+    """Get the name info from the logger methods.
 
     Args:
         name (str): The name of the logger method.

bear_utils/logging/logger_manager/loggers/__init__.py

@@ -0,0 +1 @@
+"""A module with all of the loggers used in the logger manager."""

bear_utils/logging/logger_manager/loggers/_base_logger.py

@@ -1,7 +1,7 @@
-import sys
 from functools import partial
 from io import StringIO
-from typing import Self
+import sys
+from typing import Any, Self
 
 from prompt_toolkit.formatted_text import ANSI, FormattedText, to_formatted_text
 from prompt_toolkit.shortcuts import print_formatted_text
@@ -11,8 +11,9 @@ from rich.theme import Theme
 from rich.traceback import Traceback
 from singleton_base import SingletonBase
 
-from .._common import ExecValues, StackLevelTracker
-from .._styles import DEFAULT_THEME, LOGGER_METHODS, LoggerExtraInfo
+from bear_utils.logging.logger_manager._common import ExecValues, StackLevelTracker
+from bear_utils.logging.logger_manager._styles import DEFAULT_THEME, LOGGER_METHODS, LoggerExtraInfo
+
 from ._level_sin import INFO, add_level_name, check_level, lvl_exists
 from ._sub_logger import SubConsoleLogger
 
@@ -20,14 +21,14 @@ from ._sub_logger import SubConsoleLogger
 class BaseLogger(SingletonBase):
     def __init__(
         self,
-        output_handler=None,
+        output_handler: Any = None,
         theme: Theme | None = None,
         style_disabled: bool = False,
         logger_mode: bool = False,
         **kwargs,
     ) -> None:
-        """
-        Initialize the BaseLogger with an optional style_disabled flag.
+        """Initialize the BaseLogger with an optional style_disabled flag.
+
         This flag can be used to disable styled output in the logger.
         """
         self.output_handler = output_handler or self._default_output
@@ -37,7 +38,7 @@ class BaseLogger(SingletonBase):
         self.theme: Theme = DEFAULT_THEME if theme is None else theme
         self.style_disabled: bool = style_disabled
         self.console: Console = self.get_console(self.theme, style_disabled)
-        self.console_buffer: StringIO = self.console.file  # type: ignore
+        self.console_buffer: StringIO = self.console.file  # type: ignore[assignment]
         self.backup_console = Console(theme=self.theme, highlight=True, force_terminal=True)
         self._generate_style_methods()
 
@@ -60,21 +61,21 @@ class BaseLogger(SingletonBase):
             )
         return console
 
-    def _default_output(self, msg: object, extra: LoggerExtraInfo, *args, **kwargs) -> None:
+    def _default_output(self, msg: object, _: LoggerExtraInfo, *args, **kwargs) -> None:
         """Default output handler that prints to console."""
         if not self.logger_mode:
             self.print(msg, *args, **kwargs)
 
     def __enter__(self) -> Self:
-        """
-        Enter the context manager, returning the ConsoleLogger instance.
+        """Enter the context manager, returning the ConsoleLogger instance.
+
         This allows for using the logger in a with statement.
         """
         return self
 
-    def __exit__(self, exc_type, exc_value, traceback) -> None:
-        """
-        Exit the context manager, cleaning up resources.
+    def __exit__(self, exc_type: object, exc_value: object, traceback: object) -> None:
+        """Exit the context manager, cleaning up resources.
+
         This is called when the with statement is exited.
         """
         self.exit()
@@ -83,8 +84,8 @@ class BaseLogger(SingletonBase):
         return "No buffering handler available."
 
     def set_base_level(self, level: int | str) -> None:
-        """
-        Set the logging level for the console.
+        """Set the logging level for the console.
+
         This method allows changing the logging level dynamically.
 
         This isn't actually a logging logger so we are having to add this while avoiding messing with
@@ -96,8 +97,8 @@ class BaseLogger(SingletonBase):
         self._level = check_level(level)
 
     def filter_by_level(self, level: str | int) -> bool:
-        """
-        Filter method to determine if a message should be logged based on its level.
+        """Filter method to determine if a message should be logged based on its level.
+
         This method checks if the provided level is greater than or equal to the logger's level.
 
         Args:
@@ -135,13 +136,13 @@ class BaseLogger(SingletonBase):
         self,
         msg: object,
         end: str = "\n",
-        exc_info=None,
+        exc_info: object | None = None,
         extra: dict | None = None,
-        *args,
+        *_,
         **kwargs,
     ) -> None | str:
-        """
-        Print a message to the console with the specified formatting.
+        """Print a message to the console with the specified formatting.
+
         This method allows for printing messages with additional context and formatting.
         """
         if exc_info is not None:
@@ -165,28 +166,27 @@ class BaseLogger(SingletonBase):
         indent: int = 2,
         sort: bool = False,
         **kwargs,
-    ):
+    ) -> None:
         """Just a pass-through to the console.print_json method."""
         self.console.print_json(json=json, data=data, indent=indent, sort_keys=sort, **kwargs)
 
-    def raw_print(self, msg: object, end: str = "\n", *args, **kwargs) -> None:
-        """
-        Use the underlying console directly and bypass all the extra formatting and handling.
+    def raw_print(self, msg: object, end: str = "\n", *_, **kwargs) -> None:
+        """Use the underlying console directly and bypass all the extra formatting and handling.
 
         Args:
             msg (object): The message to print.
-            end (str, optional): The string appended after the message. Defaults to "\n".
+            end (str, optional): The string appended after the message. Defaults to new line.
         """
         self.backup_console.print(msg, end=end, style=kwargs.pop("style", "white"), **kwargs)
 
     def _print(self, msg: object, end: str, json: bool = False, *args, **kwargs) -> None:
-        """
-        Print a message to the console with the specified formatting.
+        """Print a message to the console with the specified formatting.
+
         This method allows for printing messages with additional context and formatting.
         """
         try:
             if json:
-                self.print_json(data=msg, *args, **kwargs)  # type: ignore[arg-type]
+                self.print_json(msg, *args, **kwargs)  # type: ignore[arg-type]
             else:
                 self.console.print(msg, end="", style=kwargs.pop("style", "white"))
             formatted_text: FormattedText = to_formatted_text(ANSI(self.console_buffer.getvalue()))
@@ -199,7 +199,7 @@ class BaseLogger(SingletonBase):
             )
             self._reset_buffer()
 
-    def _extract_exception_values(self, exc_info) -> ExecValues | None:
+    def _extract_exception_values(self, exc_info: Any) -> ExecValues | None:
         """Extract exception values in a clean, reusable way."""
         if isinstance(exc_info, BaseException):
             exc_tuple = (type(exc_info), exc_info, exc_info.__traceback__)
@@ -231,8 +231,8 @@ class BaseLogger(SingletonBase):
         self.console_buffer.seek(0)
 
     def exit(self) -> None:
-        """
-        Exit the console logger.
+        """Exit the console logger.
+
         This method is called when the program exits to clean up resources.
         """
         self.console_buffer.close()

bear_utils/logging/logger_manager/loggers/_base_logger.pyi

@@ -7,7 +7,8 @@ from rich.theme import Theme
 from rich.traceback import Traceback
 from singleton_base import SingletonBase
 
-from .._common import ExecValues, StackLevelTracker
+from bear_utils.logging.logger_manager._common import ExecValues, StackLevelTracker
+
 from ._sub_logger import SubConsoleLogger
 
 class BaseLogger(SingletonBase):
@@ -21,22 +22,22 @@ class BaseLogger(SingletonBase):
     logger_mode: bool
     sub_logger: dict[str, SubConsoleLogger]
     # fmt: off
-    def __init__(self, output_handler = None, theme: Theme | None = ..., style_disabled: bool = ..., logger_mode: bool = ..., **kwargs) -> None: ...
+    def __init__(self, output_handler: Any  = None, theme: Theme | None = ..., style_disabled: bool = ..., logger_mode: bool = ..., **kwargs) -> None: ...
     @staticmethod
     def get_console(theme: Theme, style_disabled: bool) -> Console: ...
     def __enter__(self) -> Self: ...
-    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None: ...
+    def __exit__(self, exc_type: object, exc_value: object, traceback: object) -> None: ...
     def _generate_style_methods(self, **kwargs) -> None: ...
     def get_sub_logger(self, namespace: str, **kwargs: Any) -> SubConsoleLogger: ...
     def replacement_method(self, msg: object, *args: Any, **kwargs: Any) -> None: ...
-    def print(self, msg: object, end: str="\n", exc_info=None, extra: dict | None = None, *args, **kwargs) -> None | str: ...
+    def print(self, msg: object, end: str="\n", exc_info:str|None=None, extra: dict | None = None, *args, **kwargs) -> None | str: ...
     def print_json(self, data: Any | None = ..., indent: int = ..., sort: bool = ...) -> None: ...
     def set_base_level(self, level: int) -> None: ...
     def filter_by_level(self, level: int) -> bool: ...
     def trigger_buffer_flush(self) -> str | Text: ...
     def _print(self, msg: object, end: str, json: bool = ..., *args: Any, **kwargs: Any) -> None: ...
     def _get_exception(self, manual: bool = ..., exec_values: ExecValues | None = ...) -> Traceback: ...
-    def _extract_exception_values(self, exc_info) -> ExecValues | None: ...
+    def _extract_exception_values(self, exc_info: str | None) -> ExecValues | None: ...
     def _reset_buffer(self) -> None: ...
     def exit(self) -> None: ...
     def debug(self, msg: object, *args: Any, **kwargs: Any) -> None: ...

bear_utils/logging/logger_manager/loggers/_buffer_logger.py

@@ -8,8 +8,7 @@ from ._sub_logger import SubConsoleLogger
 
 
 class BufferLogger(ConsoleLogger):
-    """
-    A buffer-based logger that writes styled log messages to a buffer.
+    """A buffer-based logger that writes styled log messages to a buffer.
 
     Combines Python's logging framework with Rich console styling, but outputs
     to a buffer instead of console or file. Supports buffering of log messages,
@@ -34,7 +33,7 @@ class BufferLogger(ConsoleLogger):
         theme: Theme | None = None,
         name: str = "BufferLogger",
         level: int = DEBUG,
-        *args,
+        *_,
         **kwargs,
     ) -> None:
         ConsoleLogger.__init__(