1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging.
17
"""Messages and logging for bazaar-ng.
19
19
Messages are supplied by callers as a string-formatting template, plus values
20
20
to be inserted into it. The actual %-formatting is deferred to the log
34
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
36
list of files processed by add and commit. In quiet mode, only warnings and
37
above are shown. In debug mode, stderr gets debug messages too.
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
113
108
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
109
# FIXME note always emits utf-8, regardless of the terminal encoding
122
111
# FIXME: clearing the ui and then going through the abstract logging
133
122
_bzr_logger.warning(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def info(*args, **kwargs):
138
"""Deprecated: use trace.note instead."""
139
note(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def log_error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
@deprecated_function(deprecated_in((2, 1, 0)))
149
def error(*args, **kwargs):
150
"""Deprecated: use bzrlib.trace.show_error instead"""
151
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
155
"""Show an error message to the user.
157
Don't use this for exceptions, use report_exception instead.
159
_bzr_logger.error(*args, **kwargs)
125
# configure convenient aliases for output routines
127
# TODO: deprecate them, have one name for each.
128
error = _bzr_logger.error
131
_last_mutter_flush_time = None
162
133
def mutter(fmt, *args):
134
global _last_mutter_flush_time
163
135
if _trace_file is None:
165
# XXX: Don't check this every time; instead anyone who closes the file
166
# ought to deregister it. We can tolerate None.
167
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
186
156
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
187
157
out = timestamp + out + '\n'
188
158
_trace_file.write(out)
189
# there's no explicit flushing; the file is typically line buffered.
159
# We flush if we haven't flushed for a few seconds. We don't want to flush
160
# on every mutter, but when a command takes a while, it can be nice to see
161
# updates in the debug log.
162
if (_last_mutter_flush_time is None
163
or (now - _last_mutter_flush_time) > 2.0):
164
flush = getattr(_trace_file, 'flush', None)
165
if flush is not None:
167
_last_mutter_flush_time = now
192
170
def mutter_callsite(stacklevel, fmt, *args):
244
222
This sets the global _bzr_log_filename.
246
224
global _bzr_log_filename
248
def _open_or_create_log_file(filename):
249
"""Open existing log file, or create with ownership and permissions
251
It inherits the ownership and permissions (masked by umask) from
252
the containing directory to cope better with being run under sudo
253
with $HOME still set to the user's homedir.
255
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
258
fd = os.open(filename, flags)
261
if e.errno != errno.ENOENT:
264
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
266
if e.errno != errno.EEXIST:
269
osutils.copy_ownership_from_path(filename)
271
return os.fdopen(fd, 'at', 0) # unbuffered
274
225
_bzr_log_filename = _get_bzr_log_filename()
275
226
_rollover_trace_maybe(_bzr_log_filename)
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
228
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
229
# bzr_log_file.tell() on windows always return 0 until some writing done
278
230
bzr_log_file.write('\n')
279
231
if bzr_log_file.tell() <= 2:
280
232
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
233
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
234
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
284
235
return bzr_log_file
286
except EnvironmentError, e:
287
# If we are failing to open the log, then most likely logging has not
288
# been set up yet. So we just write to stderr rather than using
289
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
291
# server. (bug #503886)
292
sys.stderr.write("failed to open trace file: %s\n" % (e,))
237
warning("failed to open trace file: %s" % (e))
293
238
# TODO: What should happen if we fail to open the trace file? Maybe the
294
239
# objects should be pointed at /dev/null or the equivalent? Currently
295
240
# returns None which will cause failures later.
475
420
:return: The appropriate exit code for this error.
422
exc_type, exc_object, exc_tb = exc_info
477
423
# Log the full traceback to ~/.bzr.log
478
424
log_exception_quietly()
479
if 'error' in debug.debug_flags:
480
print_exception(exc_info, err_file)
481
return errors.EXIT_ERROR
482
exc_type, exc_object, exc_tb = exc_info
483
425
if (isinstance(exc_object, IOError)
484
426
and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
427
err_file.write("bzr: broken pipe\n")
526
468
:param advice: Extra advice to the user to be printed following the
471
if 'error' in debug.debug_flags:
472
print_exception(exc_info, err_file)
529
474
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
531
476
err_file.write("%s\n" % (advice,))
535
480
"""Report an exception that probably indicates a bug in bzr"""
536
481
from bzrlib.crash import report_bug
537
482
report_bug(exc_info, err_file)
540
def _flush_stdout_stderr():
541
# installed into an atexit hook by bzrlib.initialize()
547
if e.errno in [errno.EINVAL, errno.EPIPE]:
554
# run from atexit hook
added
removed
bzrlib/trace.py
