logger.py
227 lines
| 8.1 KiB
| text/x-python
|
PythonLexer
Fernando Perez
|
r3086 | """Logger class for IPython's logging facilities. | ||
fperez
|
r0 | """ | ||
#***************************************************************************** | ||||
# Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and | ||||
fperez
|
r88 | # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu> | ||
fperez
|
r0 | # | ||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
#***************************************************************************** | ||||
#**************************************************************************** | ||||
# Modules and globals | ||||
# Python standard modules | ||||
fperez
|
r52 | import glob | ||
Thomas Kluyver
|
r7081 | import io | ||
fperez
|
r52 | import os | ||
fperez
|
r60 | import time | ||
fperez
|
r0 | |||
Thomas Kluyver
|
r7081 | |||
fperez
|
r0 | #**************************************************************************** | ||
fperez
|
r60 | # FIXME: This class isn't a mixin anymore, but it still needs attributes from | ||
# ipython and does input cache management. Finish cleanup later... | ||||
class Logger(object): | ||||
"""A Logfile class with different policies for file creation""" | ||||
Thomas Kluyver
|
r7081 | def __init__(self, home_dir, logfname='Logger.log', loghead=u'', | ||
Fernando Perez
|
r3086 | logmode='over'): | ||
fperez
|
r0 | |||
fperez
|
r60 | # this is the full ipython instance, we need some attributes from it | ||
# which won't exist until later. What a mess, clean up later... | ||||
Fernando Perez
|
r3086 | self.home_dir = home_dir | ||
fperez
|
r60 | |||
self.logfname = logfname | ||||
self.loghead = loghead | ||||
self.logmode = logmode | ||||
self.logfile = None | ||||
fperez
|
r305 | # Whether to log raw or processed input | ||
self.log_raw_input = False | ||||
fperez
|
r60 | # whether to also log output | ||
self.log_output = False | ||||
# whether to put timestamps before each log entry | ||||
self.timestamp = False | ||||
# activity control flags | ||||
self.log_active = False | ||||
# logmode is a validated property | ||||
def _set_mode(self,mode): | ||||
if mode not in ['append','backup','global','over','rotate']: | ||||
Bradley M. Froehle
|
r7843 | raise ValueError('invalid log mode %s given' % mode) | ||
fperez
|
r60 | self._logmode = mode | ||
def _get_mode(self): | ||||
return self._logmode | ||||
logmode = property(_get_mode,_set_mode) | ||||
Bernardo B. Marques
|
r4872 | |||
Thomas Kluyver
|
r7082 | def logstart(self, logfname=None, loghead=None, logmode=None, | ||
log_output=False, timestamp=False, log_raw_input=False): | ||||
fperez
|
r60 | """Generate a new log-file with a default header. | ||
Raises RuntimeError if the log has already been started""" | ||||
if self.logfile is not None: | ||||
raise RuntimeError('Log file is already active: %s' % | ||||
self.logfname) | ||||
Bernardo B. Marques
|
r4872 | |||
fperez
|
r305 | # The parameters can override constructor defaults | ||
if logfname is not None: self.logfname = logfname | ||||
if loghead is not None: self.loghead = loghead | ||||
if logmode is not None: self.logmode = logmode | ||||
# Parameters not part of the constructor | ||||
fperez
|
r60 | self.timestamp = timestamp | ||
self.log_output = log_output | ||||
fperez
|
r305 | self.log_raw_input = log_raw_input | ||
Bernardo B. Marques
|
r4872 | |||
fperez
|
r60 | # init depending on the log mode requested | ||
isfile = os.path.isfile | ||||
logmode = self.logmode | ||||
if logmode == 'append': | ||||
Thomas Kluyver
|
r7081 | self.logfile = io.open(self.logfname, 'a', encoding='utf-8') | ||
fperez
|
r60 | |||
elif logmode == 'backup': | ||||
if isfile(self.logfname): | ||||
fperez
|
r0 | backup_logname = self.logfname+'~' | ||
# Manually remove any old backup, since os.rename may fail | ||||
# under Windows. | ||||
fperez
|
r60 | if isfile(backup_logname): | ||
fperez
|
r0 | os.remove(backup_logname) | ||
os.rename(self.logfname,backup_logname) | ||||
Thomas Kluyver
|
r7081 | self.logfile = io.open(self.logfname, 'w', encoding='utf-8') | ||
fperez
|
r60 | |||
elif logmode == 'global': | ||||
Fernando Perez
|
r3086 | self.logfname = os.path.join(self.home_dir,self.logfname) | ||
Thomas Kluyver
|
r7081 | self.logfile = io.open(self.logfname, 'a', encoding='utf-8') | ||
fperez
|
r60 | |||
elif logmode == 'over': | ||||
if isfile(self.logfname): | ||||
Bernardo B. Marques
|
r4872 | os.remove(self.logfname) | ||
Thomas Kluyver
|
r7081 | self.logfile = io.open(self.logfname,'w', encoding='utf-8') | ||
fperez
|
r60 | |||
elif logmode == 'rotate': | ||||
if isfile(self.logfname): | ||||
Bernardo B. Marques
|
r4872 | if isfile(self.logfname+'.001~'): | ||
fperez
|
r0 | old = glob.glob(self.logfname+'.*~') | ||
old.sort() | ||||
old.reverse() | ||||
for f in old: | ||||
root, ext = os.path.splitext(f) | ||||
num = int(ext[1:-1])+1 | ||||
Matthias BUSSONNIER
|
r7815 | os.rename(f, root+'.'+repr(num).zfill(3)+'~') | ||
fperez
|
r0 | os.rename(self.logfname, self.logfname+'.001~') | ||
Thomas Kluyver
|
r7081 | self.logfile = io.open(self.logfname, 'w', encoding='utf-8') | ||
Bernardo B. Marques
|
r4872 | |||
fperez
|
r60 | if logmode != 'append': | ||
self.logfile.write(self.loghead) | ||||
fperez
|
r0 | |||
fperez
|
r60 | self.logfile.flush() | ||
Luis Pedro Coelho
|
r3887 | self.log_active = True | ||
fperez
|
r0 | |||
def switch_log(self,val): | ||||
fperez
|
r60 | """Switch logging on/off. val should be ONLY a boolean.""" | ||
fperez
|
r0 | |||
fperez
|
r60 | if val not in [False,True,0,1]: | ||
Bradley M. Froehle
|
r7843 | raise ValueError('Call switch_log ONLY with a boolean argument, ' | ||
'not with: %s' % val) | ||||
Bernardo B. Marques
|
r4872 | |||
fperez
|
r60 | label = {0:'OFF',1:'ON',False:'OFF',True:'ON'} | ||
fperez
|
r0 | |||
fperez
|
r60 | if self.logfile is None: | ||
Thomas Kluyver
|
r13348 | print(""" | ||
fperez
|
r60 | Logging hasn't been started yet (use logstart for that). | ||
fperez
|
r0 | |||
%logon/%logoff are for temporarily starting and stopping logging for a logfile | ||||
which already exists. But you must first start the logging process with | ||||
Thomas Kluyver
|
r13348 | %logstart (optionally giving a logfile name).""") | ||
Bernardo B. Marques
|
r4872 | |||
fperez
|
r0 | else: | ||
fperez
|
r60 | if self.log_active == val: | ||
Thomas Kluyver
|
r13348 | print('Logging is already',label[val]) | ||
fperez
|
r0 | else: | ||
Thomas Kluyver
|
r13348 | print('Switching logging',label[val]) | ||
fperez
|
r60 | self.log_active = not self.log_active | ||
self.log_active_out = self.log_active | ||||
fperez
|
r0 | |||
def logstate(self): | ||||
"""Print a status message about the logger.""" | ||||
fperez
|
r60 | if self.logfile is None: | ||
Thomas Kluyver
|
r13348 | print('Logging has not been activated.') | ||
fperez
|
r0 | else: | ||
fperez
|
r60 | state = self.log_active and 'active' or 'temporarily suspended' | ||
Thomas Kluyver
|
r13386 | print('Filename :', self.logfname) | ||
print('Mode :', self.logmode) | ||||
print('Output logging :', self.log_output) | ||||
print('Raw input log :', self.log_raw_input) | ||||
print('Timestamping :', self.timestamp) | ||||
print('State :', state) | ||||
fperez
|
r0 | |||
Fernando Perez
|
r3086 | def log(self, line_mod, line_ori): | ||
"""Write the sources to a log. | ||||
fperez
|
r305 | |||
Inputs: | ||||
- line_mod: possibly modified input, such as the transformations made | ||||
Thomas Kluyver
|
r12553 | by input prefilters or input handlers of various kinds. This should | ||
always be valid Python. | ||||
fperez
|
r305 | |||
Thomas Kluyver
|
r12553 | - line_ori: unmodified input line from the user. This is not | ||
necessarily valid Python. | ||||
Fernando Perez
|
r3086 | """ | ||
fperez
|
r305 | |||
# Write the log line, but decide which one according to the | ||||
# log_raw_input flag, set when the log is started. | ||||
if self.log_raw_input: | ||||
self.log_write(line_ori) | ||||
else: | ||||
self.log_write(line_mod) | ||||
fperez
|
r60 | |||
Fernando Perez
|
r3086 | def log_write(self, data, kind='input'): | ||
fperez
|
r60 | """Write data to the log file, if active""" | ||
vivainio
|
r145 | #print 'data: %r' % data # dbg | ||
fperez
|
r60 | if self.log_active and data: | ||
write = self.logfile.write | ||||
if kind=='input': | ||||
if self.timestamp: | ||||
Srinivas Reddy Thatiparthy
|
r23065 | write(time.strftime('# %a, %d %b %Y %H:%M:%S\n', time.localtime())) | ||
Fernando Perez
|
r3086 | write(data) | ||
fperez
|
r60 | elif kind=='output' and self.log_output: | ||
Thomas Kluyver
|
r7081 | odata = u'\n'.join([u'#[Out]# %s' % s | ||
Fernando Perez
|
r3086 | for s in data.splitlines()]) | ||
Thomas Kluyver
|
r7081 | write(u'%s\n' % odata) | ||
Roy Reznik
|
r28072 | try: | ||
self.logfile.flush() | ||||
except OSError: | ||||
print("Failed to flush the log file.") | ||||
print( | ||||
f"Please check that {self.logfname} exists and have the right permissions." | ||||
) | ||||
print( | ||||
"Also consider turning off the log with `%logstop` to avoid this warning." | ||||
) | ||||
fperez
|
r0 | |||
fperez
|
r895 | def logstop(self): | ||
"""Fully stop logging and close log file. | ||||
In order to start logging again, a new logstart() call needs to be | ||||
made, possibly (though not necessarily) with a new filename, mode and | ||||
other options.""" | ||||
Bernardo B. Marques
|
r4872 | |||
Bernard Paulus
|
r4870 | if self.logfile is not None: | ||
self.logfile.close() | ||||
self.logfile = None | ||||
else: | ||||
Thomas Kluyver
|
r13348 | print("Logging hadn't been started.") | ||
fperez
|
r895 | self.log_active = False | ||
# For backwards compatibility, in case anyone was using this. | ||||
close_log = logstop | ||||