← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Fix #531967 by creating helpers for PathConflicts when a deletion
is involved.

* bzrlib/tests/test_conflicts.py:
(TestParametrizedResolveConflicts.mirror_scenarios): Renamed from
multiply_scenarios to make the intent clearer. Turned into a
classmethod too for the same reason.
(TestParametrizedResolveConflicts.scenarios): Now a classmethod.

* bzrlib/merge.py:
(Merge3Merger._merge_names): 'name conflict' and 'parent conflict'
can (and must) be handled in the same way. If a deletion is
involved we create an unversioned copy of the rejected item so the
user can restore that easily.
(Merge3Merger.cook_conflicts): Get rid of 'name conflict', 'parent
conflict' distinction and just create PathConflicts with a file_id
to address bug #531967.

* bzrlib/conflicts.py:
(PathConflict.associated_filenames): Helpers exist only when a
deletion is involved.
(PathConflict._resolve): We may have to version one path
again. This may happen when a deletion have occurred.
(PathConflict.action_take_this, PathConflict.action_take_other):
As a special case, we may have an helper to use when deletion was
involved.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Messages and logging for bazaar-ng.
 
17
"""Messages and logging.
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 quiet mode, only warnings and
37
 
above are shown.  In debug mode, stderr gets debug messages too.
 
36
list of files processed by add and commit.  In debug mode, stderr gets debug messages too.
38
37
 
39
38
Errors that terminate an operation are generally passed back as exceptions;
40
39
others may be just emitted as messages.
59
58
import logging
60
59
import os
61
60
import sys
62
 
import re
63
61
import time
64
62
 
65
63
from bzrlib.lazy_import import lazy_import
72
70
 
73
71
import bzrlib
74
72
 
 
73
from bzrlib.symbol_versioning import (
 
74
    deprecated_function,
 
75
    deprecated_in,
 
76
    )
 
77
 
75
78
lazy_import(globals(), """
76
79
from bzrlib import (
77
80
    debug,
79
82
    osutils,
80
83
    plugin,
81
84
    symbol_versioning,
 
85
    ui,
82
86
    )
83
87
""")
84
88
 
123
127
    _bzr_logger.warning(*args, **kwargs)
124
128
 
125
129
 
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
132
 
 
133
 
 
134
 
_last_mutter_flush_time = None
 
130
@deprecated_function(deprecated_in((2, 1, 0)))
 
131
def info(*args, **kwargs):
 
132
    """Deprecated: use trace.note instead."""
 
133
    note(*args, **kwargs)
 
134
 
 
135
 
 
136
@deprecated_function(deprecated_in((2, 1, 0)))
 
137
def log_error(*args, **kwargs):
 
138
    """Deprecated: use bzrlib.trace.show_error instead"""
 
139
    _bzr_logger.error(*args, **kwargs)
 
140
 
 
141
 
 
142
@deprecated_function(deprecated_in((2, 1, 0)))
 
143
def error(*args, **kwargs):
 
144
    """Deprecated: use bzrlib.trace.show_error instead"""
 
145
    _bzr_logger.error(*args, **kwargs)
 
146
 
 
147
 
 
148
def show_error(msg):
 
149
    """Show an error message to the user.
 
150
 
 
151
    Don't use this for exceptions, use report_exception instead.
 
152
    """
 
153
    _bzr_logger.error(*args, **kwargs)
 
154
 
135
155
 
136
156
def mutter(fmt, *args):
137
 
    global _last_mutter_flush_time
138
157
    if _trace_file is None:
139
158
        return
 
159
    # XXX: Don't check this every time; instead anyone who closes the file
 
160
    # ought to deregister it.  We can tolerate None.
140
161
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
141
162
        return
142
163
 
159
180
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
160
181
    out = timestamp + out + '\n'
161
182
    _trace_file.write(out)
162
 
    # We flush if we haven't flushed for a few seconds. We don't want to flush
163
 
    # on every mutter, but when a command takes a while, it can be nice to see
164
 
    # updates in the debug log.
165
 
    if (_last_mutter_flush_time is None
166
 
        or (now - _last_mutter_flush_time) > 2.0):
167
 
        flush = getattr(_trace_file, 'flush', None)
168
 
        if flush is not None:
169
 
            flush()
170
 
        _last_mutter_flush_time = now
 
183
    # there's no explicit flushing; the file is typically line buffered.
171
184
 
172
185
 
173
186
def mutter_callsite(stacklevel, fmt, *args):
216
229
 
217
230
 
218
231
def _open_bzr_log():
219
 
    """Open the .bzr.log trace file.  
 
