/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: John Arbash Meinel
  • Date: 2008-05-06 14:34:57 UTC
  • mto: This revision was merged to the branch mainline in revision 3438.
  • Revision ID: john@arbash-meinel.com-20080506143457-mytwmwshmz1bu1uf
minor doc clarification for decentralized with shared-mainline

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Messages and logging.
 
17
"""Messages and logging for bazaar-ng.
18
18
 
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
33
33
 
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.
37
38
 
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
58
59
import logging
59
60
import os
60
61
import sys
 
62
import re
61
63
import time
62
64
 
63
65
from bzrlib.lazy_import import lazy_import
70
72
 
71
73
import bzrlib
72
74
 
73
 
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
75
 
    deprecated_in,
76
 
    )
77
 
 
78
75
lazy_import(globals(), """
79
76
from bzrlib import (
80
77
    debug,
82
79
    osutils,
83
80
    plugin,
84
81
    symbol_versioning,
85
 
    ui,
86
82
    )
87
83
""")
88
84
 
111
107
 
112
108
 
113
109
def note(*args, **kwargs):
114
 
    """Output a note to the user.
115
 
 
116
 
    Takes the same parameters as logging.info.
117
 
    :return: None
118
 
    """
119
110
    # FIXME note always emits utf-8, regardless of the terminal encoding
120
111
    #
121
112
    # FIXME: clearing the ui and then going through the abstract logging
132
123
    _bzr_logger.warning(*args, **kwargs)
133
124
 
134
125
 
135
 
@deprecated_function(deprecated_in((2, 1, 0)))
136
 
def info(*args, **kwargs):
137
 
    """Deprecated: use trace.note instead."""
138
 
    note(*args, **kwargs)
139
 
 
140
 
 
141
 
@deprecated_function(deprecated_in((2, 1, 0)))
142
 
def log_error(*args, **kwargs):
143
 
    """Deprecated: use bzrlib.trace.show_error instead"""
144
 
    _bzr_logger.error(*args, **kwargs)
145
 
 
146
 
 
147
 
@deprecated_function(deprecated_in((2, 1, 0)))
148
 
def error(*args, **kwargs):
149
 
    """Deprecated: use bzrlib.trace.show_error instead"""
150
 
    _bzr_logger.error(*args, **kwargs)
151
 
 
152
 
 
153
 
def show_error(*args, **kwargs):
154
 
    """Show an error message to the user.
155
 
 
156
 
    Don't use this for exceptions, use report_exception instead.
157
 
    """
158
 
    _bzr_logger.error(*args, **kwargs)
 
126
# configure convenient aliases for output routines
 
127
#
 
128
# TODO: deprecate them, have one name for each.
 
129
info = note
 
130
log_error = _bzr_logger.error
 
131
error =     _bzr_logger.error
159
132
 
160
133
 
161
134
def mutter(fmt, *args):
162
135
    if _trace_file is None:
163
136
        return
164
 
    # XXX: Don't check this every time; instead anyone who closes the file
165
 
    # ought to deregister it.  We can tolerate None.
166
137
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
167
138
        return
168
139
 
181
152
        out = fmt % tuple(real_args)
182
153
    else:
183
154
        out = fmt
184
 
    now = time.time()
185
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
155
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
186
156
    out = timestamp + out + '\n'
187
157
    _trace_file.write(out)
188
 
    # there's no explicit flushing; the file is typically line buffered.
 
158
    # no need to flush here, the trace file is now linebuffered when it's
 
159
    # opened.
189
160
 
190
161
 
191
162
def mutter_callsite(stacklevel, fmt, *args):
197
168
    :param args: A list of substitution variables.
198
169
    """
199
170
    outf = StringIO()
200
 
    if stacklevel is None:
201
 
        limit = None
202
 
    else:
203
 
        limit = stacklevel + 1
204
 
    traceback.print_stack(limit=limit, file=outf)
 
171
    traceback.print_stack(limit=stacklevel + 1, file=outf)
