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