232
    """Open the .bzr.log trace file.
220
233
 
221
234
    If the log is more than a particular length, the old file is renamed to
222
235
    .bzr.log.old and a new file is started.  Otherwise, we append to the
228
241
    _bzr_log_filename = _get_bzr_log_filename()
229
242
    _rollover_trace_maybe(_bzr_log_filename)
230
243
    try:
231
 
        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
 
244
        bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
232
245
        # bzr_log_file.tell() on windows always return 0 until some writing done
233
246
        bzr_log_file.write('\n')
234
247
        if bzr_log_file.tell() <= 2:
237
250
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
238
251
        return bzr_log_file
239
252
    except IOError, e:
240
 
        warning("failed to open trace file: %s" % (e))
 
253
        # If we are failing to open the log, then most likely logging has not
 
254
        # been set up yet. So we just write to stderr rather than using
 
255
        # 'warning()'. If we using warning(), users get the unhelpful 'no
 
256
        # handlers registered for "bzr"' when something goes wrong on the
 
257
        # server. (bug #503886)
 
258
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
241
259
    # TODO: What should happen if we fail to open the trace file?  Maybe the
242
260
    # objects should be pointed at /dev/null or the equivalent?  Currently
243
261
    # returns None which will cause failures later.
281
299
 
282
300
    :param to_file: A file-like object to which messages will be sent.
283
301
 
284
 
    :returns: A memento that should be passed to _pop_log_file to restore the 
 
302
    :returns: A memento that should be passed to _pop_log_file to restore the
285
303
    previously active logging.
286
304
    """
287
305
    global _trace_file
316
334
    """Undo changes to logging/tracing done by _push_log_file.
317
335
 
318
336
    This flushes, but does not close the trace file.
319
 
    
 
337
 
320
338
    Takes the memento returned from _push_log_file."""
321
339
    global _trace_file
322
340
    _trace_file = old_trace_file
329
347
    new_trace_file.flush()
330
348
 
331
349
 
332
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
333
 
def enable_test_log(to_file):
334
 
    """Redirect logging to a temporary file for a test
335
 
    
336
 
    :returns: an opaque reference that should be passed to disable_test_log
337
 
    after the test completes.
338
 
    """
339
 
    return push_log_file(to_file)
340
 
 
341
 
 
342
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
343
 
def disable_test_log(memento):
344
 
    return pop_log_file(memento)
345
 
 
346
 
 
347
350
def log_exception_quietly():
348
351
    """Log the last exception to the trace file only.
349
352
 
350
 
    Used for exceptions that occur internally and that may be 
351
 
    interesting to developers but not to users.  For example, 
 
353
    Used for exceptions that occur internally and that may be
 
354
    interesting to developers but not to users.  For example,
352
355
    errors loading plugins.
353
356
    """
354
357
    mutter(traceback.format_exc())
362
365
    global _verbosity_level
363
366
    _verbosity_level = level
364
367
    _update_logging_level(level < 0)
 
368
    ui.ui_factory.be_quiet(level < 0)
365
369
 
366
370
 
367
371
def get_verbosity_level():
373
377
 
374
378
 
375
379
def be_quiet(quiet=True):
376
 
    # Perhaps this could be deprecated now ...
377
380
    if quiet:
378
381
        set_verbosity_level(-1)
379
382
    else:
398
401
    return _verbosity_level > 0
399
402
 
400
403
 
401
 
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
402
 
def disable_default_logging():
403
 
    """Turn off default log handlers.
404
 
 
405
 
    Don't call this method, use _push_log_file and _pop_log_file instead.
406
 
    """
