v1.0.7 global vars now strings

Author: LearningToPi

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "logging_handler"
-version = "1.0.6"
+version = "1.0.7"
 description = "Python Library to quickly create logging handlers"
 authors = [{name = "Thomas Dunteman", email= "[email protected]"}]
 keywords = ["logging", "syslog"]

release_notes/1.0.1.md

@@ -0,0 +1 @@
+Initial release! See the README.md for usage inforamtion. This package is also available on PyPi (logging_handler).

release_notes/1.0.2.md

@@ -0,0 +1,4 @@
+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/1.0.3.md

@@ -0,0 +1 @@
+Fixed logging when using a constant imported from the logging library. i.e.: create_logger(DEBUG)

release_notes/1.0.7.md

@@ -0,0 +1,13 @@
+## What's New
+
+- Changed log_file_vars parameter default to None
+- Cleaned up unused imports
+
+## Fixed Issues
+
+- Switched global variables for DEBUG, INFO, WARNING, ERROR, 
+- CRITICAL to be strings rather than integers inherited from logger.  Fix was made to resolve IDE type errors.
+
+## Known Issues
+
+N/A

src/logging_handler/__init__.py

@@ -28,31 +28,30 @@
 from datetime import datetime, timedelta
 import pathlib
 import os
-from functools import singledispatch
-
-__VERSION__ = (1, 0, 2)
-
-DEBUG = logging.DEBUG
-INFO = logging.INFO
-WARNING = logging.WARNING
-ERROR = logging.ERROR
-CRITICAL = logging.CRITICAL
-
-_log_level_name = {
-    'DEBUG': DEBUG,
-    "INFO": INFO,
-    "WARNING": WARNING,
-    "ERROR": ERROR,
-    "CRITICAL": CRITICAL
-}
 
-_supported_log_levels = [DEBUG, INFO, WARNING, ERROR, CRITICAL]
+__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=[], log_file_retention_days=0, propagate=False):
+                  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 dict -> {"var": "{date}", "set": "%Y-%m-%d-%Y-%M"}
+        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
@@ -67,35 +66,37 @@ def create_logger(console_level=WARNING, log_file='', file_level=WARNING, name='
     # Console
     if console:
         console_handler = logging.StreamHandler()
-        console_handler.setLevel(_log_level_name.get(console_level.upper(), logging.INFO) if not isinstance(console_level, int) else console_level)
+        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(_log_level_name.get(file_level.upper(), logging.WARNING) if not isinstance(file_level, int) else file_level)
+        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
-        for var in log_file_vars:
-            if type(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']))
+        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(_log_level_name.get(file_level.upper(), logging.WARNING) if not isinstance(file_level, int) else file_level)
+        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
-            for var in log_file_vars:
-                log_file_search_name.replace(var['var'], '*')
+            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
@@ -106,4 +107,4 @@ def create_logger(console_level=WARNING, log_file='', file_level=WARNING, name='
                     os.remove(old_log_file)
 
     # return the logger
-    return logger
+    return logger