~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

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

• reverse the comparison (1583.1.2 to 1786.1.32)
• stop comparing with revision 1786.1.32

Show diffs side-by-side

added

removed

bzrlib/trace.py

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

 

1

# Copyright (C) 2005, Canonical Ltd

16

2

 

17

3

"""Messages and logging for bazaar-ng.

18

4

 

41

27

 

42

28

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

43

29

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

44

 

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

 

30

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

45

31

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

46

32

form.

47

33

"""

48

34

 

 

35

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

 

36

# debug messages.  (Is this really needed?)

 

37

 

49

38

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

50

39

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

51

40

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

52

41

 

53

42

 

54

 

import errno

 

43

import sys

55

44

import os

56

 

import sys

57

45

import logging

58

46

 

59

47

import bzrlib

60

48

from bzrlib.errors import BzrError, BzrNewError

61

 

from bzrlib.symbol_versioning import (deprecated_function,

62

 

        zero_nine,

63

 

        )

 

49

 

64

50

 

65

51

_file_handler = None

66

52

_stderr_handler = None

67

53

_stderr_quiet = False

68

54

_trace_file = None

69

 

_trace_depth = 0

70

55

_bzr_log_file = None

71

56

 

72

57

 

 

58

class QuietFormatter(logging.Formatter):

 

59

    """Formatter that supresses the details of errors.

 

60

 

 

61

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

 

62

    """

 

63

    # At first I tried overriding formatException to suppress the

 

64

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

 

65

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

 

66

 

 

67

    def format(self, record):

 

68

        if record.levelno >= logging.WARNING:

 

69

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

 

70

        else:

 

71

            s = ''

 

72

        s += record.getMessage()

 

73

        if record.exc_info:

 

74

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

 

75

        return s

 

76

        

73

77

# configure convenient aliases for output routines

74

78

 

75

79

_bzr_logger = logging.getLogger('bzr')

76

80

 

77

 

def note(*args, **kwargs):

78

 

    # FIXME note always emits utf-8, regardless of the terminal encoding

79

 

    import bzrlib.ui

80

 

    bzrlib.ui.ui_factory.clear_term()

81

 

    _bzr_logger.info(*args, **kwargs)

82

 

 

83

 

def warning(*args, **kwargs):

84

 

    import bzrlib.ui

85

 

    bzrlib.ui.ui_factory.clear_term()

86

 

    _bzr_logger.warning(*args, **kwargs)

87

 

 

88

 

info = note

 

81

info = note = _bzr_logger.info

 

82

warning =   _bzr_logger.warning

89

83

log_error = _bzr_logger.error

90

84

error =     _bzr_logger.error

91

85

 

96

90

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

97

91

        return

98

92

    if len(args) > 0:

99

 

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

100

 

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

101

 

        # is a unicode string

102

 

        out = unicode(fmt) % args

 

93

        out = fmt % args

103

94

    else:

104

95

        out = fmt

105

96

    out += '\n'

106

 

    try:

107

 

        _trace_file.write(out)

108

 

    except UnicodeError, e:

109

 

        warning('UnicodeError: %s', e)

110

 

        _trace_file.write(repr(out))

111

 

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

112

 

    #_trace_file.flush()

 

97

    _trace_file.write(out)

113

98

debug = mutter

114

99

 

115

100

 

131

116

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

132

117

    # file will be removed on successful completion.

133

118

    global _file_handler, _bzr_log_file

134

 

    import codecs

 

119

    import stat, codecs

135

120

 

136

121

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

137

122

    _rollover_trace_maybe(trace_fname)

153

138

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

154

139

 

155

140

 

156

 

@deprecated_function(zero_nine)

 

141

def log_startup(argv):

 

142

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

 

143

          bzrlib.__version__,

 

144

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

 

145

          sys.platform)

 

146

    debug('  arguments: %r', argv)

 

147

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

 

148

 

 

149

 

157

150

def log_exception(msg=None):

158

151

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

159

152

 

184

177

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

185

178

    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file

186

179

    _stderr_handler = logging.StreamHandler()

 

