-
Notifications
You must be signed in to change notification settings - Fork 25
/
Journal.py
673 lines (555 loc) · 27.4 KB
/
Journal.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
#!/usr/bin/python
# -*- coding: iso-8859-1 -*-
"""
Journal - ExeFilter
Module qui prend en charge la journalisation et l'affichage des événements.
Les fonctions du module permettent de journaliser les évènements à l'écran sur
la console, dans un fichier texte et/ou un serveur syslog via UDP.
Ce fichier fait partie du projet ExeFilter.
URL du projet: U{http://www.decalage.info/exefilter}
@organization: DGA/CELAR
@author: U{Philippe Lagadec<mailto:philippe.lagadec(a)laposte.net>}
@author: U{Arnaud Kerréneur<mailto:arnaud.kerreneur(a)dga.defense.gouv.fr>}
@author: U{Tanguy Vinceleux<mailto:tanguy.vinceleux(a)dga.defense.gouv.fr>}
@contact: U{Philippe Lagadec<mailto:philippe.lagadec(a)laposte.net>}
@copyright: DGA/CELAR 2004-2008
@copyright: NATO/NC3A 2008-2010 (modifications PL apres ExeFilter v1.1.0)
@license: CeCILL (open-source compatible GPL)
cf. code source ou fichier LICENCE.txt joint
see LICENCE.txt
@version: 1.04
@status: beta
"""
#==============================================================================
__docformat__ = 'epytext en'
#__author__ = "Philippe Lagadec, Tanguy Vinceleux, Arnaud Kerréneur (DGA/CELAR)"
__date__ = "2010-12-03"
__version__ = "1.05"
#------------------------------------------------------------------------------
# LICENCE pour le projet ExeFilter:
# Copyright DGA/CELAR 2004-2008
# Copyright NATO/NC3A 2008-2010 (modifications PL apres ExeFilter v1.1.0)
# Auteurs:
# - Philippe Lagadec (PL) - philippe.lagadec(a)laposte.net
# - Arnaud Kerréneur (AK) - arnaud.kerreneur(a)dga.defense.gouv.fr
# - Tanguy Vinceleux (TV) - tanguy.vinceleux(a)dga.defense.gouv.fr
#
# Ce logiciel est régi par la licence CeCILL soumise au droit français et
# respectant les principes de diffusion des logiciels libres. Vous pouvez
# utiliser, modifier et/ou redistribuer ce programme sous les conditions
# de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA
# sur le site "http://www.cecill.info". Une copie de cette licence est jointe
# dans les fichiers Licence_CeCILL_V2-fr.html et Licence_CeCILL_V2-en.html.
#
# En contrepartie de l'accessibilité au code source et des droits de copie,
# de modification et de redistribution accordés par cette licence, il n'est
# offert aux utilisateurs qu'une garantie limitée. Pour les mêmes raisons,
# seule une responsabilité restreinte pèse sur l'auteur du programme, le
# titulaire des droits patrimoniaux et les concédants successifs.
#
# A cet égard l'attention de l'utilisateur est attirée sur les risques
# associés au chargement, à l'utilisation, à la modification et/ou au
# développement et à la reproduction du logiciel par l'utilisateur étant
# donné sa spécificité de logiciel libre, qui peut le rendre complexe à
# manipuler et qui le réserve donc à des développeurs et des professionnels
# avertis possédant des connaissances informatiques approfondies. Les
# utilisateurs sont donc invités à charger et tester l'adéquation du
# logiciel à leurs besoins dans des conditions permettant d'assurer la
# sécurité de leurs systèmes et ou de leurs données et, plus généralement,
# à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.
#
# Le fait que vous puissiez accéder à cet en-tête signifie que vous avez
# pris connaissance de la licence CeCILL, et que vous en avez accepté les
# termes.
#------------------------------------------------------------------------------
# HISTORIQUE:
# 19/01/2005 v0.01 AK: - 1ère version
# 2005-2007 PL,AK: - nombreuses évolutions + contributions de Y. Bidan
# et C. Catherin
# 12/01/2007 v1.00 PL: - version 1.00 officielle
# 2007-09-20 v1.01 PL: - licence CeCILL
# 2010-02-07 v1.02 PL: - removed path module import
# 2010-02-23 v1.03 PL: - updated plx import
# 2010-11-26 v1.04 PL: - code cleanup, use ExtendedLogger class
# 2010-12-03 v1.05 PL: - append to log files instead of overwriting
# - separate function init_console_logging
#------------------------------------------------------------------------------
# TODO:
# + split init_journal into several functions:
# - init_console to setup console logging at the root level only once
# - set_logfile(s) to setup logfile(s) for each session, at the logger level
# - set_syslog to setup syslog the same way
# + when used as a library, xf should only have a NullHandler
# + fix encoding issue on Windows console
# + option to use a rotating file handler to limit log file size
# ? each new call to init_journal should use a different name for the logger
# (to support multithreading)
# + do not use a global logger variable, but a per-session logger object
# + init_jounal: return an ExtendedLogger object
# + remove obsolete module-level functions, once other modules are fixed
# - corriger bug syslog: messages dupliqués au 2ème transfert d'affilée depuis
# l'IHM (puis retour à la normale au 3ème transfert)
# - corriger les docstrings pour éviter les warnings epydoc
# - issue when ExeFilter is embedded into another application that uses logging:
# it should be possible to create a logger object without handlers.
# (handlers should only be defined by the main app to avoid duplication)
# ? rename "INFO2" level to "DETAIL" or "TECH" to be clearer?
# EVOLUTIONS ENVISAGEES:
# - avec Python 2.4.2, Formatter_Latin1 n'est plus nécessaire, utiliser le
# nouveau paramètre encoding de FileHandler
#------------------------------------------------------------------------------
#=== IMPORTS ==================================================================
import logging, logging.handlers, os.path, sys
# modules du projet:
from commun import *
import commun
from thirdparty.plx.plx import *
#=== CONSTANTES ===============================================================
# OBSOLETE:
SYSLOG = 0
FICHIER = 1
SYS_FIC = 2
# niveaux de jouralisation ajoutés aux niveaux du module standard logging:
# (cf. notes de développements pour plus de détails)
##CRITICAL = 50 # Erreur fatale, le processus ne peut continuer
##ERROR = 40 # Erreur grave mais non fatale
IMPORTANT = 35 # Information importante à toujours journaliser, mais qui
# n'est pas un warning.
##WARNING = 30 # Avertissement, problème potentiel
##INFO = 20 # Information normale
INFO2 = 15 # Information technique
##DEBUG = 10 # Information de déboguage pour développeur
##NOTSET = 0
#=== VARIABLES GLOBALES =======================================================
# flag pour éviter de faire 2 init_journal()
init_effectue = False
# global logger object
logger = None
#=== CLASSES ==================================================================
#------------------------------------------------------------------------------
# classe Formatter_console
#--------------------------
class Formatter_console (logging.Formatter):
"""classe qui hérite de logging.Formatter et ajoute une conversion
grâce au codec adapté à l'OS pour un affichage correct sur la
console. (CMD sous Windows)
"""
def format(self, record):
# on appelle d'abord le format() d'origine pour obtenir la chaîne:
chaine = logging.Formatter.format(self, record)
# ensuite on convertit le résultat si besoin:
return str_console(chaine, errors='replace')
#------------------------------------------------------------------------------
# classe Formatter_Latin1
#-------------------------
class Formatter_Latin1 (logging.Formatter):
"""classe qui hérite de logging.Formatter et ajoute une conversion
grâce au codec latin_1 pour les messages Unicode.
(Sinon par défaut Python emploie UTF-8)
"""
def format(self, record):
# on appelle d'abord le format() d'origine pour obtenir la chaîne:
chaine = logging.Formatter.format(self, record)
# ensuite on convertit le résultat en str si c'est de l'Unicode:
return str_lat1(chaine, errors='replace')
class ExtendedLogger (logging.Logger):
"""
extended Logger class for ExeFilter, based on logging.Logger:
- with additional methods to support more logging levels
- with conversion from strings to Unicode if needed
"""
def debug(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau DEBUG, pour le journal de
débogage technique en mode DEBUG pour le développement uniquement.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# ci-dessous la virgule est indispensable sinon (unistr(chaine)) est une
# chaîne et non un tuple...
args = (unistr(msg),) + args
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
logging.Logger.debug(self, *args, **kwargs)
def info2(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau INFO2, pour le journal de
débogage technique.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (INFO2, unistr(msg)) + args
logging.Logger.log(self, *args, **kwargs)
def info(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau INFO, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: un fichier nettoyé ou accepté.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (unistr(msg),) + args
logging.Logger.info(self, *args, **kwargs)
def warning(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau WARNING, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: un fichier refusé.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (unistr(msg),) + args
logging.Logger.warning(self, *args, **kwargs)
def important(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau IMPORTANT (entre WARNING ET ERROR).
Exemple: le début et la fin d'un transfert.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (IMPORTANT, unistr(msg)) + args
logging.Logger.log(self, *args, **kwargs)
def error(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau ERROR, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: une erreur anormale, qui ne nécessite pas l'arrêt du processus.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (unistr(msg),) + args
logging.Logger.error(self, *args, **kwargs)
def exception(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau ERROR avec le texte complet de
l'exception en cours, qui sera affiché sur la console et enregistré dans
différents journaux. Cette fonction doit normalement être appelée dans un
bloc "except".
Exemple: une erreur anormale, qui ne nécessite pas l'arrêt du processus.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
"""
args = (unistr(msg),) + args
logging.Logger.exception(self, *args, **kwargs)
def critical(self, msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau CRITICAL, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: une erreur critique, qui nécessite l'arrêt du processus.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
args = (unistr(msg),) + args
logging.Logger.critical(self, *args, **kwargs)
#=== INITIALISATION ===========================================================
# set ExtendedLogger class as default instead of logging.Logger:
logging.setLoggerClass(ExtendedLogger)
# set global logger
logger = logging.getLogger('ExeFilter')
# two additional logging levels:
logging.addLevelName (INFO2, "INFO2")
logging.addLevelName (IMPORTANT, "IMPORTANT")
#=== FONCTIONS ================================================================
def init_console_logging():
"""
initialize a console handler for the root logger, so that messages are
displayed on the console.
Should only be called if the main application does not already setup logging
handlers.
Should be called early, before any call to logging.
"""
# get the root logger
rootLogger = logging.getLogger('')
# make sure the root logger accepts up to debug messages:
rootLogger.setLevel(logging.DEBUG)
# 1) on ajoute un affichage console de niveau INFO,
# qui n'affiche que les messages sans date/niveau:
log_console = logging.StreamHandler(sys.stdout)
log_console.setLevel(logging.INFO)
# si on est en mode debug, niveau=DEBUG:
if commun.mode_debug():
log_console.setLevel(logging.DEBUG)
log_console.setFormatter(Formatter_console('%(message)s'))
rootLogger.addHandler(log_console)
#------------------------------------------------------------------------------
# init_journal
#-------------------
def init_journal (politique, journal_secu=None, journal_debug=None):
"""
Initialise the logging system for a session. Handlers to use log files and
syslog are enabled for the logger object according to the policy.
- politique: policy object
- journal_secu: filename/path of the security log file (INFO level)
- journal_debug: filename/path of the debug log file (INFO2 level)
Note: the policy controls if log files are enabled or not
"""
## # on récupère le Logger racine du module logging:
## rootLogger = logging.getLogger('')
# make sure the logger object accepts up to debug messages:
logger.setLevel(logging.DEBUG)
# on supprime tout handler qui serait déjà configuré, pour éviter les
# problèmes éventuels (ça arrive):
for h in logger.handlers:
try:
h.flush()
except:
pass
h.close()
logger.removeHandler(h)
# 2) on ajoute une sortie vers un fichier de niveau INFO2,
# qui affiche les messages avec date/niveau:
if politique.parametres['journal_debug'].valeur:
# append to existing log file instead of replacing it ('w' mode):
log_fichier = logging.FileHandler(journal_debug) #, 'w')
log_fichier.setLevel(INFO2)
# si on est en mode debug, niveau=DEBUG:
if commun.mode_debug():
log_fichier.setLevel(logging.DEBUG)
log_fichier.setFormatter(Formatter_Latin1(
#fmt = '%(asctime)s %(name)-12s %(levelname)-9s %(message)s',
fmt = '%(asctime)s %(levelname)-9s %(message)s',
datefmt = '%d/%m/%y %H:%M'))
logger.addHandler(log_fichier)
# 3) on ajoute une sortie vers un fichier (journal de sécurité) de niveau INFO,
# qui affiche les messages avec date/niveau:
if politique.parametres['journal_securite'].valeur:
# append to existing log file instead of replacing it ('w' mode):
log_fichier2 = logging.FileHandler(journal_secu) #, 'w')
log_fichier2.setLevel(logging.INFO)
log_fichier2.setFormatter(Formatter_Latin1(
#fmt = '%(asctime)s %(name)-12s %(levelname)-9s %(message)s',
fmt = '%(asctime)s %(levelname)-9s %(message)s',
datefmt = '%d/%m/%y %H:%M'))
logger.addHandler(log_fichier2)
# 4) on ajoute une sortie vers un serveur syslog de niveau WARNING,
# qui affiche les messages avec date/niveau:
# On doit d'abord corriger le tableau de conversion des priorités logging/syslog
# (sinon levée d'exceptions pour les niveaux que nous avons ajoutés...)
# notre niveau INFO correspond au niveau NOTICE de syslog:
if politique.parametres['journal_syslog'].valeur:
logging.handlers.SysLogHandler.priority_names['info'] = logging.handlers.SysLogHandler.LOG_NOTICE
# notre niveau INFO2 correspond au niveau INFO de syslog:
logging.handlers.SysLogHandler.priority_names['info2'] = logging.handlers.SysLogHandler.LOG_INFO
# notre niveau IMPORTANT correspond au niveau WARNING de syslog:
logging.handlers.SysLogHandler.priority_names['important'] = logging.handlers.SysLogHandler.LOG_WARNING
# ensuite on peut créer notre instance de SysLogHandler:
adresse_ip = politique.parametres['serveur_syslog'].valeur
port_udp = politique.parametres['port_syslog'].valeur
log_syslog = logging.handlers.SysLogHandler((adresse_ip, port_udp))
log_syslog.setLevel(logging.WARNING)
#log_syslog.setFormatter(Formatter_Latin1(
# fmt = '%(asctime)s %(name)-12s %(levelname)-9s %(message)s',
# datefmt = '%d/%m/%y %H:%M'))
# syslog n'a pas besoin des infos date/heure et niveau, juste le message:
log_syslog.setFormatter(Formatter_Latin1('%(message)s'))
logger.addHandler(log_syslog)
# return the logger object (in the future there will be one per session):
return logger
#------------------------------------------------------------------------------
# fermer_journal
#-------------------
def fermer_journal() :
"""
Ferme proprement l'objet journal
"""
try :
# on récupère le Logger racine du module logging:
## rootLogger = logging.getLogger('')
# on ferme proprement chaque handler:
for h in logger.handlers:
h.flush()
h.close()
logger.removeHandler(h)
## log_console.flush()
## log_console.close()
## log_fichier.flush()
## log_fichier.close()
## log_fichier2.flush()
## log_fichier2.close()
## log_syslog.flush()
## log_syslog.close()
## # puis on les supprime:
## logger.removeHandler(log_console)
## logger.removeHandler(log_fichier)
## logger.removeHandler(log_fichier2)
## logger.removeHandler(log_syslog)
except:
raise
#------------------------------------------------------------------------------
# JOURNALISATION
#-------------------
# cf. aide du module logging
def debug(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau DEBUG, pour le journal de
débogage technique en mode DEBUG pour le développement uniquement.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# ci-dessous la virgule est indispensable sinon (unistr(chaine)) est une
# chaîne et non un tuple...
args = (unistr(msg),) + args
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
logger.debug(*args, **kwargs)
def info2(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau INFO2, pour le journal de
débogage technique.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (INFO2, unistr(msg)) + args
logger.log(*args, **kwargs)
def info(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau INFO, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: un fichier nettoyé ou accepté.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (unistr(msg),) + args
logger.info(*args, **kwargs)
def warning(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau WARNING, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: un fichier refusé.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (unistr(msg),) + args
logger.warning(*args, **kwargs)
def important(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau IMPORTANT (entre WARNING ET ERROR).
Exemple: le début et la fin d'un transfert.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (IMPORTANT, unistr(msg)) + args
logger.log(*args, **kwargs)
def error(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau ERROR, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: une erreur anormale, qui ne nécessite pas l'arrêt du processus.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
# syntaxe bizarre: "extended call syntax" --> cf. "apply" dans aide Python
args = (unistr(msg),) + args
logger.error(*args, **kwargs)
def exception(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau ERROR avec le texte complet de
l'exception en cours, qui sera affiché sur la console et enregistré dans
différents journaux. Cette fonction doit normalement être appelée dans un
bloc "except".
Exemple: une erreur anormale, qui ne nécessite pas l'arrêt du processus.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
"""
args = (unistr(msg),) + args
logger.exception(*args, **kwargs)
def critical(msg, *args, **kwargs):
"""Pour journaliser un évènement de niveau CRITICAL, qui sera affiché sur la
console et enregistré dans différents journaux.
Exemple: une erreur critique, qui nécessite l'arrêt du processus.
@param msg: le message de l'évènement à journaliser
@type msg: str, unicode, objet quelconque
@param exc_info: quand ce paramètre vaut True ou 1, l'exception en cours est
journalisée avec le message.
@type exc_info: bool, int, str, ...
"""
args = (unistr(msg),) + args
logger.critical(*args, **kwargs)
#=== PROGRAMME PRINCIPAL (test) ===============================================
if __name__ == "__main__":
print "-----------------------------"
print "TEST DU MODULE Journal.py:"
print "-----------------------------"
print ""
#mode_debug(True)
## init_journal()
## for niv in [
## logging.DEBUG,
## INFO2,
## logging.INFO,
## logging.WARNING,
## IMPORTANT,
## logging.ERROR,
## logging.CRITICAL,
## ]:
## nom = logging.getLevelName(niv)
## niv2 = logging.getLevelName(nom)
## print "niveau %s = %d" % (nom,niv2)
## debug("évènement de niveau DEBUG")
## info2("évènement de niveau INFO2")
## info("évènement de niveau INFO")
## warning("évènement de niveau WARNING")
## important("évènement de niveau IMPORTANT")
## error("évènement de niveau ERROR")
## critical("évènement de niveau CRITICAL")
## print "Je vais maintenant declencher une exception..."
## try:
## a=1/0
## except:
## exception("exception, évènement de niveau ERROR")
print 'tests using the new ExtendedLogger class:'
# required to import Politique, because of gettext...
import ExeFilter
# setup a default policy:
import Politique
policy = Politique.Politique()
# enable file logging:
policy.parametres['journal_securite'].valeur = True
policy.parametres['journal_debug'].valeur = True
init_journal(policy, journal_secu='test_secu.log', journal_debug='test_debug.log')
#logging.setLoggerClass(ExtendedLogger)
#logging.basicConfig(level=logging.DEBUG)
log = logger #logging.getLogger('test')
log.debug(u"évènement de niveau DEBUG")
log.info2(u"évènement de niveau INFO2")
log.info(u"évènement de niveau INFO")
log.warning(u"évènement de niveau WARNING")
log.important(u"évènement de niveau IMPORTANT")
log.error(u"évènement de niveau ERROR")
log.critical(u"évènement de niveau CRITICAL")
print "Je vais maintenant declencher une exception..."
try:
a=1/0
except:
log.exception(u"exception, évènement de niveau ERROR")