sima/lib/logger.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2009, 2010, 2013, 2014, 2015 Jack Kaliko <kaliko@azylum.org>
   3 #
   4 #  This file is part of sima
   5 #
   6 #  sima is free software: you can redistribute it and/or modify
   7 #  it under the terms of the GNU General Public License as published by
   8 #  the Free Software Foundation, either version 3 of the License, or
   9 #  (at your option) any later version.
  10 #
  11 #  sima is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #  GNU General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU General Public License
  17 #  along with sima.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19 #
  20
  21 """
  22 Logging facility for sima.
  23 """
  24
  25 # standard library import
  26 import logging
  27 import sys
  28
  29 from os import environ
  30
  31 DEBUG = logging.DEBUG
  32 INFO = logging.INFO
  33 ERROR = logging.ERROR
  34 LOG_FORMATS = {
  35         DEBUG: '[{process}]{filename: >11}:{lineno: <3} {levelname: <7}: {message}',
  36         INFO:  '{levelname: <7}: {message}',
  37         #logging.DEBUG: '{asctime} {filename}:{lineno}({funcName}) '
  38                                  #'{levelname}: {message}',
  39         }
  40 DATE_FMT = "%Y-%m-%d %H:%M:%S"
  41
  42 TRACE_LEVEL_NUM = 5
  43 logging.addLevelName(TRACE_LEVEL_NUM, 'TRACE')
  44 def trace(self, message, *args, **kwargs):
  45     # Yes, logger takes its '*args' as 'args'.
  46     if self.isEnabledFor(TRACE_LEVEL_NUM):
  47         self._log(TRACE_LEVEL_NUM, message, args, **kwargs)
  48
  49 logging.Logger.trace = trace
  50
  51
  52 def set_logger(level='info', logfile=None):
  53     """
  54     logger:
  55         level: in debug, info, warning,…
  56         logfile: file to log to
  57
  58     """
  59     name = 'sima'
  60     if environ.get('TRACE', False):
  61         user_log_level = TRACE_LEVEL_NUM
  62     else:
  63         user_log_level = getattr(logging, level.upper())
  64     if user_log_level > DEBUG:
  65         log_format = LOG_FORMATS.get(INFO)
  66     else:
  67         log_format = LOG_FORMATS.get(DEBUG)
  68     logger = logging.getLogger(name)
  69     formatter = logging.Formatter(log_format, DATE_FMT, '{')
  70     logger.setLevel(user_log_level)
  71     filehdl = False
  72     if logger.handlers:
  73         for hdl in logger.handlers:
  74             hdl.setFormatter(formatter)
  75             if isinstance(hdl, logging.FileHandler):
  76                 filehdl = True
  77             else:
  78                 logger.removeHandler(hdl)
  79
  80     if logfile:
  81         if filehdl:
  82             logger.handlers = []
  83         # Add timestamp for file handler
  84         log_format = '{0} {1}'.format('{asctime}', log_format)
  85         formatter = logging.Formatter(log_format, DATE_FMT, '{')
  86         # create file handler
  87         fileh = logging.FileHandler(logfile)
  88         fileh.setFormatter(formatter)
  89         logger.addHandler(fileh)
  90     else:
  91         if filehdl:
  92             logger.info('Not changing logging handlers, only updating formatter')
  93             return
  94         # create console handler with a specified log level (STDOUT)
  95         couth = logging.StreamHandler(sys.stdout)
  96         couth.addFilter(lambda record: record.levelno < ERROR)
  97
  98         # create console handler with warning log level (STDERR)
  99         cerrh = logging.StreamHandler(sys.stderr)
 100         cerrh.setLevel(ERROR)
 101
 102         # add formatter to the handlers
 103         cerrh.setFormatter(formatter)
 104         couth.setFormatter(formatter)
 105
 106         # add the handlers to SIMA_LOGGER
 107         logger.addHandler(couth)
 108         logger.addHandler(cerrh)  # Already added creating the handler‽ Still have to figure it out.
 109
 110 # VIM MODLINE
 111 # vim: ai ts=4 sw=4 sts=4 expandtab