180

    _stderr_handler.setFormatter(QuietFormatter())

187

181

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

188

182

    _stderr_handler.setLevel(logging.INFO)

189

183

    if not _file_handler:

191

185

    _trace_file = _bzr_log_file

192

186

    if _file_handler:

193

187

        _file_handler.setLevel(logging.DEBUG)

194

 

    _bzr_logger.setLevel(logging.DEBUG)

 

188

    _bzr_logger.setLevel(logging.DEBUG) 

 

189

 

195

190

 

196

191

 

197

192

def be_quiet(quiet=True):

227

222

    """Redirect logging to a temporary file for a test

228

223

    

229

224

    returns an opaque reference that should be passed to disable_test_log

230

 

    after the test completes.

 

225

    after the test complete.

231

226

    """

232

227

    disable_default_logging()

233

228

    global _trace_file

234

 

    global _trace_depth

235

229

    hdlr = logging.StreamHandler(to_file)

236

230

    hdlr.setLevel(logging.DEBUG)

237

231

    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))

238

232

    _bzr_logger.addHandler(hdlr)

239

233

    _bzr_logger.setLevel(logging.DEBUG)

240

 

    result = hdlr, _trace_file, _trace_depth

 

234

    result = hdlr, _trace_file

241

235

    _trace_file = to_file

242

 

    _trace_depth += 1

243

236

    return result

244

237

 

245

238

 

246

 

def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):

 

239

def disable_test_log((test_log_hdlr, old_trace_file)):

247

240

    _bzr_logger.removeHandler(test_log_hdlr)

248

 

    test_log_hdlr.close()

249

 

    global _trace_file

250

 

    global _trace_depth

251

241

    _trace_file = old_trace_file

252

 

    _trace_depth = old_trace_depth

253

 

    if not _trace_depth:

254

 

        enable_default_logging()

255

 

 

256

 

 

257

 

def report_exception(exc_info, err_file):

258

 

    exc_type, exc_object, exc_tb = exc_info

259

 

    # Log the full traceback to ~/.bzr.log

260

 

    log_exception_quietly()

261

 

    if (isinstance(exc_object, IOError)

262

 

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

263

 

        print >>err_file, "bzr: broken pipe"

264

 

    elif isinstance(exc_object, KeyboardInterrupt):

265

 

        print >>err_file, "bzr: interrupted"

266

 

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

267

 

        report_user_error(exc_info, err_file)

268

 

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

269

 

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

270

 

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

271

 

        report_user_error(exc_info, err_file)

272

 

    else:

273

 

        report_bug(exc_info, err_file)

274

 

 

275

 

 

276

 

# TODO: Should these be specially encoding the output?

277

 

def report_user_error(exc_info, err_file):

278

 

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

279

 

 

280

 

 

281

 

def report_bug(exc_info, err_file):

282

 

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

283

 

    import traceback

284

 

    exc_type, exc_object, exc_tb = exc_info

285

 

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

286

 

    print >>err_file

287

 

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

288

 

    print >>err_file

289

 

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

290

 

                       (bzrlib.__version__,

291

 

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

292

 

                        sys.platform)

293

 

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

294

 

    print >>err_file

295

 

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

 

242

    enable_default_logging()

 

243

 

 

244

 

 

245

def format_exception_short(exc_info):

 

246

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

 

247

 

 

248

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

 

249

    classes without useful string methods.

 

250

 

 

251

    The result has no trailing newline.

 

252

 

 

253

    exc_info - typically an exception from sys.exc_info()

 

254

    """

 

255

    exc_type, exc_object, exc_tb = exc_info

 

256

    try:

 

257

        if exc_type is None:

 

258

            return '(no exception)'

 

259

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

 

260

            return str(exc_object)

 

261

        else:

 

262

            import traceback

 

263

            tb = traceback.extract_tb(exc_tb)

 

264

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

 

265

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

 

266

                msg = msg[:-1]

 

267

            if tb:

 

268

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

 

269

            return msg

 

270

    except Exception, formatting_exc:

 

271

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

 

272

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

 

273

                % (exc_type, formatting_exc)

• Older »

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