bear-utils 0.9.5__tar.gz → 0.9.7__tar.gz

{bear_utils-0.9.5 → bear_utils-0.9.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bear-utils
-Version: 0.9.5
+Version: 0.9.7
 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

{bear_utils-0.9.5 → bear_utils-0.9.7}/pyproject.toml

@@ -103,5 +103,5 @@ format = "{base}"
 [tool.hatch.build.hooks.version]
 path = "src/bear_utils/_internal/_version.py"
 template = '''
-version = "{version}"
+__version__ = "{version}"
 '''

bear_utils-0.9.7/src/bear_utils/_internal/_version.py

@@ -0,0 +1 @@
+__version__ = "0.9.7"

{bear_utils-0.9.5 → bear_utils-0.9.7}/src/bear_utils/_internal/cli.py

@@ -15,7 +15,6 @@ import sys
 from typing import Any
 
 from bear_utils._internal import debug
-from bear_utils._internal._version import version as _version
 from bear_utils.cli._get_version import VALID_BUMP_TYPES, cli_bump
 from bear_utils.constants import STDERR, ExitCode
 
@@ -43,14 +42,14 @@ class _Version(Action):
         super().__init__(nargs=nargs, **kwargs)
 
     def __call__(self, *_: Any, **__: Any) -> None:
-        version: str = f"{debug._get_name()} v{_version}"
+        version: str = f"{debug._get_name()} v{debug._get_version()}"
         print(version)
         sys.exit(ExitCode.SUCCESS)
 
 
 def get_version() -> ExitCode:
     """CLI command to get the version of the package."""
-    print(_version)
+    print(debug._get_version())
     return ExitCode.SUCCESS
 
 
@@ -64,11 +63,11 @@ def bump_version(args: list[str] | None = None) -> ExitCode:
         help=f"Type of version bump: {', '.join(VALID_BUMP_TYPES)}",
     )
     _args: Namespace = parser.parse_args(args or sys.argv[1:])
-    return cli_bump([_args.bump_type, debug.__PACKAGE_NAME__, _version])
+    return cli_bump([_args.bump_type, debug._get_name(), debug._get_version()])
 
 
 def get_parser() -> ArgumentParser:
-    name = debug._get_name()
+    name: str = debug._get_name()
     parser = ArgumentParser(description=name.capitalize(), prog=name, exit_on_error=False)
     parser.add_argument("-V", "--version", action=_Version, help="Print the version of the package")
     subparser = parser.add_subparsers(dest="command", required=False, help="Available commands")

{bear_utils-0.9.5 → bear_utils-0.9.7}/src/bear_utils/_internal/debug.py

@@ -7,22 +7,50 @@ import os
 import platform
 import sys
 
-from bear_utils._internal._version import version as _version
+from pydantic import BaseModel, Field, field_validator
+
+from bear_utils._internal._version import __version__
 from bear_utils.cli._get_version import Version
 
 __PACKAGE_NAME__ = "bear-utils"
 
 
+class _ProjectMetadata(BaseModel):
+    """Dataclass to store project metadata."""
+
+    name: str = Field(default=__PACKAGE_NAME__, description="Project name of the package.")
+    version: str = Field(default=__version__, description="Project version.")
+    description: str = Field(default="No description available.", description="Project description.")
+
+    def __str__(self) -> str:
+        """String representation of the project metadata."""
+        return f"{self.name} v{self.version}: {self.description}"
+
+    @field_validator("version", mode="before")
+    @classmethod
+    def validate_version(cls, v: str) -> str:
+        """Validate the version string."""
+        if not isinstance(v, str) or "0.0.0" in v:
+            try:
+                v = version(__PACKAGE_NAME__)
+            except PackageNotFoundError:
+                v = "0.0.0"
+        return v
+
+
+_metadata = _ProjectMetadata()
+
+
 @dataclass
 class _Package:
     """Dataclass to store package information."""
 
-    name: str = __PACKAGE_NAME__
+    name: str = _metadata.name
     """Package name."""
-    version: str = _version
+    version: str = _metadata.version
     """Package version."""
-    _version: Version = field(default_factory=lambda: Version.from_string(_version))
-    description: str = "No description available."
+    _version: Version = field(default_factory=lambda: Version.from_string(_metadata.version))
+    description: str = _metadata.description
     """Package description."""
 
     def __post_init__(self) -> None:
@@ -40,7 +68,7 @@ class _Package:
         return f"{self.name} v{self.version}: {self.description}"
 
 
-@dataclass
+@dataclass(frozen=True)
 class _Variable:
     """Dataclass describing an environment variable."""
 
@@ -50,7 +78,7 @@ class _Variable:
     """Variable value."""
 
 
-@dataclass
+@dataclass(frozen=True)
 class _Environment:
     """Dataclass to store environment information."""
 
