source: branches/casa-prerelease/pre-asap/python/logging.py@ 2302

Last change on this file since 2302 was 1939, checked in by Malte Marquarding, 14 years ago

Ticket #210: cast to string in case we get passed unicode

File size: 3.2 KB
Line 
1"""This module presents a logging abstraction layer on top of casa.
2"""
3__all__ = ["asaplog", "asaplog_post_dec", "AsapLogger"]
4
5import inspect
6from asap.env import is_casapy
7from asap.parameters import rcParams
8from asap._asap import LogSink, set_global_sink
9try:
10 from functools import wraps as wraps_dec
11except ImportError:
12 from asap.compatibility import wraps as wraps_dec
13
14
15class AsapLogger(object):
16 """Wrapper object to allow for both casapy and asap logging.
17
18 Inside casapy this will connect to `taskinit.casalog`. Otherwise it will
19 create its own casa log sink.
20
21 .. note:: Do instantiate a new one - use the :obj:`asaplog` instead.
22
23 """
24 def __init__(self):
25 self._enabled = True
26 self._log = ""
27 if is_casapy():
28 from taskinit import casalog
29 self.logger = casalog
30 else:
31 self.logger = LogSink()
32 set_global_sink(self.logger)
33
34 def post(self, level='INFO', origin=""):
35 """Post the messages to the logger. This will clear the buffered
36 logs.
37
38 Parameters:
39
40 level: The log level (severity). One of INFO, WARN, ERROR.
41
42 """
43 if not self._enabled:
44 return
45
46 if not origin:
47 origin = inspect.getframeinfo(inspect.currentframe().f_back)[2]
48 logs = self._log.strip()
49 if len(logs) > 0:
50 if isinstance(self.logger, LogSink):
51 #can't handle unicode in boost signature
52 logs = str(logs)
53 self.logger.post(logs, priority=level, origin=origin)
54 if isinstance(self.logger, LogSink):
55 logs = self.logger.pop().strip()
56 if len(logs) > 0:
57 print logs
58 self._log = ""
59
60 def push(self, msg, newline=True):
61 """Push logs into the buffer. post needs to be called to send them.
62
63 Parameters:
64
65 msg: the log message (string)
66
67 newline: should we terminate with a newline (default yes)
68
69 """
70 if self._enabled:
71 sep = ""
72 self._log = sep.join([self._log, msg])
73 if newline:
74 self._log += "\n"
75
76 def enable(self, flag=True):
77 """Enable (or disable) logging."""
78 self._enabled = flag
79
80 def disable(self, flag=False):
81 """Disable (or enable) logging"""
82 self._enabled = flag
83
84 def is_enabled(self):
85 return self._enabled
86
87asaplog = AsapLogger()
88"""Default asap logger"""
89
90def asaplog_post_dec(f):
91 """Decorator which posts log at completion of the wrapped method.
92
93 Example::
94
95 @asaplog_post_dec
96 def test(self):
97 do_stuff()
98 asaplog.push('testing...', False)
99 do_more_stuff()
100 asaplog.push('finished')
101 """
102 @wraps_dec(f)
103 def wrap_it(*args, **kw):
104 level = "INFO"
105 try:
106 val = f(*args, **kw)
107 return val
108 except Exception, ex:
109 level = "ERROR"
110 asaplog.push(str(ex))
111 if rcParams['verbose']:
112 pass
113 else:
114 raise
115 finally:
116 asaplog.post(level, f.func_name)
117 #asaplog.post(level, ".".join([f.__module__,f.func_name]))
118 return wrap_it
119
Note: See TracBrowser for help on using the repository browser.