src/daComposant/daCore/ExtendedLogging.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2023 EDF R&D
   4 #
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  22
  23 """
  24     Ce module permet de mettre en place un logging utilisable partout dans
  25     l'application, par défaut à la console, et si nécessaire dans un fichier.
  26
  27     Il doit être appelé en premier dans Aidsm (mais pas directement dans les
  28     applications utilisateurs), en l'important et en instanciant un objet :
  29         import ExtendedLogging ; ExtendedLogging.ExtendedLogging()
  30
  31     Par défaut, seuls les messages du niveau WARNING ou au-delà sont disponibles
  32     (donc les simples messages d'info ne sont pas disponibles), ce que l'on peut
  33     changer à l'instanciation avec le mot-clé "level" :
  34         import ExtendedLogging ; ExtendedLogging.ExtendedLogging(level=20)
  35
  36     On peut éventuellement demander à l'objet de sortir aussi les messages dans
  37     un fichier (noms par défaut : AdaoOutputLogfile.log, niveau NOTSET) :
  38         import ExtendedLogging ; ExtendedLogging.ExtendedLogging().setLogfile()
  39
  40     Si on veut changer le nom du fichier ou le niveau global de message, il faut
  41     récupérer l'instance et appliquer les méthodes :
  42         import ExtendedLogging
  43         log = ExtendedLogging.ExtendedLogging()
  44         import logging
  45         log.setLevel(logging.DEBUG)
  46         log.setLogfile(filename="toto.log", filemode="a", level=logging.WARNING)
  47     et on change éventuellement le niveau avec :
  48         log.setLogfileLevel(logging.INFO)
  49
  50     Ensuite, n'importe où dans les applications, il suffit d'utiliser le module
  51     "logging" (avec un petit "l") :
  52         import logging
  53         log = logging.getLogger(NAME) # Avec rien (recommandé) ou un nom NAME
  54         log.critical("...")
  55         log.error("...")
  56         log.warning("...")
  57         log.info("...")
  58         log.debug("...")
  59     ou encore plus simplement :
  60         import logging
  61         logging.info("...")
  62
  63     Dans une application, à n'importe quel endroit et autant de fois qu'on veut,
  64     on peut changer le niveau global de message en utilisant par exemple :
  65         import logging
  66         log = logging.getLogger(NAME) # Avec rien (recommandé) ou un nom NAME
  67         log.setLevel(logging.DEBUG)
  68
  69     On rappelle les niveaux (attributs de "logging") et leur ordre :
  70         NOTSET=0 < DEBUG=10 < INFO=20 < WARNING=30 < ERROR=40 < CRITICAL=50
  71 """
  72 __author__ = "Jean-Philippe ARGAUD"
  73 __all__ = []
  74
  75 import os
  76 import sys
  77 import logging
  78 import functools
  79 import time
  80 from daCore import PlatformInfo
  81
  82 LOGFILE = os.path.join(os.path.abspath(os.curdir),"AdaoOutputLogfile.log")
  83
  84 # ==============================================================================
  85 class ExtendedLogging(object):
  86     """
  87     Logger général pour disposer conjointement de la sortie standard et de la
  88     sortie sur fichier
  89     """
  90     __slots__ = ("__logfile")
  91     #
  92     def __init__(self, level=logging.WARNING):
  93         """
  94         Initialise un logging à la console pour TOUS les niveaux de messages.
  95         """
  96         logging.basicConfig(
  97             format = '%(levelname)-8s %(message)s',
  98             level  = level,
  99             stream = sys.stdout,
 100             )
 101         self.__logfile = None
 102         #
 103         # Initialise l'affichage de logging
 104         # ---------------------------------
 105         p = PlatformInfo.PlatformInfo()
 106         #
 107         logging.info( "--------------------------------------------------" )
 108         logging.info( p.getName()+" version "+p.getVersion() )
 109         logging.info( "--------------------------------------------------" )
 110         logging.info( "Library availability:" )
 111         logging.info( "- Python.......: True" )
 112         logging.info( "- Numpy........: "+str(PlatformInfo.has_numpy) )
 113         logging.info( "- Scipy........: "+str(PlatformInfo.has_scipy) )
 114         logging.info( "- Matplotlib...: "+str(PlatformInfo.has_matplotlib) )
 115         logging.info( "- Gnuplot......: "+str(PlatformInfo.has_gnuplot) )
 116         logging.info( "- Sphinx.......: "+str(PlatformInfo.has_sphinx) )
 117         logging.info( "- Nlopt........: "+str(PlatformInfo.has_nlopt) )
 118         logging.info( "Library versions:" )
 119         logging.info( "- Python.......: "+p.getPythonVersion() )
 120         logging.info( "- Numpy........: "+p.getNumpyVersion() )
 121         logging.info( "- Scipy........: "+p.getScipyVersion() )
 122         logging.info( "- Matplotlib...: "+p.getMatplotlibVersion() )
 123         logging.info( "- Gnuplot......: "+p.getGnuplotVersion() )
 124         logging.info( "- Sphinx.......: "+p.getSphinxVersion() )
 125         logging.info( "- Nlopt........: "+p.getNloptVersion() )
 126         logging.info( "" )
 127
 128     def setLogfile(self, filename=LOGFILE, filemode="w", level=logging.NOTSET):
 129         """
 130         Permet de disposer des messages dans un fichier EN PLUS de la console.
 131         """
 132         if self.__logfile is not None:
 133             # Supprime le précédent mode de stockage fichier s'il exsitait
 134             logging.getLogger().removeHandler(self.__logfile)
 135         self.__logfile = logging.FileHandler(filename, filemode)
 136         self.__logfile.setLevel(level)
 137         self.__logfile.setFormatter(
 138             logging.Formatter('%(asctime)s %(levelname)-8s %(message)s',
 139                               '%d %b %Y %H:%M:%S'))
 140         logging.getLogger().addHandler(self.__logfile)
 141
 142     def setLogfileLevel(self, level=logging.NOTSET ):
 143         """
 144         Permet de changer le niveau des messages stockés en fichier. Il ne sera
 145         pris en compte que s'il est supérieur au niveau global.
 146         """
 147         self.__logfile.setLevel(level)
 148
 149     def getLevel(self):
 150         """
 151         Renvoie le niveau de logging sous forme texte
 152         """
 153         return logging.getLevelName( logging.getLogger().getEffectiveLevel() )
 154
 155 # ==============================================================================
 156 def logtimer(f):
 157     @functools.wraps(f)
 158     def wrapper(*args, **kwargs):
 159         start  = time.clock() # time.time()
 160         result = f(*args, **kwargs)
 161         end    = time.clock() # time.time()
 162         msg    = 'TIMER Durée elapsed de la fonction utilisateur "{}": {:.3f}s'
 163         logging.debug(msg.format(f.__name__, end-start))
 164         return result
 165     return wrapper
 166
 167 # ==============================================================================
 168 if __name__ == "__main__":
 169     print('\n AUTODIAGNOSTIC\n')