@@ -79,18 +107,18 @@ def _interpreter_name_version() -> tuple[str, str]:
     return "", "0.0.0"
 
 
-def _get_package_info(dist: str = __PACKAGE_NAME__) -> _Package:
+def _get_package_info(dist: str = _metadata.name) -> _Package:
     try:
         return _Package(
             name=dist,
-            version=_version or version(dist),
+            version=_metadata.version or version(dist),
             description=metadata(dist)["Summary"],
         )
     except PackageNotFoundError:
         return _Package(name=dist)
 
 
-def _get_name(dist: str = __PACKAGE_NAME__) -> str:
+def _get_name(dist: str = _metadata.name) -> str:
     """Get name of the given distribution.
 
     Parameters:
@@ -102,7 +130,7 @@ def _get_name(dist: str = __PACKAGE_NAME__) -> str:
     return _get_package_info(dist).name
 
 
-def _get_version(dist: str = __PACKAGE_NAME__) -> str:
+def _get_version(dist: str = _metadata.name) -> str:
     """Get version of the given distribution.
 
     Parameters:
@@ -114,7 +142,7 @@ def _get_version(dist: str = __PACKAGE_NAME__) -> str:
     return _get_package_info(dist).version
 
 
-def _get_description(dist: str = __PACKAGE_NAME__) -> str:
+def _get_description(dist: str = _metadata.name) -> str:
     """Get description of the given distribution.
 
     Parameters:
@@ -133,10 +161,10 @@ def _get_debug_info() -> _Environment:
         Environment information.
     """
     py_name, py_version = _interpreter_name_version()
-    packages: list[str] = [__PACKAGE_NAME__]
+    packages: list[str] = [_metadata.name]
     variables: list[str] = [
         "PYTHONPATH",
-        *[var for var in os.environ if var.startswith(__PACKAGE_NAME__.replace("-", "_"))],
+        *[var for var in os.environ if var.startswith(_metadata.name.replace("-", "_"))],
     ]
     return _Environment(
         interpreter_name=py_name,

{bear_utils-0.9.5 → bear_utils-0.9.7}/src/bear_utils/extras/_zapper.py

@@ -189,7 +189,7 @@ def zap_multi(
         >>> zap_multi("!?*", "Hello!? World! *", "-")
         'Hello- World- -'
     """
-    zapper = Zapper(sym, src, replace, atomic=atomic)
+    zapper: Zapper[str] = Zapper(sym, src, replace, atomic=atomic)
     return zapper.zap().value
 
 

bear_utils-0.9.5/src/bear_utils/logger_manager/_console_junk.py → bear_utils-0.9.7/src/bear_utils/logger_manager/_logger_misc.py

@@ -1,5 +1,6 @@
 from collections.abc import Callable
 from io import StringIO
+import json
 from logging import Formatter, Handler, LogRecord
 from logging.handlers import BufferingHandler
 import threading
@@ -94,6 +95,24 @@ class ConsoleFormatter(Formatter):
         return super().format(record)
 
 
+class JSONLFormatter(Formatter):
+    """A formatter that outputs log records in JSON Lines format."""
+
+    def format(self, record: LogRecord) -> str:
+        extra: LoggerExtraInfo = get_extra(record)
+        log_entry = {
+            "time": self.formatTime(record, self.datefmt),
+            "level": record.levelname,
+            "message": record.msg,
+            "funcName": record.funcName,
+            "name": record.name,
+            "module": record.module,
+            "line": record.lineno,
+            **extra,
+        }
+        return json.dumps(log_entry)
+
+
 class ConsoleBuffering(BufferingHandler):
     def __init__(
         self,

{bear_utils-0.9.5 → bear_utils-0.9.7}/src/bear_utils/logger_manager/loggers/_console.py

@@ -15,6 +15,8 @@ from rich.text import Text
 from rich.theme import Theme, ThemeStack
 from rich.themes import DEFAULT
 
+from bear_utils.logger_manager._log_level import LogLevel
+
 if TYPE_CHECKING:
     from rich.color import ColorSystem
     from rich.live import Live
@@ -62,6 +64,7 @@ class LogConsole[T: TextIO](Console):
         get_datetime: Callable[[], datetime] | None = None,
         get_time: Callable[[], float] | None = None,
         _environ: Mapping[str, str] | None = None,
+        level: str | int | LogLevel = LogLevel.INFO,
     ):
         # Copy of os.environ allows us to replace it for testing
         if _environ is not None:
@@ -144,6 +147,7 @@ class LogConsole[T: TextIO](Console):
         self._render_hooks: list[RenderHook] = []
         self._live: Live | None = None
         self._is_alt_screen = False
+        self.level: LogLevel = LogLevel.get(level, default=LogLevel.INFO)
 
     @property
     def file(self) -> T:
@@ -159,37 +163,52 @@ class LogConsole[T: TextIO](Console):
         """Set a new file object."""
         self._file = new_file
 
+    def _log(self, level: LogLevel, msg: object, *args, **kwargs) -> None:
+        """Log a message at the specified level.
+
+        Args:
+            level (LogLevel): The log level for the message. We aren't using this parameter in the current implementation,
+            msg (object): The message to log.
+            *args: Additional positional arguments.
+            **kwargs: Additional keyword arguments.
+        """
+        if level.value >= self.level.value:
+            """Log a message at the specified level."""
+            with self._lock:
+                if not self.quiet:
+                    self.log(msg, *args, **kwargs)
+
     def info(self, msg: object, *args, **kwargs) -> None:
         """Log an informational message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.INFO, msg, *args, **kwargs)
 
     def warning(self, msg: object, *args, **kwargs) -> None:
         """Log a warning message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.WARNING, msg, *args, **kwargs)
 
     def error(self, msg: object, *args, **kwargs) -> None:
         """Log an error message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.ERROR, msg, *args, **kwargs)
 
     def debug(self, msg: object, *args, **kwargs) -> None:
         """Log a debug message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.DEBUG, msg, *args, **kwargs)
 
     def verbose(self, msg: object, *args, **kwargs) -> None:
         """Log a verbose message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.VERBOSE, msg, *args, **kwargs)
 
     def success(self, msg: object, *args, **kwargs) -> None:
         """Log a success message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.SUCCESS, msg, *args, **kwargs)
 
     def failure(self, msg: object, *args, **kwargs) -> None:
         """Log a failure message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.FAILURE, msg, *args, **kwargs)
 
     def exception(self, msg: object, *args, **kwargs) -> None:
         """Log an exception message to the console."""
