~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

• browse files at revision 1740.6.2
• compare with another revision
• compare with revision 2485.8.58
• download diff
• download tarball
• view history from revision 1740.6.2

Show diffs side-by-side

added

removed

bzrlib/trace.py

1

 

# Copyright (C) 2005, Canonical Ltd

 

1

# Copyright (C) 2005, 2006 by Canonical Ltd

 

2

#

 

3

# This program is free software; you can redistribute it and/or modify

 

4

# it under the terms of the GNU General Public License as published by

 

5

# the Free Software Foundation; either version 2 of the License, or

 

6

# (at your option) any later version.

 

7

#

 

8

# This program is distributed in the hope that it will be useful,

 

9

# but WITHOUT ANY WARRANTY; without even the implied warranty of

 

10

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 

11

# GNU General Public License for more details.

 

12

#

 

13

# You should have received a copy of the GNU General Public License

 

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

2

16

 

3

17

"""Messages and logging for bazaar-ng.

4

18

 

27

41

 

28

42

Exceptions are reported in a brief form to stderr so as not to look scary.

29

43

BzrErrors are required to be able to format themselves into a properly

30

 

explanatory message.  This is not true for builtin excexceptions such as

 

44

explanatory message.  This is not true for builtin exceptions such as

31

45

KeyError, which typically just str to "0".  They're printed in a different

32

46

form.

33

47

"""

34

48

 

35

 

# TODO: in debug mode, stderr should get full tracebacks and also

36

 

# debug messages.  (Is this really needed?)

37

 

 

38

49

# FIXME: Unfortunately it turns out that python's logging module

39

50

# is quite expensive, even when the message is not printed by any handlers.

40

51

# We should perhaps change back to just simply doing it here.

41

52

 

42

53

 

 

54

import errno

 

55

import os

43

56

import sys

44

 

import os

45

57

import logging

46

58

 

47

59

import bzrlib

48

60

from bzrlib.errors import BzrError, BzrNewError

49

 

 

 

61

from bzrlib.symbol_versioning import (deprecated_function,

 

62

        zero_nine,

 

63

        )

50

64

 

51

65

_file_handler = None

52

66

_stderr_handler = None

56

70

_bzr_log_file = None

57

71

 

58

72

 

59

 

class QuietFormatter(logging.Formatter):

60

 

    """Formatter that supresses the details of errors.

61

 

 

62

 

    This is used by default on stderr so as not to scare the user.

63

 

    """

64

 

    # At first I tried overriding formatException to suppress the

65

 

    # exception details, but that has global effect: no loggers

66

 

    # can get the exception details is we suppress them here.

67

 

 

68

 

    def format(self, record):

69

 

        if record.levelno >= logging.WARNING:

70

 

            s = 'bzr: ' + record.levelname + ': '

71

 

        else:

72

 

            s = ''

73

 

        s += record.getMessage()

74

 

        if record.exc_info:

75

 

            s += '\n' + format_exception_short(record.exc_info)

76

 

        return s

77

 

        

78

73

# configure convenient aliases for output routines

79

74

 

80

75

_bzr_logger = logging.getLogger('bzr')

100

95

    if hasattr(_trace_file, 'closed') and _trace_file.closed:

101

96

        return

102

97

    if len(args) > 0:

103

 

        out = fmt % args

 

98

        # It seems that if we do ascii % (unicode, ascii) we can

 

99

        # get a unicode cannot encode ascii error, so make sure that "fmt"

 

100

        # is a unicode string

 

101

        out = unicode(fmt) % args

104

102

    else:

105

103

        out = fmt

106

104

    out += '\n'

107

 

    _trace_file.write(out)

 

105

    try:

 

106

        _trace_file.write(out)

 

107

    except UnicodeError, e:

 

108

        warning('UnicodeError: %s', e)

 

109

        _trace_file.write(repr(out))

 

110

    # TODO: jam 20051227 Consider flushing the trace file to help debugging

 

111

    #_trace_file.flush()

108

112

debug = mutter

109

113

 

110

114

 

126

130

    # information if something goes wrong.  In a future version this

127

131

    # file will be removed on successful completion.

128

132

    global _file_handler, _bzr_log_file

129

 

    import stat, codecs

 

133

    import codecs

130

134

 

131

135

    trace_fname = os.path.join(os.path.expanduser(tracefilename))

132

136

    _rollover_trace_maybe(trace_fname)

148

