Started using flake8 to lint; removed some of its warnings.
[python_utils.git] / logging_utils.py
index 2d9d63b78f8543890bb25fa879667bcc59294af1..0c4694e1056790af1db9dc53a5966a5392310110 100644 (file)
@@ -396,6 +396,72 @@ class MillisecondAwareFormatter(logging.Formatter):
         return s
 
 
+def log_about_logging(
+    logger, default_logging_level, preexisting_handlers_count, fmt, facility_name
+):
+    level_name = logging._levelToName.get(
+        default_logging_level, str(default_logging_level)
+    )
+    logger.debug(f'Initialized global logging; default logging level is {level_name}.')
+    if (
+        config.config['logging_clear_preexisting_handlers']
+        and preexisting_handlers_count > 0
+    ):
+        msg = f'Logging cleared {preexisting_handlers_count} global handlers (--logging_clear_preexisting_handlers)'
+        logger.warning(msg)
+    logger.debug(f'Logging format specification is "{fmt}"')
+    if config.config['logging_debug_threads']:
+        logger.debug(
+            '...Logging format spec captures tid/pid (--logging_debug_threads)'
+        )
+    if config.config['logging_debug_modules']:
+        logger.debug(
+            '...Logging format spec captures files/functions/lineno (--logging_debug_modules)'
+        )
+    if config.config['logging_syslog']:
+        logger.debug(
+            f'Logging to syslog as {facility_name} with priority mapping based on level'
+        )
+    if config.config['logging_filename']:
+        logger.debug(f'Logging to filename {config.config["logging_filename"]}')
+        logger.debug(
+            f'...with {config.config["logging_filename_maxsize"]} bytes max file size.'
+        )
+        logger.debug(
+            f'...and {config.config["logging_filename_count"]} rotating backup file count.'
+        )
+    if config.config['logging_console']:
+        logger.debug('Logging to the console (stderr).')
+    if config.config['logging_info_is_print']:
+        logger.debug(
+            'Logging logger.info messages will be repeated on stdout (--logging_info_is_print)'
+        )
+    if config.config['logging_squelch_repeats']:
+        logger.debug(
+            'Logging code allowed to request repeated messages be squelched (--logging_squelch_repeats)'
+        )
+    else:
+        logger.debug(
+            'Logging code forbidden to request messages be squelched; all messages logged (--no_logging_squelch_repeats)'
+        )
+    if config.config['logging_probabilistically']:
+        logger.debug(
+            'Logging code is allowed to request probabilistic logging (--logging_probabilistically)'
+        )
+    else:
+        logger.debug(
+            'Logging code is forbidden to request probabilistic logging; messages always logged (--no_logging_probabilistically)'
+        )
+    if config.config['lmodule']:
+        logger.debug(
+            f'Logging dynamic per-module logging enabled (--lmodule={config.config["lmodule"]})'
+        )
+    if config.config['logging_captures_prints']:
+        logger.debug(
+            'Logging will capture printed data as logger.info messages (--logging_captures_prints)'
+        )
+
+
 def initialize_logging(logger=None) -> logging.Logger:
     global logging_initialized
     if logging_initialized:
@@ -437,6 +503,7 @@ def initialize_logging(logger=None) -> logging.Logger:
     if config.config['logging_debug_modules']:
         fmt = f'%(filename)s:%(funcName)s:%(lineno)s|{fmt}'
 
+    facility_name = None
     if config.config['logging_syslog']:
         if sys.platform not in ('win32', 'cygwin'):
             if config.config['logging_syslog_facility']:
@@ -505,9 +572,8 @@ def initialize_logging(logger=None) -> logging.Logger:
     logger.propagate = False
 
     if config.config['logging_captures_prints']:
-        import builtins
-
         global built_in_print
+        import builtins
 
         def print_and_also_log(*arg, **kwarg):
             f = kwarg.get('file', None)
@@ -521,68 +587,13 @@ def initialize_logging(logger=None) -> logging.Logger:
 
     # At this point the logger is ready, handlers are set up,
     # etc... so log about the logging configuration.
