/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 breezy/trace.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-30 10:50:40 UTC
  • mto: This revision was merged to the branch mainline in revision 7373.
  • Revision ID: jelmer@jelmer.uk-20190630105040-2sxtke70rxnoophf
Move bundle code to breezy.bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
23
23
Messages are classified by severity levels: critical, error, warning, info,
24
24
and debug.
25
25
 
26
 
They can be sent to two places: to stderr, and to ~/.bzr.log.  For purposes
27
 
such as running the test suite, they can also be redirected away from both of
28
 
those two places to another location.
 
26
They can be sent to two places: stderr, and `$XDG_CACHE_HOME/breezy/brz.log`.
 
27
For purposes such as running the test suite, they can also be redirected away
 
28
from both of those two places to another location.
29
29
 
30
 
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
 
30
`brz.log` gets all messages, and full tracebacks for uncaught exceptions.
31
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
32
so that we can always rely on writing any message.
33
33
 
45
45
form.
46
46
"""
47
47
 
 
48
from __future__ import absolute_import
 
49
 
48
50
# FIXME: Unfortunately it turns out that python's logging module
49
51
# is quite expensive, even when the message is not printed by any handlers.
50
52
# We should perhaps change back to just simply doing it here.
54
56
# increased cost of logging.py is not so bad, and we could standardize on
55
57
# that.
56
58
 
57
 
import codecs
 
59
import errno
58
60
import logging
59
61
import os
60
62
import sys
61
63
import time
62
64
 
63
 
from bzrlib.lazy_import import lazy_import
 
65
from .lazy_import import lazy_import
64
66
lazy_import(globals(), """
65
 
from cStringIO import StringIO
66
 
import errno
67
 
import locale
 
67
import tempfile
68
68
import traceback
69
69
""")
70
70
 
71
 
import bzrlib
72
 
 
73
 
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
75
 
    deprecated_in,
76
 
    )
 
71
import breezy
77
72
 
78
73
lazy_import(globals(), """
79
 
