1 #-*-coding:iso-8859-1-*-
3 # Copyright (C) 2008-2012 EDF R&D
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.
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.
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
19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
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.
27 Il doit être appelé en premier dans AssimilationStudy (mais pas directement
28 dans les applications utilisateurs), en l'important et en instanciant un
30 import Logging ; Logging.Logging()
32 Par défaut, seuls les messages du niveau WARNING ou au-delà sont disponibles
33 (donc les simples messages d'info ne sont pas disponibles), ce que l'on peut
34 changer à l'instanciation avec le mot-clé "level" :
35 import Logging ; Logging.Logging(level=20)
37 On peut éventuellement demander à l'objet de sortir aussi les messages dans
38 un fichier (noms par défaut : AssimilationStudy.log, niveau NOTSET) :
39 import Logging ; Logging.Logging().setLogfile()
41 Si on veut changer le nom du fichier ou le niveau global de message, il faut
42 récupérer l'instance et appliquer les méthodes :
44 log = Logging.Logging()
46 log.setLevel(logging.DEBUG)
47 log.setLogfile(filename="toto.log", filemode="a", level=logging.WARNING)
48 et on change éventuellement le niveau avec :
49 log.setLogfileLevel(logging.INFO)
51 Ensuite, n'importe où dans les applications, il suffit d'utiliser le module
52 "logging" (avec un petit "l") :
54 log = logging.getLogger(NAME) # Avec rien (recommandé) ou un nom NAME
60 ou encore plus simplement :
64 Dans une application, à n'importe quel endroit et autant de fois qu'on veut,
65 on peut changer le niveau global de message en utilisant par exemple :
67 log = logging.getLogger(NAME) # Avec rien (recommandé) ou un nom NAME
68 log.setLevel(logging.DEBUG)
70 On rappelle les niveaux (attributs de "logging") et leur ordre :
71 NOTSET=0 < DEBUG=10 < INFO=20 < WARNING=30 < ERROR=40 < CRITICAL=50
73 __author__ = "Jean-Philippe ARGAUD"
78 from PlatformInfo import PlatformInfo
80 LOGFILE = os.path.join(os.path.abspath(os.curdir),"AssimilationStudy.log")
82 # ==============================================================================
84 def __init__(self, level=logging.WARNING):
86 Initialise un logging à la console pour TOUS les niveaux de messages.
89 format = '%(levelname)-8s %(message)s',
95 # Initialise l'affichage de logging
96 # ---------------------------------
99 logging.info( "--------------------------------------------------" )
100 logging.info( "Lancement de "+p.getName()+" "+p.getVersion() )
101 logging.info( "--------------------------------------------------" )
102 logging.info( "Versions logicielles :" )
103 logging.info( "- Python "+p.getPythonVersion() )
104 logging.info( "- Numpy "+p.getNumpyVersion() )
105 logging.info( "- Scipy "+p.getScipyVersion() )
108 # def setLogfileLevel(self, level=logging.NOTSET ):
110 # Permet de changer globalement le niveau des messages disponibles.
112 # logging.getLogger().setLevel(level)
114 def setLogfile(self, filename=LOGFILE, filemode="w", level=logging.NOTSET):
116 Permet de disposer des messages dans un fichier EN PLUS de la console.
118 if self.__logfile is not None:
119 # Supprime le précédent mode de stockage fichier s'il exsitait
120 logging.getLogger().removeHandler(self.__logfile)
121 self.__logfile = logging.FileHandler(filename, filemode)
122 self.__logfile.setLevel(level)
123 self.__logfile.setFormatter(
124 logging.Formatter('%(asctime)s %(levelname)-8s %(message)s',
125 '%d %b %Y %H:%M:%S'))
126 logging.getLogger().addHandler(self.__logfile)
128 def setLogfileLevel(self, level=logging.NOTSET ):
130 Permet de changer le niveau des messages stockés en fichier. Il ne sera
131 pris en compte que s'il est supérieur au niveau global.
133 self.__logfile.setLevel(level)
137 Renvoie le niveau de Logging sous forme texte
139 return logging.getLevelName( logging.getLogger().getEffectiveLevel() )
141 # ==============================================================================
142 if __name__ == "__main__":
143 print '\n AUTODIAGNOSTIC \n'
146 l = Logging(level = logging.NOTSET)
148 logging.info("Message numéro 1 uniquement disponible sur console")
150 l.setLogfile(level = logging.WARNING)
151 if not os.path.isfile(LOGFILE):
152 raise ValueError("Le fichier de log \"%s\" n'a pas pu être créé."%LOGFILE)
154 logging.info("Message numéro 2 uniquement disponible sur console")
155 logging.warning("Message numéro 3 conjointement disponible sur console et fichier")
157 l.setLogfileLevel(logging.INFO)
159 logging.info("Message numéro 4 conjointement disponible sur console et fichier")
162 print " Le logging a été correctement initialisé. Le fichier suivant"
163 print " %s"%os.path.basename(LOGFILE)
164 print " a été correctement créé, et peut être effacé après vérification."