← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Zearin
  • Date: 2010-11-12 22:08:18 UTC
  • mto: (5570.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5572.
  • Revision ID: zearin@users.sourceforge.net-20101112220818-mb62len4zyxr8qvd
Fixed capitalization of XML and HTTP.  Fixed by hand and only where appropriate (e.g., left http://some/url lowercase, but capitalized "When making an HTTP request…").

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
59
59
import os
60
60
import sys
61
61
import time
 
62
import tempfile
62
63
 
63
64
from bzrlib.lazy_import import lazy_import
64
65
lazy_import(globals(), """
111
112
 
112
113
 
113
114
def note(*args, **kwargs):
 
115
    """Output a note to the user.
 
116
 
 
117
    Takes the same parameters as logging.info.
 
118
 
 
119
    :return: None
 
120
    """
114
121
    # FIXME note always emits utf-8, regardless of the terminal encoding
115
122
    #
116
123
    # FIXME: clearing the ui and then going through the abstract logging
300
307
    logging.getLogger("bzr").
301
308
 
302
309
    Output can be redirected away by calling _push_log_file.
 
310
 
 
311
    :return: A memento from push_log_file for restoring the log state.
303
312
    """
304
 
    # Do this before we open the log file, so we prevent
305
 
    # get_terminal_encoding() from mutter()ing multiple times
306
 
    term_encoding = osutils.get_terminal_encoding()
307
313
    start_time = osutils.format_local_date(_bzr_log_start_time,
308
314
                                           timezone='local')
309
315
    # create encoded wrapper around stderr
310
316
    bzr_log_file = _open_bzr_log()
311
317
    if bzr_log_file is not None:
312
318
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
 
    push_log_file(bzr_log_file,
 
319
    memento = push_log_file(bzr_log_file,
314
320
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
321
        r'%Y-%m-%d %H:%M:%S')
316
322
    # after hooking output into bzr_log, we also need to attach a stderr
317
323
    # handler, writing only at level info and with encoding
 
324
    term_encoding = osutils.get_terminal_encoding()
318
325
    writer_factory = codecs.getwriter(term_encoding)
319
326
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
327
    stderr_handler = logging.StreamHandler(encoded_stderr)
321
328
    stderr_handler.setLevel(logging.INFO)
322
329
    logging.getLogger('bzr').addHandler(stderr_handler)
 
330
    return memento
323
331
 
324
332
 
325
333
def push_log_file(to_file, log_format=None, date_format=None):
361
369
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
370
    """Undo changes to logging/tracing done by _push_log_file.
363
371
 
364
 
    This flushes, but does not close the trace file.
 
372
    This flushes, but does not close the trace file (so that anything that was
 
373
    in it is output.
365
374
 
366
375
    Takes the memento returned from _push_log_file."""
367
376
    global _trace_file
368
377
    _trace_file = old_trace_file
369
378
    bzr_logger = logging.getLogger('bzr')
370
379
    bzr_logger.removeHandler(new_handler)
371
 
    # must be closed, otherwise logging will try to close it atexit, and the
 
380
    # must be closed, otherwise logging will try to close it at exit, and the
372
381
    # file will likely already be closed underneath.
373
382
    new_handler.close()
374
383
    bzr_logger.handlers = old_handlers
375
 
    new_trace_file.flush()
 
384
    if new_trace_file is not None:
 
385
        new_trace_file.flush()
376
386
 
377
387
 
378
388
def log_exception_quietly():
460
470
                    note(line)
461
471
                    break
462
472
 
 
473
def _dump_memory_usage(err_file):
 
474
    try:
 
475
        try:
 
476
            fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
 
477
            dump_file = os.fdopen(fd, 'w')
 
478
            from meliae import scanner
 
479
            scanner.dump_gc_objects(dump_file)
 
480
            err_file.write("Memory dumped to %s\n" % name)
 
481
        except ImportError:
 
482
            err_file.write("Dumping memory requires meliae module.\n")
 
483
            log_exception_quietly()
 
484
        except:
 
485
            err_file.write("Exception while dumping memory.\n")
 
486
            log_exception_quietly()
 
487
    finally:
 
488
        if dump_file is not None:
 
489
            dump_file.close()
 
490
        elif fd is not None:
 
491
            os.close(fd)
463
492
 
464
493
def report_exception(exc_info, err_file):
465
494
    """Report an exception to err_file (typically stderr) and to .bzr.log.
483
512
        return errors.EXIT_ERROR
484
513
    elif isinstance(exc_object, MemoryError):
485
514
        err_file.write("bzr: out of memory\n")
 
515
        if 'mem_dump' in debug.debug_flags:
 
516
            _dump_memory_usage(err_file)
 
517
        else:
 
518
            err_file.write("Use -Dmem_dump to dump memory to a file.\n")
486
519
        return errors.EXIT_ERROR
487
520
    elif isinstance(exc_object, ImportError) \
488
521
        and str(exc_object).startswith("No module named "):
492
525
    elif not getattr(exc_object, 'internal_error', True):
493
526
        report_user_error(exc_info, err_file)
494
527
        return errors.EXIT_ERROR
495
 
    elif isinstance(exc_object, (OSError, IOError)):
 
528
    elif isinstance(exc_object, (OSError, IOError)) or (
 
529
        # GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
 
530
        exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
496
531
        # Might be nice to catch all of these and show them as something more
497
532
        # specific, but there are too many cases at the moment.
498
533
        report_user_error(exc_info, err_file)
532
567
 
533
568
 
534
569
def _flush_stdout_stderr():
535
 
    # installed into an atexit hook by bzrlib.initialize()
 
570
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
536
571
    try:
537
572
        sys.stdout.flush()
538
573
        sys.stderr.flush()
545
580
 
546
581
 
547
582
def _flush_trace():
548
 
    # run from atexit hook
 
583
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
549
584
    global _trace_file
550
585
    if _trace_file:
551
586
        _trace_file.flush()
 
587
 
 
588
 
 
589
class Config(object):
 
590
    """Configuration of message tracing in bzrlib.
 
591
 
 
592
    This implements the context manager protocol and should manage any global
 
593
    variables still used. The default config used is DefaultConfig, but
 
594
    embedded uses of bzrlib may wish to use a custom manager.
 
595
    """
 
596
 
 
597
    def __enter__(self):
 
598
        return self # This is bound to the 'as' clause in a with statement.
 
599
 
 
600
    def __exit__(self, exc_type, exc_val, exc_tb):
 
601
        return False # propogate exceptions.
 
602
 
 
603
 
 
604
class DefaultConfig(Config):
 
605
    """A default configuration for tracing of messages in bzrlib.
 
606
 
 
607
    This implements the context manager protocol.
 
608
    """
 
609
 
 
610
    def __enter__(self):
 
611
        self._original_filename = _bzr_log_filename
 
612
        self._original_state = enable_default_logging()
 
613
        return self # This is bound to the 'as' clause in a with statement.
 
614
 
 
615
    def __exit__(self, exc_type, exc_val, exc_tb):
 
616
        pop_log_file(self._original_state)
 
617
        global _bzr_log_filename
 
618
        _bzr_log_filename = self._original_filename
 
619
        return False # propogate exceptions.