← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Add bzrlib.pyutils, which has get_named_object, a wrapper around __import__.

This is used to replace various ad hoc implementations of the same logic,
notably the version used in registry's _LazyObjectGetter which had a bug when
getting a module without also getting a member.  And of course, this new
function has unit tests, unlike the replaced code.

This also adds a KnownHooksRegistry subclass to provide a more natural home for
some other logic.

I'm not thrilled about the name of the new module or the new functions, but it's
hard to think of good names for such generic functionality.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
111
111
 
112
112
 
113
113
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
    """
114
120
    # FIXME note always emits utf-8, regardless of the terminal encoding
115
121
    #
116
122
    # FIXME: clearing the ui and then going through the abstract logging
300
306
    logging.getLogger("bzr").
301
307
 
302
308
    Output can be redirected away by calling _push_log_file.
 
309
 
 
310
    :return: A memento from push_log_file for restoring the log state.
303
311
    """
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
312
    start_time = osutils.format_local_date(_bzr_log_start_time,
308
313
                                           timezone='local')
309
314
    # create encoded wrapper around stderr
310
315
    bzr_log_file = _open_bzr_log()
311
316
    if bzr_log_file is not None:
312
317
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
 
    push_log_file(bzr_log_file,
 
318
    memento = push_log_file(bzr_log_file,
314
319
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
320
        r'%Y-%m-%d %H:%M:%S')
316
321
    # after hooking output into bzr_log, we also need to attach a stderr
317
322
    # handler, writing only at level info and with encoding
 
323
    term_encoding = osutils.get_terminal_encoding()
318
324
    writer_factory = codecs.getwriter(term_encoding)
319
325
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
326
    stderr_handler = logging.StreamHandler(encoded_stderr)
321
327
    stderr_handler.setLevel(logging.INFO)
322
328
    logging.getLogger('bzr').addHandler(stderr_handler)
 
329
    return memento
323
330
 
324
331
 
325
332
def push_log_file(to_file, log_format=None, date_format=None):
361
368
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
369
    """Undo changes to logging/tracing done by _push_log_file.
363
370
 
364
 
    This flushes, but does not close the trace file.
 
371
    This flushes, but does not close the trace file (so that anything that was
 
372
    in it is output.
365
373
 
366
374
    Takes the memento returned from _push_log_file."""
367
375
    global _trace_file
368
376
    _trace_file = old_trace_file
369
377
    bzr_logger = logging.getLogger('bzr')
370
378
    bzr_logger.removeHandler(new_handler)
371
 
    # must be closed, otherwise logging will try to close it atexit, and the
 
379
    # must be closed, otherwise logging will try to close it at exit, and the
372
380
    # file will likely already be closed underneath.
373
381
    new_handler.close()
374
382
    bzr_logger.handlers = old_handlers
375
 
    new_trace_file.flush()
 
383
    if new_trace_file is not None:
 
384
        new_trace_file.flush()
376
385
 
377
386
 
378
387
def log_exception_quietly():
492
501
    elif not getattr(exc_object, 'internal_error', True):
493
502
        report_user_error(exc_info, err_file)
494
503
        return errors.EXIT_ERROR
495
 
    elif isinstance(exc_object, (OSError, IOError)):
 
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"):
496
507
        # Might be nice to catch all of these and show them as something more
497
508
        # specific, but there are too many cases at the moment.
498
509
        report_user_error(exc_info, err_file)
532
543
 
533
544
 
534
545
def _flush_stdout_stderr():
535
 
    # installed into an atexit hook by bzrlib.initialize()
 
546
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
536
547
    try:
537
548
        sys.stdout.flush()
538
549
        sys.stderr.flush()
545
556
 
546
557
 
547
558
def _flush_trace():
548
 
    # run from atexit hook
 
559
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
549
560
    global _trace_file
550
561
    if _trace_file:
551
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.