from bzrlib import (
 
74
from breezy import (
 
75
    bedding,
80
76
    debug,
81
77
    errors,
82
78
    osutils,
83
 
    plugin,
84
 
    symbol_versioning,
85
79
    ui,
86
80
    )
87
81
""")
88
82
 
89
 
 
90
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
 
83
from .sixish import (
 
84
    PY3,
 
85
    StringIO,
 
86
    text_type,
 
87
    )
 
88
 
 
89
 
 
90
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
91
91
# is quiet; >0 is verbose.
92
92
_verbosity_level = 0
93
93
 
97
97
# than push/pop_log_file.
98
98
_trace_file = None
99
99
 
100
 
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
 
100
# Absolute path for brz.log.  Not changed even if the log/trace output is
101
101
# redirected elsewhere.  Used to show the location in --version.
102
 
_bzr_log_filename = None
 
102
_brz_log_filename = None
103
103
 
104
104
# The time the first message was written to the trace file, so that we can
105
105
# show relative times since startup.
106
 
_bzr_log_start_time = bzrlib._start_time
 
106
_brz_log_start_time = breezy._start_time
107
107
 
108
108
 
109
109
# held in a global for quick reference
110
 
_bzr_logger = logging.getLogger('bzr')
 
110
_brz_logger = logging.getLogger('brz')
111
111
 
112
112
 
113
113
def note(*args, **kwargs):
114
114
    """Output a note to the user.
115
115
 
116
116
    Takes the same parameters as logging.info.
 
117
 
117
118
    :return: None
118
119
    """
119
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
120
 
    #
121
120
    # FIXME: clearing the ui and then going through the abstract logging
122
121
    # framework is whack; we should probably have a logging Handler that
123
122
    # deals with terminal output if needed.
124
 
    import bzrlib.ui
125
 
    bzrlib.ui.ui_factory.clear_term()
126
 
    _bzr_logger.info(*args, **kwargs)
 
123
    ui.ui_factory.clear_term()
 
124
    _brz_logger.info(*args, **kwargs)
127
125
 
128
126
 
129
127
def warning(*args, **kwargs):
130
 
    import bzrlib.ui
131
 
    bzrlib.ui.ui_factory.clear_term()
132
 
    _bzr_logger.warning(*args, **kwargs)
133
 
 
134
 
 
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)
 
128
    ui.ui_factory.clear_term()
 
129
    _brz_logger.warning(*args, **kwargs)
151
130
 
152
131
 
153
132
def show_error(*args, **kwargs):
155
134
 
156
135
    Don't use this for exceptions, use report_exception instead.
157
136
    """
158
 
    _bzr_logger.error(*args, **kwargs)
 
137
    _brz_logger.error(*args, **kwargs)
 
138
 
 
139
 
 
140
class _Bytes(str):
 
141
    """Compat class for displaying bytes on Python 2."""
 
142
 
 
143
    def __repr__(self):
 
144
        return 'b' + str.__repr__(self)
 
145
 
 
146
    def __unicode__(self):
 
147
        return self.decode('ascii', 'replace')
159
148
 
160
149
 
161
150
def mutter(fmt, *args):
166
155
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
167
156
        return
168
157
 
169
 
    if isinstance(fmt, unicode):
170
 
        fmt = fmt.encode('utf8')
 
158
    # Let format strings be specified as ascii bytes to help Python 2
 
159
    if isinstance(fmt, bytes):
 
160
        fmt = fmt.decode('ascii', 'replace')
171
161
 
172
 
    if len(args) > 0:
173
 
        # It seems that if we do ascii % (unicode, ascii) we can
174
 
        # get a unicode cannot encode ascii error, so make sure that "fmt"
175
 
        # is a unicode string
176
 
        real_args = []
177
 
        for arg in args:
178
 
            if isinstance(arg, unicode):
179
 
                arg = arg.encode('utf8')
180
 
            real_args.append(arg)
181
 
        out = fmt % tuple(real_args)
 
162
    if args:
 
163
        if not PY3:
 
164
            args = tuple(
 
165
                _Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
 
166
        out = fmt % args
182
167
    else:
183
168
        out = fmt
184
169
    now = time.time()
185
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
186
 
    out = timestamp + out + '\n'
187
 
    _trace_file.write(out)
 
170
    out = '%0.3f  %s\n' % (now - _brz_log_start_time, out)
 
171
    _trace_file.write(out.encode('utf-8'))
188
172
    # there's no explicit flushing; the file is typically line buffered.
189
173
 
190
174
 
219
203
        return
220
204
 
221
205
 
222
 
def _get_bzr_log_filename():
223
 
    bzr_log = os.environ.get('BZR_LOG')
224
 
    if bzr_log:
225
 
        return bzr_log
226
 
    home = os.environ.get('BZR_HOME')
227
 
    if home is None:
228
 
        if sys.platform == 'win32':
229
 
            from bzrlib import win32utils
230
 
            home = win32utils.get_home_location()
231
 
        else:
232
 
            home = os.path.expanduser('~')
233
 
    return os.path.join(home, '.bzr.log')
234
 
 
235
 
 
236
 
def _open_bzr_log():
237
 
    """Open the .bzr.log trace file.
 
206
def _get_brz_log_filename():
 
207
    brz_log = osutils.path_from_environ('BRZ_LOG')
 
208
    if brz_log:
 
209
        return brz_log
 
210
    return os.path.join(bedding.cache_dir(), 'brz.log')
 
211
 
 
212
 
 
213
def _open_brz_log():
 
214
    """Open the brz.log trace file.
238
215
 
239
216
    If the log is more than a particular length, the old file is renamed to
240
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
 
217
    brz.log.old and a new file is started.  Otherwise, we append to the
241
218
    existing file.
242
219
 
243
 
    This sets the global _bzr_log_filename.
 
220
    This sets the global _brz_log_filename.
244
221
    """
245
 
    global _bzr_log_filename
 
222
    global _brz_log_filename
246
223
 
247
224
    def _open_or_create_log_file(filename):
248
225
        """Open existing log file, or create with ownership and permissions
256
233
            try:
257
234
                fd = os.open(filename, flags)
258
235
                break
259
 
            except OSError, e:
 
236
            except OSError as e:
260
237
                if e.errno != errno.ENOENT:
261
238
                    raise
262
239
            try:
263
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
264
 
            except OSError, e:
 
240
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
 
241
            except OSError as e:
265
242
                if e.errno != errno.EEXIST:
266
243
                    raise
267
244
            else:
268
245
                osutils.copy_ownership_from_path(filename)
269
246
                break
270
 
        return os.fdopen(fd, 'at', 0) # unbuffered
271
 
 
272
 
 
273
 
    _bzr_log_filename = _get_bzr_log_filename()
274
 
    _rollover_trace_maybe(_bzr_log_filename)
 
247
        return os.fdopen(fd, 'ab', 0)  # unbuffered
 
248
 
 
249
    _brz_log_filename = _get_brz_log_filename()
 
250
    _rollover_trace_maybe(_brz_log_filename)
275
251
    try:
276
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
277
 
        bzr_log_file.write('\n')
278
 
        if bzr_log_file.tell() <= 2:
279
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
282
 
 
283
 
        return bzr_log_file
284
 
 
285
 
    except EnvironmentError, e:
 
252
        brz_log_file = _open_or_create_log_file(_brz_log_filename)
 
253
        brz_log_file.write(b'\n')
 
254
        if brz_log_file.tell() <= 2:
 
255
            brz_log_file.write(
 
256
                b"this is a debug log for diagnosing/reporting problems in brz\n")
 
257
            brz_log_file.write(
 
258
                b"you can delete or truncate this file, or include sections in\n")
 
259
            brz_log_file.write(
 
260
                b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
 
261
 
 
262
        return brz_log_file
 
263
 
 
264
    except EnvironmentError as e:
286
265
        # If we are failing to open the log, then most likely logging has not
287
266
        # been set up yet. So we just write to stderr rather than using
288
267
        # 'warning()'. If we using warning(), users get the unhelpful 'no
289
 
        # handlers registered for "bzr"' when something goes wrong on the
 
268
        # handlers registered for "brz"' when something goes wrong on the
290
269
        # server. (bug #503886)
291
270
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
292
271
    # TODO: What should happen if we fail to open the trace file?  Maybe the
296
275
 
297
276
 
298
277
def enable_default_logging():
299
 
    """Configure default logging: messages to stderr and debug to .bzr.log
 
278
    """Configure default logging: messages to stderr and debug to brz.log
300
279
 
301
280
    This should only be called once per process.
302
281
 
303
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
 
282
    Non-command-line programs embedding breezy do not need to call this.  They
304
283
    can instead either pass a file to _push_log_file, or act directly on
305
 
    logging.getLogger("bzr").
 
284
    logging.getLogger("brz").
306
285
 
307
286
    Output can be redirected away by calling _push_log_file.
 
287
 
 
288
    :return: A memento from push_log_file for restoring the log state.
308
289
    """
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,
 
290
    start_time = osutils.format_local_date(_brz_log_start_time,
313
291
                                           timezone='local')
314
 
    # create encoded wrapper around stderr
315
 
    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
 
    push_log_file(bzr_log_file,
 
292
    brz_log_file = _open_brz_log()
 
293
    if brz_log_file is not None:
 
294
        brz_log_file.write(start_time.encode('utf-8') + b'\n')
 
295
    memento = push_log_file(
 
296
        brz_log_file,
319
297
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
298
        r'%Y-%m-%d %H:%M:%S')
321
 
    # after hooking output into bzr_log, we also need to attach a stderr
 
299
    # after hooking output into brz_log, we also need to attach a stderr
322
300
    # handler, writing only at level info and with encoding
323
 
    writer_factory = codecs.getwriter(term_encoding)
324
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
326
 
    stderr_handler.setLevel(logging.INFO)
327
 
    logging.getLogger('bzr').addHandler(stderr_handler)
 
301
    if sys.version_info[0] == 2:
 
302
        stderr_handler = EncodedStreamHandler(
 
303
            sys.stderr, osutils.get_terminal_encoding(), 'replace',
 
304
            level=logging.INFO)
 
305
    else:
 
306
        stderr_handler = logging.StreamHandler(stream=sys.stderr)
 
307
    logging.getLogger('brz').addHandler(stderr_handler)
 
308
    return memento
328
309
 
329
310
 
330
311
def push_log_file(to_file, log_format=None, date_format=None):
333
314
    :param to_file: A file-like object to which messages will be sent.
334
315
 
335
316
    :returns: A memento that should be passed to _pop_log_file to restore the
336
 
    previously active logging.
 
317
        previously active logging.
337
318
    """
338
319
    global _trace_file
339
320
    # make a new handler
340
 
    new_handler = logging.StreamHandler(to_file)
341
 
    new_handler.setLevel(logging.DEBUG)
 
321
    new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
342
322
    if log_format is None:
343
323
        log_format = '%(levelname)8s  %(message)s'
344
324
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
345
325
    # save and remove any existing log handlers
346
 
    bzr_logger = logging.getLogger('bzr')
347
 
    old_handlers = bzr_logger.handlers[:]
348
 
    del bzr_logger.handlers[:]
 
326
    brz_logger = logging.getLogger('brz')
 
327
    old_handlers = brz_logger.handlers[:]
 
328
    del brz_logger.handlers[:]
349
329
    # set that as the default logger
350
 
    bzr_logger.addHandler(new_handler)
351
 
    bzr_logger.setLevel(logging.DEBUG)
 
330
    brz_logger.addHandler(new_handler)
 
331
    brz_logger.setLevel(logging.DEBUG)
352
332
    # TODO: check if any changes are needed to the root logger
353
333
    #
354
 
    # TODO: also probably need to save and restore the level on bzr_logger.
 
334
    # TODO: also probably need to save and restore the level on brz_logger.
355
335
    # but maybe we can avoid setting the logger level altogether, and just set
356
336
    # the level on the handler?
357
337
    #
359
339
    old_trace_file = _trace_file
360
340
    # send traces to the new one
361
341
    _trace_file = to_file
362
 
    result = new_handler, _trace_file
363
342
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
364
343
 
365
344
 
366
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
 
345
def pop_log_file(entry):
367
346
    """Undo changes to logging/tracing done by _push_log_file.
368
347
 
369
 
    This flushes, but does not close the trace file.
 
348
    This flushes, but does not close the trace file (so that anything that was
 
349
    in it is output.
370
350
 
371
351
    Takes the memento returned from _push_log_file."""
 
352
    (magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
372
353
    global _trace_file
373
354
    _trace_file = old_trace_file
374
 
    bzr_logger = logging.getLogger('bzr')
375
 
    bzr_logger.removeHandler(new_handler)
376
 
    # must be closed, otherwise logging will try to close it atexit, and the
 
355
    brz_logger = logging.getLogger('brz')
 
356
    brz_logger.removeHandler(new_handler)
 
357
    # must be closed, otherwise logging will try to close it at exit, and the
377
358
    # file will likely already be closed underneath.
378
359
    new_handler.close()
379
 
    bzr_logger.handlers = old_handlers
380
 
    new_trace_file.flush()
 
360
    brz_logger.handlers = old_handlers
 
361
    if new_trace_file is not None:
 
362
        new_trace_file.flush()
381
363
 
382
364
 
383
365
def log_exception_quietly():
419
401
def _update_logging_level(quiet=True):
420
402
    """Hide INFO messages if quiet."""
421
403
    if quiet:
422
 
        _bzr_logger.setLevel(logging.WARNING)
 
404
        _brz_logger.setLevel(logging.WARNING)
423
405
    else:
424
 
        _bzr_logger.setLevel(logging.INFO)
 
406
        _brz_logger.setLevel(logging.INFO)
425
407
 
426
408
 
427
409
def is_quiet():
437
419
def debug_memory(message='', short=True):
438
420
    """Write out a memory dump."""
439
421
    if sys.platform == 'win32':
440
 
        from bzrlib import win32utils
 
422
        from breezy import win32utils
441
423
        win32utils.debug_memory_win32api(message=message, short=short)
442
424
    else:
443
425
        _debug_memory_proc(message=message, short=short)
445
427
 
446
428
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
447
429
 
 
430
 
448
431
def _debug_memory_proc(message='', short=True):
449
432
    try:
450
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
 
433
        status_file = open('/proc/%s/status' % os.getpid(), 'rb')
451
434
    except IOError:
452
435
        return
453
436
    try:
466
449
                    break
467
450
 
468
451
 
 
452
def _dump_memory_usage(err_file):
 
453
    try:
 
454
        try:
 
455
            fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
 
456
            dump_file = os.fdopen(fd, 'w')
 
457
            from meliae import scanner
 
458
            scanner.dump_gc_objects(dump_file)
 
459
            err_file.write("Memory dumped to %s\n" % name)
 
460
        except ImportError:
 
461
            err_file.write("Dumping memory requires meliae module.\n")
 
462
            log_exception_quietly()
 
463
        except BaseException:
 
464
            err_file.write("Exception while dumping memory.\n")
 
465
            log_exception_quietly()
 
466
    finally:
 
467
        if dump_file is not None:
 
468
            dump_file.close()
 
469
        elif fd is not None:
 
470
            os.close(fd)
 
471
 
 
472
 
 
473
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
 
474
    """Give name of error class including module for non-builtin exceptions
 
475
 
 
476
    If `unqualified_breezy_errors` is True, errors specific to breezy will
 
477
    also omit the module prefix.
 
478
    """
 
479
    class_name = eclass.__name__
 
480
    module_name = eclass.__module__
 
481
    if module_name in ("builtins", "exceptions", "__main__") or (
 
482
            unqualified_breezy_errors and module_name == "breezy.errors"):
 
483
        return class_name
 
484
    return "%s.%s" % (module_name, class_name)
 
485
 
 
486
 
469
487
def report_exception(exc_info, err_file):
470
 
    """Report an exception to err_file (typically stderr) and to .bzr.log.
 
488
    """Report an exception to err_file (typically stderr) and to brz.log.
471
489
 
472
490
    This will show either a full traceback or a short message as appropriate.
473
491
 
474
492
    :return: The appropriate exit code for this error.
475
493
    """
476
 
    # Log the full traceback to ~/.bzr.log
 
494
    # Log the full traceback to brz.log
477
495
    log_exception_quietly()
478
496
    if 'error' in debug.debug_flags:
479
497
        print_exception(exc_info, err_file)
480
498
        return errors.EXIT_ERROR
481
499
    exc_type, exc_object, exc_tb = exc_info
482
 
    if (isinstance(exc_object, IOError)
483
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
 
        err_file.write("bzr: broken pipe\n")
485
 
        return errors.EXIT_ERROR
486
 
    elif isinstance(exc_object, KeyboardInterrupt):
487
 
        err_file.write("bzr: interrupted\n")
 
500
    if isinstance(exc_object, KeyboardInterrupt):
 
501
        err_file.write("brz: interrupted\n")
488
502
        return errors.EXIT_ERROR
489
503
    elif isinstance(exc_object, MemoryError):
490
 
        err_file.write("bzr: out of memory\n")
 
504
        err_file.write("brz: out of memory\n")
 
505
        if 'mem_dump' in debug.debug_flags:
 
506
            _dump_memory_usage(err_file)
 
507
        else:
 
508
            err_file.write("Use -Dmem_dump to dump memory to a file.\n")
491
509
        return errors.EXIT_ERROR
492
510
    elif isinstance(exc_object, ImportError) \
493
 
        and str(exc_object).startswith("No module named "):
494
 
        report_user_error(exc_info, err_file,
 
511
            and str(exc_object).startswith("No module named "):
 
512
        report_user_error(
 
513
            exc_info, err_file,
495
514
            'You may need to install this Python library separately.')
496
515
        return errors.EXIT_ERROR
497
516
    elif not getattr(exc_object, 'internal_error', True):
498
517
        report_user_error(exc_info, err_file)
499
518
        return errors.EXIT_ERROR
500
 
    elif isinstance(exc_object, (OSError, IOError)):
 
519
    elif osutils.is_environment_error(exc_object):
 
520
        if getattr(exc_object, 'errno', None) == errno.EPIPE:
 
521
            err_file.write("brz: broken pipe\n")
 
522
            return errors.EXIT_ERROR
501
523
        # Might be nice to catch all of these and show them as something more
502
524
        # specific, but there are too many cases at the moment.
503
525
        report_user_error(exc_info, err_file)
509
531
 
510
532
def print_exception(exc_info, err_file):
511
533
    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))
 
534
    err_file.write("brz: ERROR: %s: %s\n" % (
 
535
        _qualified_exception_name(exc_type), exc_object))
514
536
    err_file.write('\n')
515
537
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
516
538
 
525
547
    :param advice: Extra advice to the user to be printed following the
526
548
        exception.
527
549
    """
528
 
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
550
    err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
529
551
    if advice:
530
 
        err_file.write("%s\n" % (advice,))
 
552
        err_file.write(("%s\n" % advice))
531
553
 
532
554
 
533
555
def report_bug(exc_info, err_file):
534
 
    """Report an exception that probably indicates a bug in bzr"""
535
 
    from bzrlib.crash import report_bug
 
556
    """Report an exception that probably indicates a bug in brz"""
 
557
    from breezy.crash import report_bug
536
558
    report_bug(exc_info, err_file)
537
559
 
538
560
 
539
561
def _flush_stdout_stderr():
540
 
    # installed into an atexit hook by bzrlib.initialize()
 
562
    # called from the breezy library finalizer returned by breezy.initialize()
541
563
    try:
542
564
        sys.stdout.flush()
543
565
        sys.stderr.flush()
544
 
    except IOError, e:
 
566
    except ValueError:
 
567
        # On Windows, I get ValueError calling stdout.flush() on a closed
 
568
        # handle
 
569
        pass
 
570
    except IOError as e:
545
571
        import errno
546
572
        if e.errno in [errno.EINVAL, errno.EPIPE]:
547
573
            pass
550
576
 
551
577
 
552
578
def _flush_trace():
553
 
    # run from atexit hook
 
579
    # called from the breezy library finalizer returned by breezy.initialize()
554
580
    global _trace_file
555
581
    if _trace_file:
556
582
        _trace_file.flush()
 
583
 
 
584
 
 
585
class EncodedStreamHandler(logging.Handler):
 
586
    """Robustly write logging events to a stream using the specified encoding
 
587
 
 
588
    Messages are expected to be formatted to unicode, but UTF-8 byte strings
 
589
    are also accepted. An error during formatting or a str message in another
 
590
    encoding will be quitely noted as an error in the Bazaar log file.
 
591
 
 
592
    The stream is not closed so sys.stdout or sys.stderr may be passed.
 
593
    """
 
594
 
 
595
    def __init__(self, stream, encoding=None, errors='strict', level=0):
 
596
        logging.Handler.__init__(self, level)
 
597
        self.stream = stream
 
598
        if encoding is None:
 
599
            encoding = getattr(stream, "encoding", "ascii")
 
600
        self.encoding = encoding
 
601
        self.errors = errors
 
602
 
 
603
    def flush(self):
 
604
        flush = getattr(self.stream, "flush", None)
 
605
        if flush is not None:
 
606
            flush()
 
607
 
 
608
    def emit(self, record):
 
609
        try:
 
610
            if not isinstance(record.msg, text_type):
 
611
                msg = record.msg.decode("utf-8")
 
612
                if PY3:
 
613
                    record.msg = msg
 
614
            line = self.format(record)
 
615
            if not isinstance(line, text_type):
 
616
                line = line.decode("utf-8")
 
617
            self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
 
618
        except Exception:
 
619
            log_exception_quietly()
 
620
            # Try saving the details that would have been logged in some form
 
621
            msg = args = "<Unformattable>"
 
622
            try:
 
623
                msg = repr(record.msg)
 
624
                args = repr(record.args)
 
625
            except Exception:
 
626
                pass
 
627
            # Using mutter() bypasses the logging module and writes directly
 
628
            # to the file so there's no danger of getting into a loop here.
 
629
            mutter("Logging record unformattable: %s %% %s", msg, args)
 
630
 
 
631
 
 
632
class Config(object):
 
633
    """Configuration of message tracing in breezy.
 
634
 
 
635
    This implements the context manager protocol and should manage any global
 
636
    variables still used. The default config used is DefaultConfig, but
 
637
    embedded uses of breezy may wish to use a custom manager.
 
638
    """
 
639
 
 
640
    def __enter__(self):
 
641
        return self  # This is bound to the 'as' clause in a with statement.
 
642
 
 
643
    def __exit__(self, exc_type, exc_val, exc_tb):
 
644
        return False  # propogate exceptions.
 
645
 
 
646
 
 
647
class DefaultConfig(Config):
 
648
    """A default configuration for tracing of messages in breezy.
 
649
 
 
650
    This implements the context manager protocol.
 
651
    """
 
652
 
 
653
    def __enter__(self):
 
654
        self._original_filename = _brz_log_filename
 
655
        self._original_state = enable_default_logging()
 
656
        return self  # This is bound to the 'as' clause in a with statement.
 
657
 
 
658
    def __exit__(self, exc_type, exc_val, exc_tb):
 
659
        pop_log_file(self._original_state)
 
660
        global _brz_log_filename
 
661
        _brz_log_filename = self._original_filename
 
662
        return False  # propogate exceptions.