205
172
    formatted_lines = outf.getvalue().splitlines()
206
173
    formatted_stack = '\n'.join(formatted_lines[:-2])
207
174
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
234
201
 
235
202
 
236
203
def _open_bzr_log():
237
 
    """Open the .bzr.log trace file.
 
204
    """Open the .bzr.log trace file.  
238
205
 
239
206
    If the log is more than a particular length, the old file is renamed to
240
207
    .bzr.log.old and a new file is started.  Otherwise, we append to the
243
210
    This sets the global _bzr_log_filename.
244
211
    """
245
212
    global _bzr_log_filename
246
 
 
247
 
    def _open_or_create_log_file(filename):
248
 
        """Open existing log file, or create with ownership and permissions
249
 
 
250
 
        It inherits the ownership and permissions (masked by umask) from
251
 
        the containing directory to cope better with being run under sudo
252
 
        with $HOME still set to the user's homedir.
253
 
        """
254
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
255
 
        while True:
256
 
            try:
257
 
                fd = os.open(filename, flags)
258
 
                break
259
 
            except OSError, e:
260
 
                if e.errno != errno.ENOENT:
261
 
                    raise
262
 
            try:
263
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
264
 
            except OSError, e:
265
 
                if e.errno != errno.EEXIST:
266
 
                    raise
267
 
            else:
268
 
                osutils.copy_ownership_from_path(filename)
269
 
                break
270
 
        return os.fdopen(fd, 'at', 0) # unbuffered
271
 
 
272
 
 
273
213
    _bzr_log_filename = _get_bzr_log_filename()
274
214
    _rollover_trace_maybe(_bzr_log_filename)
275
215
    try:
276
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
 
216
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
 
217
        # bzr_log_file.tell() on windows always return 0 until some writing done
277
218
        bzr_log_file.write('\n')
278
219
        if bzr_log_file.tell() <= 2:
279
220
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
221
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
222
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
282
 
 
283
223
        return bzr_log_file
284
 
 
285
 
    except EnvironmentError, e:
286
 
        # If we are failing to open the log, then most likely logging has not
287
 
        # been set up yet. So we just write to stderr rather than using
288
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
289
 
        # handlers registered for "bzr"' when something goes wrong on the
290
 
        # server. (bug #503886)
291
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
224
    except IOError, e:
 
225
        warning("failed to open trace file: %s" % (e))
292
226
    # TODO: What should happen if we fail to open the trace file?  Maybe the
293
227
    # objects should be pointed at /dev/null or the equivalent?  Currently
294
228
    # returns None which will cause failures later.
295
 
    return None
296
229
 
297
230
 
298
231
def enable_default_logging():
299
232
    """Configure default logging: messages to stderr and debug to .bzr.log
300
 
 
 
233
    
301
234
    This should only be called once per process.
302
235
 
303
236
    Non-command-line programs embedding bzrlib do not need to call this.  They
304
237
    can instead either pass a file to _push_log_file, or act directly on
305
238
    logging.getLogger("bzr").
306
 
 
 
239
    
307
240
    Output can be redirected away by calling _push_log_file.
308
241
    """
309
 
    # Do this before we open the log file, so we prevent
310
 
    # get_terminal_encoding() from mutter()ing multiple times
311
 
    term_encoding = osutils.get_terminal_encoding()
312
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
313
 
                                           timezone='local')
314
242
    # create encoded wrapper around stderr
315
243
    bzr_log_file = _open_bzr_log()
316
 
    if bzr_log_file is not None:
317
 
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
244
    push_log_file(bzr_log_file,
319
245
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
246
        r'%Y-%m-%d %H:%M:%S')
321
247
    # after hooking output into bzr_log, we also need to attach a stderr
322
248
    # handler, writing only at level info and with encoding
323
 
    writer_factory = codecs.getwriter(term_encoding)
 
249
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
324
250
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
251
    stderr_handler = logging.StreamHandler(encoded_stderr)
326
252
    stderr_handler.setLevel(logging.INFO)
332
258
 
333
259
    :param to_file: A file-like object to which messages will be sent.
334
260
 
335
 
    :returns: A memento that should be passed to _pop_log_file to restore the
 
261
    :returns: A memento that should be passed to _pop_log_file to restore the 
336
262
    previously active logging.
337
263
    """
