/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

Initial commit for russian version of documents.

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
 
 
118
 
    :return: None
119
 
    """
120
110
    # FIXME note always emits utf-8, regardless of the terminal encoding
121
111
    #
122
112
    # FIXME: clearing the ui and then going through the abstract logging
133
123
    _bzr_logger.warning(*args, **kwargs)
134
124
 
135
125
 
136
 
@deprecated_function(deprecated_in((2, 1, 0)))
137
 
def info(*args, **kwargs):
138
 
    """Deprecated: use trace.note instead."""
139
 
    note(*args, **kwargs)
140
 
 
141
 
 
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)
146
 
 
147
 
 
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)
152
 
 
153
 
 
154
 
def show_error(*args, **kwargs):
155
 
    """Show an error message to the user.
156
 
 
157
 
    Don't use this for exceptions, use report_exception instead.
158
 
    """
159
 
    _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
160
132
 
161
133
 
162
134
def mutter(fmt, *args):
163
135
    if _trace_file is None:
164
136
        return
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:
168
138
        return
169
139
 
182
152
        out = fmt % tuple(real_args)
183
153
    else:
184
154
        out = fmt
185
 
    now = time.time()
186
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
155
    timestamp = '%0.3f  ' % (time.time() - _bzr_log_start_time,)
187
156
    out = timestamp + out + '\n'
188
157
    _trace_file.write(out)
189
 
    # 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.
190
160
 
191
161
 
192
162
def mutter_callsite(stacklevel, fmt, *args):
235
205
 
236
206
 
237
207
def _open_bzr_log():
238
 
    """Open the .bzr.log trace file.
 
208
    """Open the .bzr.log trace file.  
239
209
 
240
210
    If the log is more than a particular length, the old file is renamed to
241
211
    .bzr.log.old and a new file is started.  Otherwise, we append to the
244
214
    This sets the global _bzr_log_filename.
245
215
    """
246
216
    global _bzr_log_filename
247
 
 
248
 
    def _open_or_create_log_file(filename):
249
 
        """Open existing log file, or create with ownership and permissions
250
 
 
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.
254
 
        """
255
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
256
 
        while True:
257
 
            try:
258
 
                fd = os.open(filename, flags)
259
 
                break
260
 
            except OSError, e:
261
 
                if e.errno != errno.ENOENT:
262
 
                    raise
263
 
            try:
264
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
 
            except OSError, e:
266
 
                if e.errno != errno.EEXIST:
267
 
                    raise
268
 
            else:
269
 
                osutils.copy_ownership_from_path(filename)
270
 
                break
271
 
        return os.fdopen(fd, 'at', 0) # unbuffered
272
 
 
273
 
 
274
217
    _bzr_log_filename = _get_bzr_log_filename()
275
218
    _rollover_trace_maybe(_bzr_log_filename)
276
219
    try:
277
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
 
220
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
 
221
        # bzr_log_file.tell() on windows always return 0 until some writing done
278
222
        bzr_log_file.write('\n')
279
223
        if bzr_log_file.tell() <= 2:
280
224
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
225
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
226
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
 
 
284
227
        return bzr_log_file
285
 
 
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,))
 
228
    except IOError, e:
 
229
        warning("failed to open trace file: %s" % (e))
293
230
    # TODO: What should happen if we fail to open the trace file?  Maybe the
294
231
    # objects should be pointed at /dev/null or the equivalent?  Currently
295
232
    # returns None which will cause failures later.
296
 
    return None
297
233
 
298
234
 
299
235
def enable_default_logging():
300
236
    """Configure default logging: messages to stderr and debug to .bzr.log
301
 
 
 
237
    
302
238
    This should only be called once per process.
303
239
 
304
240
    Non-command-line programs embedding bzrlib do not need to call this.  They
305
241
    can instead either pass a file to _push_log_file, or act directly on
306
242
    logging.getLogger("bzr").
307
 
 
 
243
    
308
244
    Output can be redirected away by calling _push_log_file.
309
 
 
310
 
    :return: A memento from push_log_file for restoring the log state.
311
245
    """
312
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
313
 
                                           timezone='local')
314
246
    # create encoded wrapper around stderr
