~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Robert Collins
  • Date: 2009-12-16 22:29:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4920.
  • Revision ID: robertc@robertcollins.net-20091216222931-wbbn5ey4mwmpatwd
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
 
    """
120
114
    # FIXME note always emits utf-8, regardless of the terminal encoding
121
115
    #
122
116
    # FIXME: clearing the ui and then going through the abstract logging
151
145
    _bzr_logger.error(*args, **kwargs)
152
146
 
153
147
 
154
 
def show_error(*args, **kwargs):
 
148
def show_error(msg):
155
149
    """Show an error message to the user.
156
150
 
157
151
    Don't use this for exceptions, use report_exception instead.
244
238
    This sets the global _bzr_log_filename.
245
239
    """
246
240
    global _bzr_log_filename
247
 
 
248
 
    def _open_or_create_log_file(filename):
249
 
        """Open existing log file, or create with ownership and permissions
250
 
 
251
 
        It inherits the ownership and permissions (masked by umask) from
252
 
        the containing directory to cope better with being run under sudo
253
 
        with $HOME still set to the user's homedir.
254
 
        """
255
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
256
 
        while True:
257
 
            try:
258
 
                fd = os.open(filename, flags)
259
 
                break
260
 
            except OSError, e:
261
 
                if e.errno != errno.ENOENT:
262
 
                    raise
263
 
            try:
264
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
 
            except OSError, e:
266
 
                if e.errno != errno.EEXIST:
267
 
                    raise
268
 
            else:
269
 
                osutils.copy_ownership_from_path(filename)
270
 
                break
271
 
        return os.fdopen(fd, 'at', 0) # unbuffered
272
 
 
273
 
 
274
241
    _bzr_log_filename = _get_bzr_log_filename()
275
242
    _rollover_trace_maybe(_bzr_log_filename)
276
243
    try:
277
 
        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
278
246
        bzr_log_file.write('\n')
279
247
        if bzr_log_file.tell() <= 2:
280
248
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
249
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
250
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
 
 
284
251
        return bzr_log_file
285
 
 
286
 
    except EnvironmentError, e:
287
 
        # If we are failing to open the log, then most likely logging has not
288
 
        # been set up yet. So we just write to stderr rather than using
289
 
        # 'warning()'. If we using warning(), users get the unhelpful 'no
290
 
        # handlers registered for "bzr"' when something goes wrong on the
291
 
        # server. (bug #503886)
292
 
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
252
    except IOError, e:
 
253
        warning("failed to open trace file: %s" % (e))
293
254
    # TODO: What should happen if we fail to open the trace file?  Maybe the
294
255
    # objects should be pointed at /dev/null or the equivalent?  Currently
295
256
    # returns None which will cause failures later.
399
360
    global _verbosity_level
400
361
    _verbosity_level = level
401
362
    _update_logging_level(level < 0)
402
 
    ui.ui_factory.be_quiet(level < 0)
403
363
 
404
364
 
405
365
def get_verbosity_level():
411
371
 
412
372
 
413
373
def be_quiet(quiet=True):
 
374
    # Perhaps this could be deprecated now ...
414
375
    if quiet:
415
376
        set_verbosity_level(-1)
416
377
    else:
535
496
    """Report an exception that probably indicates a bug in bzr"""
536
497
    from bzrlib.crash import report_bug
537
498
    report_bug(exc_info, err_file)
538
 
 
539
 
 
540
 
def _flush_stdout_stderr():
541
 
    # installed into an atexit hook by bzrlib.initialize()
542
 
    try:
543
 
        sys.stdout.flush()
544
 
        sys.stderr.flush()
545
 
    except IOError, e:
546
 
        import errno
547
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
548
 
            pass
549
 
        else:
550
 
            raise
551
 
 
552
 
 
553
 
def _flush_trace():
554
 
    # run from atexit hook
555
 
    global _trace_file
556
 
    if _trace_file:
557
 
        _trace_file.flush()