338
264
    global _trace_file
367
293
    """Undo changes to logging/tracing done by _push_log_file.
368
294
 
369
295
    This flushes, but does not close the trace file.
370
 
 
 
296
    
371
297
    Takes the memento returned from _push_log_file."""
 
298
    assert magic == 'log_memento'
372
299
    global _trace_file
373
300
    _trace_file = old_trace_file
374
301
    bzr_logger = logging.getLogger('bzr')
380
307
    new_trace_file.flush()
381
308
 
382
309
 
 
310
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
311
def enable_test_log(to_file):
 
312
    """Redirect logging to a temporary file for a test
 
313
    
 
314
    :returns: an opaque reference that should be passed to disable_test_log
 
315
    after the test completes.
 
316
    """
 
317
    return push_log_file(to_file)
 
318
 
 
319
 
 
320
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
321
def disable_test_log(memento):
 
322
    return pop_log_file(memento)
 
323
 
 
324
 
383
325
def log_exception_quietly():
384
326
    """Log the last exception to the trace file only.
385
327
 
386
 
    Used for exceptions that occur internally and that may be
387
 
    interesting to developers but not to users.  For example,
 
328
    Used for exceptions that occur internally and that may be 
 
329
    interesting to developers but not to users.  For example, 
388
330
    errors loading plugins.
389
331
    """
390
332
    mutter(traceback.format_exc())
398
340
    global _verbosity_level
399
341
    _verbosity_level = level
400
342
    _update_logging_level(level < 0)
401
 
    ui.ui_factory.be_quiet(level < 0)
402
343
 
403
344
 
404
345
def get_verbosity_level():
410
351
 
411
352
 
412
353
def be_quiet(quiet=True):
 
354
    # Perhaps this could be deprecated now ...
413
355
    if quiet:
414
356
        set_verbosity_level(-1)
415
357
    else:
434
376
    return _verbosity_level > 0
435
377
 
436
378
 
437
 
def debug_memory(message='', short=True):
438
 
    """Write out a memory dump."""
439
 
    if sys.platform == 'win32':
440
 
        from bzrlib import win32utils
441
 
        win32utils.debug_memory_win32api(message=message, short=short)
442
 
    else:
443
 
        _debug_memory_proc(message=message, short=short)
444
 
 
445
 
 
446
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
447
 
 
448
 
def _debug_memory_proc(message='', short=True):
449
 
    try:
450
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
451
 
    except IOError:
452
 
        return
453
 
    try:
454
 
        status = status_file.read()
455
 
    finally:
456
 
        status_file.close()
457
 
    if message:
458
 
        note(message)
459
 
    for line in status.splitlines():
460
 
        if not short:
461
 
            note(line)
462
 
        else:
463
 
            for field in _short_fields:
464
 
                if line.startswith(field):
465
 
                    note(line)
466
 
                    break
 
379
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
380
def disable_default_logging():
 
381
    """Turn off default log handlers.
 
382
 
 
383
    Don't call this method, use _push_log_file and _pop_log_file instead.
 
384
    """
 
385
    pass
467
386
 
468
387
 
469
388
def report_exception(exc_info, err_file):
473
392
 
474
393
    :return: The appropriate exit code for this error.