-        self.log(msg, *args, **kwargs)
+        self._log(LogLevel.ERROR, msg, *args, **kwargs)
 
 
 if __name__ == "__main__":

{bear_utils-0.9.5 → bear_utils-0.9.7}/src/bear_utils/logger_manager/loggers/console_logger.py

@@ -14,7 +14,7 @@ from rich.theme import Theme
 
 from bear_utils.constants.date_related import DATE_TIME_FORMAT
 from bear_utils.logger_manager._common import FIVE_MEGABYTES, VERBOSE_CONSOLE_FORMAT, VERBOSE_FORMAT, ExecValues
-from bear_utils.logger_manager._console_junk import ConsoleBuffering, ConsoleFormatter, ConsoleHandler
+from bear_utils.logger_manager._logger_misc import ConsoleBuffering, ConsoleFormatter, ConsoleHandler
 
 from .base_logger import BaseLogger
 
@@ -124,6 +124,24 @@ class ConsoleLogger(Logger, BaseLogger):
             for handler in self._handlers:
                 self.addHandler(handler)
 
+    def set_console_formatter(self, fmt: str = VERBOSE_CONSOLE_FORMAT) -> None:
+        """Set the formatter for the console handler."""
+        if hasattr(self, "console_handler"):
+            self.console_handler.setFormatter(ConsoleFormatter(fmt=fmt, datefmt=DATE_TIME_FORMAT))
+            self.verbose(f"ConsoleLogger: Console formatter set to {fmt}")
+
+    def set_file_formatter(self, fmt: str = VERBOSE_FORMAT) -> None:
+        """Set the formatter for the file handler."""
+        if hasattr(self, "file_handler"):
+            self.file_handler.setFormatter(Formatter(fmt=fmt, datefmt=DATE_TIME_FORMAT))
+            self.verbose(f"ConsoleLogger: File formatter set to {fmt}")
+
+    def set_buffer_formatter(self, fmt: str = VERBOSE_CONSOLE_FORMAT) -> None:
+        """Set the formatter for the buffer handler."""
+        if hasattr(self, "buffer_handler"):
+            self.buffer_handler.setFormatter(ConsoleFormatter(fmt=fmt, datefmt=DATE_TIME_FORMAT))
+            self.verbose(f"ConsoleLogger: Buffer formatter set to {fmt}")
+
     def stop_queue_listener(self) -> None:
         """Stop the queue listener if it exists and clean up resources."""
         if hasattr(self, "listener"):

{bear_utils-0.9.5 → bear_utils-0.9.7}/src/bear_utils/logger_manager/loggers/console_logger.pyi

@@ -5,7 +5,7 @@ from typing import Any
 from rich.text import Text
 from rich.theme import Theme
 
-from bear_utils.logger_manager._console_junk import ConsoleBuffering, ConsoleHandler
+from bear_utils.logger_manager._logger_misc import ConsoleBuffering, ConsoleHandler
 
 from .base_logger import BaseLogger
 from .sub_logger import SubConsoleLogger

bear_utils-0.9.5/src/bear_utils/_internal/_version.py

@@ -1 +0,0 @@
-version = "0.9.5"