-
-    level_name = logging._levelToName.get(
-        default_logging_level, str(default_logging_level)
+    log_about_logging(
+        logger,
+        default_logging_level,
+        preexisting_handlers_count,
+        fmt,
+        facility_name,
     )
-    logger.debug(f'Initialized global logging; default logging level is {level_name}.')
-    if (
-        config.config['logging_clear_preexisting_handlers']
-        and preexisting_handlers_count > 0
-    ):
-        msg = f'Logging cleared {preexisting_handlers_count} global handlers (--logging_clear_preexisting_handlers)'
-        logger.warning(msg)
-    logger.debug(f'Logging format specification is "{fmt}"')
-    if config.config['logging_debug_threads']:
-        logger.debug(
-            '...Logging format spec captures tid/pid (--logging_debug_threads)'
-        )
-    if config.config['logging_debug_modules']:
-        logger.debug(
-            '...Logging format spec captures files/functions/lineno (--logging_debug_modules)'
-        )
-    if config.config['logging_syslog']:
-        logger.debug(
-            f'Logging to syslog as {facility_name} with priority mapping based on level'
-        )
-    if config.config['logging_filename']:
-        logger.debug(f'Logging to filename {config.config["logging_filename"]}')
-        logger.debug(
-            f'...with {config.config["logging_filename_maxsize"]} bytes max file size.'
-        )
-        logger.debug(
-            f'...and {config.config["logging_filename_count"]} rotating backup file count.'
-        )
-    if config.config['logging_console']:
-        logger.debug('Logging to the console (stderr).')
-    if config.config['logging_info_is_print']:
-        logger.debug(
-            'Logging logger.info messages will be repeated on stdout (--logging_info_is_print)'
-        )
-    if config.config['logging_squelch_repeats']:
-        logger.debug(
-            'Logging code allowed to request repeated messages be squelched (--logging_squelch_repeats)'
-        )
-    else:
-        logger.debug(
-            'Logging code forbidden to request messages be squelched; all messages logged (--no_logging_squelch_repeats)'
-        )
-    if config.config['logging_probabilistically']:
-        logger.debug(
-            'Logging code is allowed to request probabilistic logging (--logging_probabilistically)'
-        )
-    else:
-        logger.debug(
-            'Logging code is forbidden to request probabilistic logging; messages always logged (--no_logging_probabilistically)'
-        )
-    if config.config['lmodule']:
-        logger.debug(
-            f'Logging dynamic per-module logging enabled (--lmodule={config.config["lmodule"]})'
-        )
-    if config.config['logging_captures_prints']:
-        logger.debug(
-            'Logging will capture printed data as logger.info messages (--logging_captures_prints)'
-        )
     return logger
 
 
@@ -628,18 +639,20 @@ class OutputMultiplexer(object):
         """Bits in the destination_bitv bitvector.  Used to indicate the
         output destination."""
 
-        LOG_DEBUG = 0x01  #  ⎫
-        LOG_INFO = 0x02  #  ⎪
-        LOG_WARNING = 0x04  #  ⎬ Must provide logger to the c'tor.
-        LOG_ERROR = 0x08  #  ⎪
+        # fmt: off
+        LOG_DEBUG = 0x01     #  ⎫
+        LOG_INFO = 0x02      #  ⎪
+        LOG_WARNING = 0x04   #  ⎬ Must provide logger to the c'tor.
+        LOG_ERROR = 0x08     #  ⎪
         LOG_CRITICAL = 0x10  #  ⎭
-        FILENAMES = 0x20  # Must provide a filename to the c'tor.
-        FILEHANDLES = 0x40  # Must provide a handle to the c'tor.
+        FILENAMES = 0x20     # Must provide a filename to the c'tor.
+        FILEHANDLES = 0x40   # Must provide a handle to the c'tor.
         HLOG = 0x80
         ALL_LOG_DESTINATIONS = (
             LOG_DEBUG | LOG_INFO | LOG_WARNING | LOG_ERROR | LOG_CRITICAL
         )
         ALL_OUTPUT_DESTINATIONS = 0x8F
+        # fmt: on
 
     def __init__(
         self,