/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-08-23 01:15:41 UTC
  • mfrom: (7520.1.4 merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200823011541-nv0oh7nzaganx2qy
Merge lp:brz/3.1.

Merged from https://code.launchpad.net/~jelmer/brz/merge-3.1/+merge/389690

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