logging-handler 1.0.7__tar.gz → 1.0.8__tar.gz

{logging_handler-1.0.7 → logging_handler-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: logging_handler
-Version: 1.0.7
+Version: 1.0.8
 Summary: Python Library to quickly create logging handlers
 Author-email: Thomas Dunteman <git@learningtopi.com>
 Project-URL: Homepage, https://www.learningtopi.com/python-modules-applications/python_logging_handler/
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: license-file
 
 # Python Logging Helper
 Python library to quickly create logging handlers.  Supports logging to the console as well as to file using a syslog style output format.
@@ -65,8 +66,16 @@ In the examples above, you can create multiple loggers with different names.  If
 
 ## Release Notes
 
-v1.0.2  
-        - Moved console level to the 1st parameter.  Make it quicker and easier to create a console logger
-        - Chaned default console level to INFO from WARNING.  This is what I typically end up using anyway
-        - Updated the home page to our new logging_handler page:  https://www.learningtopi.com/python-modules-applications/python_logging_handler/
-        - Allow passing static values DEBUG, INFO, WARNING, ERROR and CRITICAL from the logging module (or you may import from this library)
+Release notes can now be found in the release notes folder.
+
+## Changing Logging Level
+
+As of v1.0.8, two functions, "update_console_level" and "update_file_level" have been added.  To change the logging level on the fly:
+
+    >>> from logging_helper import create_logger, update_console_level
+    >>> logger = create_logger(console=True)
+    >>> update_console_level(logger, 'info')
+
+## CustomLogger class
+
+As of v1.0.8, a CustomLogger class was added.  This performs the same function as using create_logger, however rather than requiring a separate function to update logging levels, the class includes a "console_level" and "file_level" function that can be used.  The class also utilizes threading to enable old logfile cleanup.

{logging_handler-1.0.7 → logging_handler-1.0.8}/README.md

@@ -48,8 +48,16 @@ In the examples above, you can create multiple loggers with different names.  If
 
 ## Release Notes
 
-v1.0.2  
-        - Moved console level to the 1st parameter.  Make it quicker and easier to create a console logger
-        - Chaned default console level to INFO from WARNING.  This is what I typically end up using anyway
-        - Updated the home page to our new logging_handler page:  https://www.learningtopi.com/python-modules-applications/python_logging_handler/
-        - Allow passing static values DEBUG, INFO, WARNING, ERROR and CRITICAL from the logging module (or you may import from this library)
+Release notes can now be found in the release notes folder.
+
+## Changing Logging Level
+
+As of v1.0.8, two functions, "update_console_level" and "update_file_level" have been added.  To change the logging level on the fly:
+
+    >>> from logging_helper import create_logger, update_console_level
+    >>> logger = create_logger(console=True)
+    >>> update_console_level(logger, 'info')
+
+## CustomLogger class
+
+As of v1.0.8, a CustomLogger class was added.  This performs the same function as using create_logger, however rather than requiring a separate function to update logging levels, the class includes a "console_level" and "file_level" function that can be used.  The class also utilizes threading to enable old logfile cleanup.

{logging_handler-1.0.7 → logging_handler-1.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "logging_handler"
-version = "1.0.7"
+version = "1.0.8"
 description = "Python Library to quickly create logging handlers"
 authors = [{name = "Thomas Dunteman", email= "git@learningtopi.com"}]
 keywords = ["logging", "syslog"]
@@ -10,8 +10,7 @@ classifiers = [
     "Topic :: System :: Logging",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3"
-]
+    "Programming Language :: Python :: 3"]
 dependencies = []
 
 [project.urls]

logging_handler-1.0.8/src/logging_handler/__init__.py

@@ -0,0 +1,213 @@
+'''
+MIT License
+
+Copyright (c) 2022 LearningToPi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+'''
+import logging
+import logging.handlers
+from glob import glob
+from datetime import datetime, timedelta
+import pathlib
+import os
+import threading
+from time import sleep
+
+VERSION = (1, 0, 8)
+
+DEFAULT_LEVEL = logging.WARNING
+
+DEBUG = 'DEBUG'
+INFO = 'INFO'
+WARNING = 'WARNING'
+ERROR = 'ERROR'
+CRITICAL = 'CRITICAL'
+
+_log_level_number = {
+    'DEBUG': logging.DEBUG,
+    "INFO": logging.INFO,
+    "WARNING": logging.WARNING,
+    "ERROR": logging.ERROR,
+    "CRITICAL": logging.CRITICAL
+}
+
+
+def create_logger(console_level=WARNING, log_file='', file_level=WARNING, name='', file_mode='a', console=True,
+                  syslog=False, syslog_script_name='', log_file_vars=None, log_file_retention_days=0, propagate=False):
+    """ Creates a logger and returns the handle.
+        Log file vars should be sent as a list of dict -> [{"var": "{date}", "set": "%Y-%m-%d-%Y-%M"}]
+
+        Supported log file vars:
+            {date} - will be replaced with the current date using the provided strftime format
+    
+     """
+    logger = logging.getLogger(name)
+    logger.handlers.clear() # Clear all existing handlers before creating new ones!
+    logger.setLevel(logging.DEBUG)
+    logger.propagate = propagate
+    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+
+    # Console
+    if console:
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(console_level if isinstance(console_level, int) else _log_level_number.get(str(console_level).upper(), DEFAULT_LEVEL))
+        console_handler.setFormatter(formatter)
+        logger.addHandler(console_handler)
+
+    # syslog
+    if syslog:
+        syslog_formatter = logging.Formatter(syslog_script_name + '[%(process)d]: %(levelname)s: %(message)s')
+        syslog_handler = logging.handlers.SysLogHandler(address='/dev/log')
+        syslog_handler.setLevel(file_level if isinstance(file_level, int) else _log_level_number.get(str(file_level).upper(), DEFAULT_LEVEL))
+        syslog_handler.setFormatter(syslog_formatter)
+        logger.addHandler(syslog_handler)
+
+    # file
+    if log_file != '':
+        # replace variables in the log file name
+        if log_file_vars is not None:
+            for var in log_file_vars:
+                if isinstance(var, dict) and 'var' in var and 'set' in var and var['var'] == "{date}":
+                    log_file = log_file.replace(var['var'], datetime.now().strftime(var['set']))
+        file_handler = logging.FileHandler(log_file, mode=file_mode, encoding='utf-8', delay=False)
+        file_handler.setLevel(file_level if isinstance(file_level, int) else _log_level_number.get(str(file_level).upper(), DEFAULT_LEVEL))
+        file_handler.setFormatter(formatter)
+        logger.addHandler(file_handler)
+
+        # manage retention
+        if log_file_retention_days > 0:
+            # replace variables with a *
+            log_file_search_name = log_file
+            if log_file_vars is not None:
+                for var in log_file_vars:
+                    log_file_search_name.replace(var['var'], '*')
+            old_log_files = glob(log_file_search_name)
+            for old_log_file in old_log_files:
+                # check the age and delete if needed
+                fname = pathlib.Path(old_log_file)
+                mtime = datetime.fromtimestamp(fname.stat().st_mtime)
+                if mtime < datetime.now() - timedelta(days=log_file_retention_days):
+                    logger.info('Deleting old log file %s.  Modified time %s, retention set to %i days.', old_log_file, mtime, log_file_retention_days)
+                    os.remove(old_log_file)
+
+    # return the logger
+    return logger
+
+
+def update_console_level(logger, level):
+    """ Updates the console log level for the provided logger. """
+    for handler in logger.handlers:
+        if isinstance(handler, logging.StreamHandler):
+            handler.setLevel(level if isinstance(level, int) else _log_level_number.get(str(level).upper(), DEFAULT_LEVEL))
+            logger.info('Console log level updated to %s', level)
+
+
+def update_file_level(logger, level):
+    """ Updates the file log level for the provided logger. """
+    for handler in logger.handlers:
+        if isinstance(handler, logging.handlers.SysLogHandler):
+            handler.setLevel(level if isinstance(level, int) else _log_level_number.get(str(level).upper(), DEFAULT_LEVEL))
+            logger.info('File log level updated to %s', level)
+
+
+class CustomLogger(logging.Logger):
+    """ Custom logger class that extends the standard logging.Logger. """
+    def __init__(self, name, console_level:str=WARNING, log_file:str|None=None, file_level:str|None=None, file_mode:str='a', console:bool=True,
+                  syslog:bool=False, syslog_script_name:str='', log_file_vars:dict|None=None, log_file_retention_days:int=0, propagate:bool=False):
+        super().__init__(name, console_level if isinstance(console_level, int) else _log_level_number.get(str(console_level).upper(), DEFAULT_LEVEL))
+        self.handlers.clear() # Clear all existing handlers before creating new ones!
+        self.setLevel(logging.DEBUG)
+        self.propagate = propagate
+        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+        self.log_file_vars, self.log_file_retention_days = log_file_vars, log_file_retention_days
+
+        # Console
+        if console:
+            console_handler = logging.StreamHandler()
+            console_handler.setLevel(console_level if isinstance(console_level, int) else _log_level_number.get(str(console_level).upper(), DEFAULT_LEVEL))
+            console_handler.setFormatter(formatter)
+            self.addHandler(console_handler)
+
+        # syslog
+        if syslog:
+            syslog_formatter = logging.Formatter(syslog_script_name + '[%(process)d]: %(levelname)s: %(message)s')
+            syslog_handler = logging.handlers.SysLogHandler(address='/dev/log')
+            syslog_handler.setLevel(file_level if isinstance(file_level, int) else _log_level_number.get(str(file_level).upper(), DEFAULT_LEVEL))
+            syslog_handler.setFormatter(syslog_formatter)
+            self.addHandler(syslog_handler)
+
+        # file
+        if log_file not in (None, ''):
+            # replace variables in the log file name
+            if log_file_vars is not None:
+                for var in log_file_vars:
+                    if isinstance(var, dict) and 'var' in var and 'set' in var and var['var'] == "{date}":
+                        log_file = log_file.replace(var['var'], datetime.now().strftime(var['set']))
+            file_handler = logging.FileHandler(log_file, mode=file_mode, encoding='utf-8', delay=False)
+            file_handler.setLevel(file_level if isinstance(file_level, int) else _log_level_number.get(str(file_level).upper(), DEFAULT_LEVEL))
+            file_handler.setFormatter(formatter)
+            self.addHandler(file_handler)
+
+            # start background thread for log file cleanup if retention is set
+            if log_file_retention_days > 0:
+                self._cleanup_thread = threading.Thread(target=self._logfile_cleanup_thread, daemon=True)
+                self._cleanup_thread.start()
+
+    def console_level(self, level):
+        """ Updates the console log level for this logger. """
+        for handler in self.handlers:
+            if isinstance(handler, logging.StreamHandler):
+                handler.setLevel(level if isinstance(level, int) else _log_level_number.get(str(level).upper(), DEFAULT_LEVEL))
+                self.info('Console log level updated to %s', level)
+
+    def file_level(self, level):
+        """ Updates the file log level for this logger. """
+        for handler in self.handlers:
+            if isinstance(handler, logging.handlers.SysLogHandler):
+                handler.setLevel(level if isinstance(level, int) else _log_level_number.get(str(level).upper(), DEFAULT_LEVEL))
+                self.info('File log level updated to %s', level)
+
+    def _logfile_cleanup_thread(self):
+        """ Thread function to clean up old log files based on retention settings. """
+        while True:
+            try:
+                for handler in self.handlers:
+                    if isinstance(handler, logging.FileHandler):
+                        log_file = handler.baseFilename
+                        # manage retention
+                        if hasattr(self, 'log_file_retention_days') and self.log_file_retention_days > 0:
+                            # replace variables with a *
+                            log_file_search_name = log_file
+                            if hasattr(self, 'log_file_vars') and self.log_file_vars is not None:
+                                for var in self.log_file_vars:
+                                    log_file_search_name.replace(var['var'], '*')
+                            old_log_files = glob(log_file_search_name)
+                            for old_log_file in old_log_files:
+                                # check the age and delete if needed
+                                fname = pathlib.Path(old_log_file)
+                                mtime = datetime.fromtimestamp(fname.stat().st_mtime)
+                                if mtime < datetime.now() - timedelta(days=self.log_file_retention_days):
+                                    self.info('Deleting old log file %s.  Modified time %s, retention set to %i days.', old_log_file, mtime, self.log_file_retention_days)
+                                    os.remove(old_log_file)
+            except Exception as e: # pylint: disable=broad-except
+                self.error('Error in log file cleanup thread, %s: %s', e.__class__.__name__, str(e))
+            finally:
+                sleep(300)  # Sleep for 5 minutes before checking again

{logging_handler-1.0.7 → logging_handler-1.0.8}/src/logging_handler.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
-Name: logging-handler
-Version: 1.0.7
+Metadata-Version: 2.4
+Name: logging_handler
+Version: 1.0.8
 Summary: Python Library to quickly create logging handlers
 Author-email: Thomas Dunteman <git@learningtopi.com>
 Project-URL: Homepage, https://www.learningtopi.com/python-modules-applications/python_logging_handler/
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: license-file
 
 # Python Logging Helper
 Python library to quickly create logging handlers.  Supports logging to the console as well as to file using a syslog style output format.
@@ -65,8 +66,16 @@ In the examples above, you can create multiple loggers with different names.  If
 
 ## Release Notes
 
-v1.0.2  
-        - Moved console level to the 1st parameter.  Make it quicker and easier to create a console logger
-        - Chaned default console level to INFO from WARNING.  This is what I typically end up using anyway
-        - Updated the home page to our new logging_handler page:  https://www.learningtopi.com/python-modules-applications/python_logging_handler/
-        - Allow passing static values DEBUG, INFO, WARNING, ERROR and CRITICAL from the logging module (or you may import from this library)
+Release notes can now be found in the release notes folder.
+
+## Changing Logging Level
+
+As of v1.0.8, two functions, "update_console_level" and "update_file_level" have been added.  To change the logging level on the fly:
+
+    >>> from logging_helper import create_logger, update_console_level
+    >>> logger = create_logger(console=True)
+    >>> update_console_level(logger, 'info')
+
+## CustomLogger class
+
+As of v1.0.8, a CustomLogger class was added.  This performs the same function as using create_logger, however rather than requiring a separate function to update logging levels, the class includes a "console_level" and "file_level" function that can be used.  The class also utilizes threading to enable old logfile cleanup.

logging_handler-1.0.7/src/logging_handler/__init__.py

@@ -1,110 +0,0 @@
-'''
-MIT License
-
-Copyright (c) 2022 LearningToPi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-'''
-import logging
-import logging.handlers
-from glob import glob
-from datetime import datetime, timedelta
-import pathlib
-import os
-
-__VERSION__ = (1, 0, 7)
-
-DEFAULT_LEVEL = logging.WARNING
-
-DEBUG = 'DEBUG'
-INFO = 'INFO'
-WARNING = 'WARNING'
-ERROR = 'ERROR'
-CRITICAL = 'CRITICAL'
-
-_log_level_number = {
-    'DEBUG': logging.DEBUG,
-    "INFO": logging.INFO,
-    "WARNING": logging.WARNING,
-    "ERROR": logging.ERROR,
-    "CRITICAL": logging.CRITICAL
-}
-
-
-def create_logger(console_level=WARNING, log_file='', file_level=WARNING, name='', file_mode='a', console=True,
-                  syslog=False, syslog_script_name='', log_file_vars=None, log_file_retention_days=0, propagate=False):
-    """ Creates a logger and returns the handle.
-        Log file vars should be sent as a list of dict -> [{"var": "{date}", "set": "%Y-%m-%d-%Y-%M"}]
-
-        Supported log file vars:
-            {date} - will be replaced with the current date using the provided strftime format
-    
-     """
-    logger = logging.getLogger(name)
-    logger.handlers.clear() # Clear all existing handlers before creating new ones!
-    logger.setLevel(logging.DEBUG)
-    logger.propagate = propagate
-    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-
-    # Console
-    if console:
-        console_handler = logging.StreamHandler()
-        console_handler.setLevel(console_level if isinstance(console_level, int) else _log_level_number.get(str(console_level).upper(), DEFAULT_LEVEL))
-        console_handler.setFormatter(formatter)
-        logger.addHandler(console_handler)
-
-    # syslog
-    if syslog:
-        syslog_formatter = logging.Formatter(syslog_script_name + '[%(process)d]: %(levelname)s: %(message)s')
-        syslog_handler = logging.handlers.SysLogHandler(address='/dev/log')
-        syslog_handler.setLevel(file_level if isinstance(file_level, int) else _log_level_number.get(str(file_level).upper(), DEFAULT_LEVEL))
-        syslog_handler.setFormatter(syslog_formatter)
-        logger.addHandler(syslog_handler)
-
-    # file
-    if log_file != '':
-        # replace variables in the log file name
-        if log_file_vars is not None:
-            for var in log_file_vars:
-                if isinstance(var, dict) and 'var' in var and 'set' in var and var['var'] == "{date}":
-                    log_file = log_file.replace(var['var'], datetime.now().strftime(var['set']))
-        file_handler = logging.FileHandler(log_file, mode=file_mode, encoding='utf-8', delay=False)
-        file_handler.setLevel(file_level if isinstance(file_level, int) else _log_level_number.get(str(file_level).upper(), DEFAULT_LEVEL))
-        file_handler.setFormatter(formatter)
-        logger.addHandler(file_handler)
-
-        # manage retention
-        if log_file_retention_days > 0:
-            # replace variables with a *
-            log_file_search_name = log_file
-            if log_file_vars is not None:
-                for var in log_file_vars:
-                    log_file_search_name.replace(var['var'], '*')
-            old_log_files = glob(log_file_search_name)
-            for old_log_file in old_log_files:
-                # check the age and delete if needed
-                fname = pathlib.Path(old_log_file)
-                mtime = datetime.fromtimestamp(fname.stat().st_mtime)
-                if mtime < datetime.now() - timedelta(days=log_file_retention_days):
-                    logger.info('Deleting old log file %s.  Modified time %s, retention set to %i days.', old_log_file, mtime, log_file_retention_days)
-                    os.remove(old_log_file)
-
-    # return the logger
-    return logger