407
 
    pass
408
 
 
409
 
 
410
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
411
 
 
412
404
def debug_memory(message='', short=True):
413
405
    """Write out a memory dump."""
 
406
    if sys.platform == 'win32':
 
407
        from bzrlib import win32utils
 
408
        win32utils.debug_memory_win32api(message=message, short=short)
 
409
    else:
 
410
        _debug_memory_proc(message=message, short=short)
 
411
 
 
412
 
 
413
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
 
414
 
 
415
def _debug_memory_proc(message='', short=True):
414
416
    try:
415
417
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
416
418
    except IOError:
438
440
 
439
441
    :return: The appropriate exit code for this error.
440
442
    """
441
 
    exc_type, exc_object, exc_tb = exc_info
442
443
    # Log the full traceback to ~/.bzr.log
443
444
    log_exception_quietly()
 
445
    if 'error' in debug.debug_flags:
 
446
        print_exception(exc_info, err_file)
 
447
        return errors.EXIT_ERROR
 
448
    exc_type, exc_object, exc_tb = exc_info
444
449
    if (isinstance(exc_object, IOError)
445
450
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
446
451
        err_file.write("bzr: broken pipe\n")
448
453
    elif isinstance(exc_object, KeyboardInterrupt):
449
454
        err_file.write("bzr: interrupted\n")
450
455
        return errors.EXIT_ERROR
 
456
    elif isinstance(exc_object, MemoryError):
 
457
        err_file.write("bzr: out of memory\n")
 
458
        return errors.EXIT_ERROR
451
459
    elif isinstance(exc_object, ImportError) \
452
460
        and str(exc_object).startswith("No module named "):
453
461
        report_user_error(exc_info, err_file,
484
492
    :param advice: Extra advice to the user to be printed following the
485
493
        exception.
486
494
    """
487
 
    if 'error' in debug.debug_flags:
488
 
        print_exception(exc_info, err_file)
489
 
        return
490
495
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
491
496
    if advice:
492
497
        err_file.write("%s\n" % (advice,))
494
499
 
495
500
def report_bug(exc_info, err_file):
496
501
    """Report an exception that probably indicates a bug in bzr"""
497
 
    print_exception(exc_info, err_file)
498
 
    err_file.write('\n')
499
 
    err_file.write('bzr %s on python %s (%s)\n' % \
500
 
                       (bzrlib.__version__,
501
 
                        bzrlib._format_version_tuple(sys.version_info),
502
 
                        sys.platform))
503
 
    err_file.write('arguments: %r\n' % sys.argv)
504
 
    err_file.write(
505
 
        'encoding: %r, fsenc: %r, lang: %r\n' % (
506
 
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
507
 
            os.environ.get('LANG')))
508
 
    err_file.write("plugins:\n")
509
 
    for name, a_plugin in sorted(plugin.plugins().items()):
510
 
        err_file.write("  %-20s %s [%s]\n" %
511
 
            (name, a_plugin.path(), a_plugin.__version__))
512
 
    err_file.write(
513
 
"""\
514
 
*** Bazaar has encountered an internal error.
515
 
    Please report a bug at https://bugs.launchpad.net/bzr/+filebug
516
 
    including this traceback, and a description of what you
517
 
    were doing when the error occurred.
518
 
""")
 
502
    from bzrlib.crash import report_bug
 
503
    report_bug(exc_info, err_file)
 
504
 
 
505
 
 
506
def _flush_stdout_stderr():
 
507
    # installed into an atexit hook by bzrlib.initialize()
 
508
    try:
 
509
        sys.stdout.flush()
 
510
        sys.stderr.flush()
 
511
    except IOError, e:
 
512
        import errno
 
513
        if e.errno in [errno.EINVAL, errno.EPIPE]:
 
514
            pass
 
515
        else:
 
516
            raise
 
517
 
 
518
 
 
519
def _flush_trace():
 
520
    # run from atexit hook
 
521
    global _trace_file
 
522
    if _trace_file:
 
523
        _trace_file.flush()