← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Add a NEWS entry and prepare submission.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Messages and logging.
 
17
"""Messages and logging for bazaar-ng.
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 debug mode, stderr gets debug messages too.
 
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.
37
38
 
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
82
83
    osutils,
83
84
    plugin,
84
85
    symbol_versioning,
85
 
    ui,
86
86
    )
87
87
""")
88
88
 
145
145
    _bzr_logger.error(*args, **kwargs)
146
146
 
147
147
 
148
 
def show_error(*args, **kwargs):
 
148
def show_error(msg):
149
149
    """Show an error message to the user.
150
150
 
151
151
    Don't use this for exceptions, use report_exception instead.
238
238
    This sets the global _bzr_log_filename.
239
239
    """
240
240
    global _bzr_log_filename
241
 
 
242
 
    def _open_or_create_log_file(filename):
243
 
        """Open existing log file, or create with ownership and permissions
244
 
 
245
 
        It inherits the ownership and permissions (masked by umask) from
246
 
        the containing directory to cope better with being run under sudo
247
 
        with $HOME still set to the user's homedir.
248
 
        """
249
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
250
 
        while True:
251
 
            try:
252
 
                fd = os.open(filename, flags)
253
 
                break
254
 
            except OSError, e:
255
 
                if e.errno != errno.ENOENT:
256
 
                    raise
257
 
            try:
258
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
259
 
            except OSError, e:
260
 
                if e.errno != errno.EEXIST:
261
 
                    raise
262
 
            else:
263
 
                osutils.copy_ownership_from_path(filename)
264
 
                break
265
 
        return os.fdopen(fd, 'at', 0) # unbuffered
266
 
 
267
 
 
268
241
    _bzr_log_filename = _get_bzr_log_filename()
269
242
    _rollover_trace_maybe(_bzr_log_filename)
270
243
    try:
271
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
 
244
        bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
 
245
        # bzr_log_file.tell() on windows always return 0 until some writing done
272
246
        bzr_log_file.write('\n')
273
247
        if bzr_log_file.tell() <= 2:
274
248
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
275
249
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
276
250
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
277
 
 
278
251
        return bzr_log_file
279
 
 
280
 
    except EnvironmentError, e:
281
 
        # If we are failing to open the log, then most likely logging has not
282
 
        # been set up yet. So we just write to stderr rather than using
283
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
284
 
        # handlers registered for "bzr"' when something goes wrong on the
285
 
        # server. (bug #503886)
286
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
252
    except IOError, e:
 
253
        warning("failed to open trace file: %s" % (e))
287
254
    # TODO: What should happen if we fail to open the trace file?  Maybe the
288
255
    # objects should be pointed at /dev/null or the equivalent?  Currently
289
256
    # returns None which will cause failures later.
393
360
    global _verbosity_level
394
361
    _verbosity_level = level
395
362
    _update_logging_level(level < 0)
396
 
    ui.ui_factory.be_quiet(level < 0)
397
363
 
398
364
 
399
365
def get_verbosity_level():
405
371
 
406
372
 
407
373
def be_quiet(quiet=True):
 
374
    # Perhaps this could be deprecated now ...
408
375
    if quiet:
409
376
        set_verbosity_level(-1)
410
377
    else:
529
496
    """Report an exception that probably indicates a bug in bzr"""
530
497
    from bzrlib.crash import report_bug
531
498
    report_bug(exc_info, err_file)
532
 
 
533
 
 
534
 
def _flush_stdout_stderr():
535
 
    # installed into an atexit hook by bzrlib.initialize()
536
 
    try:
537
 
        sys.stdout.flush()
538
 
        sys.stderr.flush()
539
 
    except IOError, e:
540
 
        import errno
541
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
542
 
            pass
543
 
        else:
544
 
            raise
545
 
 
546
 
 
547
 
def _flush_trace():
548
 
    # run from atexit hook
549
 
    global _trace_file
550
 
    if _trace_file:
551
 
        _trace_file.flush()