152

        warning("failed to open trace file: %s" % (e))

149

153

 

150

154

 

151

 

def log_startup(argv):

152

 

    debug('\n\nbzr %s invoked on python %s (%s)',

153

 

          bzrlib.__version__,

154

 

          '.'.join(map(str, sys.version_info)),

155

 

          sys.platform)

156

 

    debug('  arguments: %r', argv)

157

 

    debug('  working dir: %r', os.getcwdu())

158

 

 

159

 

 

 

155

@deprecated_function(zero_nine)

160

156

def log_exception(msg=None):

161

157

    """Log the last exception to stderr and the trace file.

162

158

 

187

183

    # FIXME: if this is run twice, things get confused

188

184

    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file

189

185

    _stderr_handler = logging.StreamHandler()

190

 

    _stderr_handler.setFormatter(QuietFormatter())

191

186

    logging.getLogger('').addHandler(_stderr_handler)

192

187

    _stderr_handler.setLevel(logging.INFO)

193

188

    if not _file_handler:

195

190

    _trace_file = _bzr_log_file

196

191

    if _file_handler:

197

192

        _file_handler.setLevel(logging.DEBUG)

198

 

    _bzr_logger.setLevel(logging.DEBUG) 

199

 

 

 

193

    _bzr_logger.setLevel(logging.DEBUG)

200

194

 

201

195

 

202

196

def be_quiet(quiet=True):

259

253

        enable_default_logging()

260

254

 

261

255

 

262

 

def format_exception_short(exc_info):

263

 

    """Make a short string form of an exception.

264

 

 

265

 

    This is used for display to stderr.  It specially handles exception

266

 

    classes without useful string methods.

267

 

 

268

 

    The result has no trailing newline.

269

 

 

270

 

    exc_info - typically an exception from sys.exc_info()

271

 

    """

272

 

    exc_type, exc_object, exc_tb = exc_info

273

 

    try:

274

 

        if exc_type is None:

275

 

            return '(no exception)'

276

 

        if isinstance(exc_object, (BzrError, BzrNewError)):

277

 

            return str(exc_object)

278

 

        else:

279

 

            import traceback

280

 

            tb = traceback.extract_tb(exc_tb)

281

 

            msg = '%s: %s' % (exc_type, exc_object)

282

 

            if msg[-1] == '\n':

283

 

                msg = msg[:-1]

284

 

            if tb:

285

 

                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])

286

 

            return msg

287

 

    except Exception, formatting_exc:

288

 

        # XXX: is this really better than just letting it run up?

289

 

        return '(error formatting exception of type %s: %s)' \

290

 

                % (exc_type, formatting_exc)

 

256

def report_exception(exc_info, err_file):

 

257

    exc_type, exc_object, exc_tb = exc_info

 

258

    if (isinstance(exc_object, IOError)

 

259

        and getattr(exc_object, 'errno', None) == errno.EPIPE):

 

260

        print >>err_file, "bzr: broken pipe"

 

261

    elif isinstance(exc_object, KeyboardInterrupt):

 

262

        print >>err_file, "bzr: interrupted"

 

263

    elif getattr(exc_object, 'is_user_error', False):

 

264

        report_user_error(exc_info, err_file)

 

265

    elif isinstance(exc_object, (OSError, IOError)):

 

266

        # Might be nice to catch all of these and show them as something more

 

267

        # specific, but there are too many cases at the moment.

 

268

        report_user_error(exc_info, err_file)

 

269

    else:

 

270

        report_bug(exc_info, err_file)

 

271

 

 

272

 

 

273

# TODO: Should these be specially encoding the output?

 

274

def report_user_error(exc_info, err_file):

 

275

    print >>err_file, "bzr: ERROR:", str(exc_info[1])

 

276

 

 

277

 

 

278

def report_bug(exc_info, err_file):

 

279

    """Report an exception that probably indicates a bug in bzr"""

 

280

    import traceback

 

281

    exc_type, exc_object, exc_tb = exc_info

 

282

    print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)

 

283

    print >>err_file

 

284

    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)

 

285

    print >>err_file

 

286

    print >>err_file, 'bzr %s on python %s (%s)' % \

 

287

                       (bzrlib.__version__,

 

288

                        '.'.join(map(str, sys.version_info)),

 

289

                        sys.platform)

 

290

    print >>err_file, 'arguments: %r' % sys.argv

 

291

    print >>err_file

 

292

    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1