inspy-logger 3.0.dev3__tar.gz → 3.0.dev4__tar.gz

{inspy_logger-3.0.dev3 → inspy_logger-3.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: inspy-logger
-Version: 3.0.dev3
+Version: 3.0.dev4
 Summary: Colorable, scalable logger for CLI
 Home-page: https://github.com/Inspyre-Softworks/inSPy-Logger
 License: MIT

{inspy_logger-3.0.dev3 → inspy_logger-3.0.dev4}/inspy_logger/Scripts/main.py

@@ -68,7 +68,7 @@ def get_version_info():
     table.add_row('Full Version Name', get_full_version_name())
 
     if pypi_info.update_available:
-        table.add_row('Update Available', f'[bold green]Yes[/bold green]')
+        table.add_row('Update Available', '[bold green]Yes[/bold green]')
         table.add_row('Latest Version', f'{pypi_info.new_version_available_num}')
 
     table.add_row('Python Executable Path', sys.executable)
@@ -80,10 +80,7 @@ def get_version_info():
 
 def main():
 
-    if parsed_args.subcommand == 'update':
-        return update()
-
-    return get_version_info()
+    return update() if parsed_args.subcommand == 'update' else get_version_info()
 
 
 

{inspy_logger-3.0.dev3 → inspy_logger-3.0.dev4}/inspy_logger/__about__.py

@@ -11,9 +11,10 @@ Since:
     v2.1.1
 
 """
+from inspy_logger.version import parse_version
 
 __prog__ = 'inSPy-Logger'
-__version__ = '3.0-dev.1'
+__version__ = parse_version()
 __authors__ = [
         ('Inspyre-Softworks', 'https://inspyre.tech'),
         ('Taylor-Jayde Blackstone', '<t.blackstone@inspyre.tech')

{inspy_logger-3.0.dev3 → inspy_logger-3.0.dev4}/inspy_logger/__init__.py

@@ -6,7 +6,6 @@ from rich.logging import RichHandler
 from inspy_logger.__about__ import __prog__ as PROG_NAME
 from inspy_logger.helpers import find_variable_in_call_stack
 
-
 # Let's set up some constants.
 LEVEL_MAP = [
     ('debug', logging.DEBUG),
@@ -40,11 +39,17 @@ class Logger:
     A Singleton class responsible for managing the logging mechanisms of the application.
     """
 
-    instances = {}
+    instances = {}  # A dictionary to hold instances of the Logger class.
 
     def __new__(cls, name, *args, **kwargs):
         """
         Creates or returns an existing instance of the Logger class for the provided name.
+
+        Args:
+            name (str): The name of the logger instance.
+
+        Returns:
+            Logger: An instance of the Logger class.
         """
 
         if name not in cls.instances:
@@ -54,15 +59,22 @@ class Logger:
         return cls.instances[name]
 
     def __init__(
-        self,
-        name,
-        console_level=DEFAULT_LOGGING_LEVEL,
-        file_level=logging.DEBUG,
-        filename="app.log",
-        parent=None,
+            self,
+            name,
+            console_level=DEFAULT_LOGGING_LEVEL,
+            file_level=logging.DEBUG,
+            filename="app.log",
+            parent=None,
     ):
         """
         Initializes a logger instance.
+
+        Args:
+            name (str): The name of the logger instance.
+            console_level (str, optional): The logging level for the console. Defaults to DEFAULT_LOGGING_LEVEL.
+            file_level (str, optional): The logging level for the file. Defaults to logging.DEBUG.
+            filename (str, optional): The name of the log file. Defaults to "app.log".
+            parent (Logger, optional): The parent logger instance. Defaults to None.
         """
 
         if not hasattr(self, "logger"):
@@ -93,10 +105,22 @@ class Logger:
 
     @property
     def device(self):
+        """
+        Returns the logger instance.
+
+        Returns:
+            Logger: The logger instance.
+        """
         return self.logger
 
     @property
     def name(self):
+        """
+        Returns the name of the logger instance.
+
+        Returns:
+            str: The name of the logger instance.
+        """
         return self.logger.name
 
     def set_up_console(self):
@@ -181,6 +205,18 @@ class Logger:
         return self.parent
 
     def find_child_by_name(self, name: str, case_sensitive=True, exact_match=False):
+        """
+        Searches for a child logger by its name.
+
+        Args:
+            name (str): The name of the child logger to search for.
+            case_sensitive (bool, optional): Whether the search should be case sensitive. Defaults to True.
+            exact_match (bool, optional): Whether the search should only return exact matches. Defaults to False.
+
+        Returns:
+            list or Logger: If exact_match is True, returns the Logger instance if found, else returns an empty list.
+                            If exact_match is False, returns a list of Logger instances whose names contain the search term.
+        """
         self.logger.debug(f'Searching for child with name: {name}')
         results = []
 
@@ -197,17 +233,41 @@ class Logger:
         return results
 
     def debug(self, message):
-        self.logger.debug(message)
+            """
+            Logs a debug message.
+
+            Args:
+                message (str): The message to log.
+            """
+            self._log(logging.DEBUG, message, args=(), stacklevel=2)
+
 
     def info(self, message):
-        self.logger.info(message)
+            """
+            Logs an info message.
+
+            Args:
+                message (str): The message to log.
+            """
+            self._log(logging.INFO, message, args=(), stacklevel=2)
 
     def warning(self, message):
-        self.logger.warning(message)
+        """
+        Logs a warning message.
+
+        Args:
+            message (str): The message to log.
+        """
+        self._log(logging.WARNING, message, args=(), stacklevel=2)
 
     def error(self, message):
-        self.logger.error(message)
+        """
+        Logs an error message.
 
+        Args:
+            message (str): The message to log.
+        """
+        self._log(logging.ERROR, message, args=(), stacklevel=2)
 
     def __repr__(self):
         name = self.name
@@ -224,7 +284,6 @@ class Logger:
 
         return f'<Logger: {name} w/ level {self.logger.level} at {hex_id}{parent_part}>'
 
-
     @classmethod
     def create_logger_for_caller(cls):
         """
@@ -234,12 +293,7 @@ class Logger:
             Logger: An instance of the Logger class for the calling module.
         """
         frame = inspect.currentframe().f_back
-        #print(frame)
-        #print(dir(frame))
-        #print(dir(inspect.getmodule(frame)))
-        #print(inspect.getmodule(frame).__name__)
-        module_path = cls._determine_module_path(frame)
-        if module_path:
+        if module_path := cls._determine_module_path(frame):
             return cls(module_path)
         else:
             raise ValueError("Unable to determine module path for logger creation.")
@@ -250,24 +304,29 @@ class Logger:
         Determines the in-project path of the module from the call frame.
 
         Args:
-            frame: The frame from which to determine the module path.
+            frame:
+                The frame from which to determine the module path.
 
         Returns:
-            str: The in-project path of the module.
+            str:
+                The in-project path of the module.
         """
-        module = inspect.getmodule(frame)
-        if module:
+        if module := inspect.getmodule(frame):
             base_path = os.path.dirname(os.path.abspath(module.__file__))
             relative_path = os.path.relpath(frame.f_code.co_filename, base_path)
-            module_path = relative_path.replace(os.path.sep, '.').rstrip('.py')
-            return module_path
+            return relative_path.replace(os.path.sep, '.').rstrip('.py')
         return None
 
+    def _log(self, level, msg, args, exc_info=None, extra=None, stack_info=False, stacklevel=1):
+        """
+        Low-level logging implementation, passing stacklevel to findCaller.
+        """
+        if self.logger.isEnabledFor(level):
+            self.logger._log(level, msg, args, exc_info, extra, stack_info, stacklevel + 1)
 
 
 found_level = find_variable_in_call_stack('INSPY_LOG_LEVEL', DEFAULT_LOGGING_LEVEL)
 
-
 LOG_DEVICE = Logger(PROG_NAME, found_level)
 MOD_LOG_DEVICE = LOG_DEVICE.get_child("log_engine", found_level)
 MOD_LOGGER = MOD_LOG_DEVICE.logger

{inspy_logger-3.0.dev3 → inspy_logger-3.0.dev4}/inspy_logger/version.py

@@ -16,7 +16,7 @@ __VERSION__ = {
     'minor': 0,
     'patch': 0,
     'release': 'dev',
-    'release_num': 3
+    'release_num': 4
 }
 
 

{inspy_logger-3.0.dev3 → inspy_logger-3.0.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "inspy-logger"
-version = "3.0-dev.3"
+version = "3.0-dev.4"
 description = "Colorable, scalable logger for CLI"
 authors = ["Taylor-Jayde Blackstone <tayjaybabee@gmail.com>"]
 homepage = 'https://github.com/Inspyre-Softworks/inSPy-Logger'