315
247
    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
 
    memento = push_log_file(bzr_log_file,
 
248
    push_log_file(bzr_log_file,
319
249
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
250
        r'%Y-%m-%d %H:%M:%S')
321
251
    # after hooking output into bzr_log, we also need to attach a stderr
322
252
    # handler, writing only at level info and with encoding
323
 
    term_encoding = osutils.get_terminal_encoding()
324
 
    writer_factory = codecs.getwriter(term_encoding)
 
253
    writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
325
254
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
255
    stderr_handler = logging.StreamHandler(encoded_stderr)
327
256
    stderr_handler.setLevel(logging.INFO)
328
257
    logging.getLogger('bzr').addHandler(stderr_handler)
329
 
    return memento
330
258
 
331
259
 
332
260
def push_log_file(to_file, log_format=None, date_format=None):
334
262
 
335
263
    :param to_file: A file-like object to which messages will be sent.
336
264
 
337
 
    :returns: A memento that should be passed to _pop_log_file to restore the
 
265
    :returns: A memento that should be passed to _pop_log_file to restore the 
338
266
    previously active logging.
339
267
    """
340
268
    global _trace_file
368
296
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
297
    """Undo changes to logging/tracing done by _push_log_file.
370
298
 
371
 
    This flushes, but does not close the trace file (so that anything that was
372
 
    in it is output.
373
 
 
 
299
    This flushes, but does not close the trace file.
 
300
    
374
301
    Takes the memento returned from _push_log_file."""
375
302
    global _trace_file
376
303
    _trace_file = old_trace_file
377
304
    bzr_logger = logging.getLogger('bzr')
378
305
    bzr_logger.removeHandler(new_handler)
379
 
    # must be closed, otherwise logging will try to close it at exit, and the
 
306
    # must be closed, otherwise logging will try to close it atexit, and the
380
307
    # file will likely already be closed underneath.
381
308
    new_handler.close()
382
309
    bzr_logger.handlers = old_handlers
383
 
    if new_trace_file is not None:
384
 
        new_trace_file.flush()
 
310
    new_trace_file.flush()
 
311
 
 
312
 
 
313
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
314
def enable_test_log(to_file):
 
315
    """Redirect logging to a temporary file for a test
 
316
    
 
317
    :returns: an opaque reference that should be passed to disable_test_log
 
318
    after the test completes.
 
319
    """
 
320
    return push_log_file(to_file)
 
321
 
 
322
 
 
323
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
324
def disable_test_log(memento):
 
325
    return pop_log_file(memento)
385
326
 
386
327
 
387
328
def log_exception_quietly():
388
329
    """Log the last exception to the trace file only.
389
330
 
390
 
    Used for exceptions that occur internally and that may be
391
 
    interesting to developers but not to users.  For example,
 
331
    Used for exceptions that occur internally and that may be 
 
332
    interesting to developers but not to users.  For example, 
392
333
    errors loading plugins.
393
334
    """
394
335
    mutter(traceback.format_exc())
402
343
    global _verbosity_level
403
344
    _verbosity_level = level
404
345
    _update_logging_level(level < 0)
405
 
    ui.ui_factory.be_quiet(level < 0)
406
346
 
407
347
 
408
348
def get_verbosity_level():
414
354
 
415
355
 
416
356
def be_quiet(quiet=True):
 
357
    # Perhaps this could be deprecated now ...
417
358
    if quiet:
418
359
        set_verbosity_level(-1)
419
360
    else:
438
379
    return _verbosity_level > 0
439
380
 
440
381
 
441
 
def debug_memory(message='', short=True):
442
 
    """Write out a memory dump."""
443
 
    if sys.platform == 'win32':
444
 
        from bzrlib import win32utils
445
 
        win32utils.debug_memory_win32api(message=message, short=short)
446
 
    else:
447
 
        _debug_memory_proc(message=message, short=short)
448
 
 
449
 
 
450
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
451
 
 
452
 
def _debug_memory_proc(message='', short=True):
453
 
    try:
454
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
455
 
    except IOError:
456
 
        return
457
 
    try:
458
 
        status = status_file.read()
459
 
    finally:
460
 
        status_file.close()
461
 
    if message:
462
 
        note(message)
463
 
    for line in status.splitlines():
464
 
        if not short:
465
 
            note(line)
466
 
        else:
467
 
            for field in _short_fields:
468
 
                if line.startswith(field):
469
 
                    note(line)
470
 
                    break
 
382
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
 
383
def disable_default_logging():
 
384
    """Turn off default log handlers.
 
385
 
 
386
    Don't call this method, use _push_log_file and _pop_log_file instead.
 
387
    """
 
388
    pass
471
389
 
472
390
 
473
391
def report_exception(exc_info, err_file):
477
395
 
478
396
    :return: The appropriate exit code for this error.
479
397
    """
 
398
    exc_type, exc_object, exc_tb = exc_info
480
399
    # Log the full traceback to ~/.bzr.log
481
400
    log_exception_quietly()
482
 
    if 'error' in debug.debug_flags:
483
 
        print_exception(exc_info, err_file)
484
 
        return errors.EXIT_ERROR
485
 
    exc_type, exc_object, exc_tb = exc_info
486
401
    if (isinstance(exc_object, IOError)
487
402
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
488
403
        err_file.write("bzr: broken pipe\n")
490
405
    elif isinstance(exc_object, KeyboardInterrupt):
491
406
        err_file.write("bzr: interrupted\n")
492
407
        return errors.EXIT_ERROR
493
 
    elif isinstance(exc_object, MemoryError):
494
 
        err_file.write("bzr: out of memory\n")
495
 
        return errors.EXIT_ERROR
496
408
    elif isinstance(exc_object, ImportError) \
497
409
        and str(exc_object).startswith("No module named "):
498
410
        report_user_error(exc_info, err_file,
501
413
    elif not getattr(exc_object, 'internal_error', True):
502
414
        report_user_error(exc_info, err_file)
503
415
        return errors.EXIT_ERROR
504
 
    elif isinstance(exc_object, (OSError, IOError)) or (
505
 
        # GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
506
 
        exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
 
416
    elif isinstance(exc_object, (OSError, IOError)):
507
417
        # Might be nice to catch all of these and show them as something more
508
418
        # specific, but there are too many cases at the moment.
509
419
        report_user_error(exc_info, err_file)
531
441
    :param advice: Extra advice to the user to be printed following the
532
442
        exception.
533
443
    """
 
444
    if 'error' in debug.debug_flags:
 
445
        print_exception(exc_info, err_file)
 
446
        return
534
447
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
535
448
    if advice:
536
449
        err_file.write("%s\n" % (advice,))
538
451
 
539
452
def report_bug(exc_info, err_file):
540
453
    """Report an exception that probably indicates a bug in bzr"""
541
 
    from bzrlib.crash import report_bug
542
 
    report_bug(exc_info, err_file)
543
 
 
544
 
 
545
 
def _flush_stdout_stderr():
546
 
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
547
 
    try:
548
 
        sys.stdout.flush()
549
 
        sys.stderr.flush()
550
 
    except IOError, e:
551
 
        import errno
552
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
553
 
            pass
554
 
        else:
555
 
            raise
556
 
 
557
 
 
558
 
def _flush_trace():
559
 
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
560
 
    global _trace_file
561
 
    if _trace_file:
562
 
        _trace_file.flush()
563
 
 
564
 
 
565
 
class Config(object):
566
 
    """Configuration of message tracing in bzrlib.
567
 
 
568
 
    This implements the context manager protocol and should manage any global
569
 
    variables still used. The default config used is DefaultConfig, but
570
 
    embedded uses of bzrlib may wish to use a custom manager.
571
 
    """
572
 
 
573
 
    def __enter__(self):
574
 
        return self # This is bound to the 'as' clause in a with statement.
575
 
 
576
 
    def __exit__(self, exc_type, exc_val, exc_tb):
577
 
        return False # propogate exceptions.
578
 
 
579
 
 
580
 
class DefaultConfig(Config):
581
 
    """A default configuration for tracing of messages in bzrlib.
582
 
 
583
 
    This implements the context manager protocol.
584
 
    """
585
 
 
586
 
    def __enter__(self):
587
 
        self._original_filename = _bzr_log_filename
588
 
        self._original_state = enable_default_logging()
589
 
        return self # This is bound to the 'as' clause in a with statement.
590
 
 
591
 
    def __exit__(self, exc_type, exc_val, exc_tb):
592
 
        pop_log_file(self._original_state)
593
 
        global _bzr_log_filename
594
 
        _bzr_log_filename = self._original_filename
595
 
        return False # propogate exceptions.
 
454
    print_exception(exc_info, err_file)
 
455
    err_file.write('\n')
 
456
    err_file.write('bzr %s on python %s (%s)\n' % \
 
457
                       (bzrlib.__version__,
 
458
                        bzrlib._format_version_tuple(sys.version_info),
 
459
                        sys.platform))
 
460
    err_file.write('arguments: %r\n' % sys.argv)
 
461
    err_file.write(
 
462
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
463
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
464
            os.environ.get('LANG')))
 
465
    err_file.write("plugins:\n")
 
466
    for name, a_plugin in sorted(plugin.plugins().items()):
 
467
        err_file.write("  %-20s %s [%s]\n" %
 
468
            (name, a_plugin.path(), a_plugin.__version__))
 
469
    err_file.write(
 
470
"""\
 
471
*** Bazaar has encountered an internal error.
 
472
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
 
473
    including this traceback, and a description of what you
 
474
    were doing when the error occurred.
 
475
""")