~bzr-pqm/bzr/bzr.dev : revision 1797

1

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

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 suppresses 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')

157

152

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

158

153

159

154

160

def log_startup(argv):

161

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

162

bzrlib.__version__,

163

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

164

sys.platform)

165

debug(' arguments: %r', argv)

166

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

167

168

155

@deprecated_function(zero_nine)

169

156

def log_exception(msg=None):

170

157

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

171

158

196

183

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

197

184

global _stderr_handler, _file_handler, _trace_file, _bzr_log_file

198

185

_stderr_handler = logging.StreamHandler()

199

_stderr_handler.setFormatter(QuietFormatter())

200

186

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

201

187

_stderr_handler.setLevel(logging.INFO)

202

188

if not _file_handler:

204

190

_trace_file = _bzr_log_file

205

191

if _file_handler:

206

192

_file_handler.setLevel(logging.DEBUG)

207

_bzr_logger.setLevel(logging.DEBUG)

208

193

_bzr_logger.setLevel(logging.DEBUG)

209

194

210

195

211

196

def be_quiet(quiet=True):

268

253

enable_default_logging()

269

254

270

255

271

def format_exception_short(exc_info):

272

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

273

274

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

275

classes without useful string methods.

276

277

The result has no trailing newline.

278

279

exc_info - typically an exception from sys.exc_info()

280

"""

281

exc_type, exc_object, exc_tb = exc_info

282

try:

283

if exc_type is None:

284

return '(no exception)'

285

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

286

return str(exc_object)

287

else:

288

import traceback

289

tb = traceback.extract_tb(exc_tb)

290

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

291

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

292

msg = msg[:-1]

293

if tb:

294

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

295

return msg

296

except Exception, formatting_exc:

297

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

298

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

299

% (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"