475
394
    """
 
395
    exc_type, exc_object, exc_tb = exc_info
476
396
    # Log the full traceback to ~/.bzr.log
477
397
    log_exception_quietly()
478
 
    if 'error' in debug.debug_flags:
479
 
        print_exception(exc_info, err_file)
480
 
        return errors.EXIT_ERROR
481
 
    exc_type, exc_object, exc_tb = exc_info
482
398
    if (isinstance(exc_object, IOError)
483
399
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
400
        err_file.write("bzr: broken pipe\n")
486
402
    elif isinstance(exc_object, KeyboardInterrupt):
487
403
        err_file.write("bzr: interrupted\n")
488
404
        return errors.EXIT_ERROR
489
 
    elif isinstance(exc_object, MemoryError):
490
 
        err_file.write("bzr: out of memory\n")
491
 
        return errors.EXIT_ERROR
492
 
    elif isinstance(exc_object, ImportError) \
493
 
        and str(exc_object).startswith("No module named "):
494
 
        report_user_error(exc_info, err_file,
495
 
            'You may need to install this Python library separately.')
496
 
        return errors.EXIT_ERROR
497
405
    elif not getattr(exc_object, 'internal_error', True):
498
406
        report_user_error(exc_info, err_file)
499
407
        return errors.EXIT_ERROR
507
415
        return errors.EXIT_INTERNAL_ERROR
508
416
 
509
417
 
510
 
def print_exception(exc_info, err_file):
511
 
    exc_type, exc_object, exc_tb = exc_info
512
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
513
 
        exc_type.__module__, exc_type.__name__, exc_object))
514
 
    err_file.write('\n')
515
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
516
 
 
517
 
 
518
418
# TODO: Should these be specially encoding the output?
519
 
def report_user_error(exc_info, err_file, advice=None):
 
419
def report_user_error(exc_info, err_file):
520
420
    """Report to err_file an error that's not an internal error.
521
421
 
522
422
    These don't get a traceback unless -Derror was given.
523
 
 
524
 
    :param exc_info: 3-tuple from sys.exc_info()
525
 
    :param advice: Extra advice to the user to be printed following the
526
 
        exception.
527
423
    """
 
424
    if 'error' in debug.debug_flags:
 
425
        report_bug(exc_info, err_file)
 
426
        return
528
427
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
529
 
    if advice:
530
 
        err_file.write("%s\n" % (advice,))
531
428
 
532
429
 
533
430
def report_bug(exc_info, err_file):
534
431
    """Report an exception that probably indicates a bug in bzr"""
535
 
    from bzrlib.crash import report_bug
536
 
    report_bug(exc_info, err_file)
537
 
 
538
 
 
539
 
def _flush_stdout_stderr():
540
 
    # installed into an atexit hook by bzrlib.initialize()
541
 
    try:
542
 
        sys.stdout.flush()
543
 
        sys.stderr.flush()
544
 
    except IOError, e:
545
 
        import errno
546
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
547
 
            pass
548
 
        else:
549
 
            raise
550
 
 
551
 
 
552
 
def _flush_trace():
553
 
    # run from atexit hook
554
 
    global _trace_file
555
 
    if _trace_file:
556
 
        _trace_file.flush()
 
432
    exc_type, exc_object, exc_tb = exc_info
 
433
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
434
        exc_type.__module__, exc_type.__name__, exc_object))
 
435
    err_file.write('\n')
 
436
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
437
    err_file.write('\n')
 
438
    err_file.write('bzr %s on python %s (%s)\n' % \
 
439
                       (bzrlib.__version__,
 
440
                        bzrlib._format_version_tuple(sys.version_info),
 
441
                        sys.platform))
 
442
    err_file.write('arguments: %r\n' % sys.argv)
 
443
    err_file.write(
 
444
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
445
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
446
            os.environ.get('LANG')))
 
447
    err_file.write("plugins:\n")
 
448
    for name, a_plugin in sorted(plugin.plugins().items()):
 
449
        err_file.write("  %-20s %s [%s]\n" %
 
450
            (name, a_plugin.path(), a_plugin.__version__))
 
451
    err_file.write(
 
452
"""\
 
453
*** Bazaar has encountered an internal error.
 
454
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
 
455
    including this traceback, and a description of what you
 
456
    were doing when the error occurred.
 
457
""")