~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

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

• reverse the comparison (4570.3.5 to 5200.3.1)
• stop comparing with revision 5200.3.1

Show diffs side-by-side

added

removed

bzrlib/trace.py

1

 

# Copyright (C) 2005-2010 Canonical Ltd

 

1

# Copyright (C) 2005, 2006, 2007, 2008 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.

58

59

import logging

59

60

import os

60

61

import sys

 

62

import re

61

63

import time

62

64

 

63

65

from bzrlib.lazy_import import lazy_import

70

72

 

71

73

import bzrlib

72

74

 

73

 

from bzrlib.symbol_versioning import (

74

 

    deprecated_function,

75

 

    deprecated_in,

76

 

    )

77

 

 

78

75

lazy_import(globals(), """

79

76

from bzrlib import (

80

77

    debug,

82

79

    osutils,

83

80

    plugin,

84

81

    symbol_versioning,

85

 

    ui,

86

82

    )

87

83

""")

88

84

 

127

123

    _bzr_logger.warning(*args, **kwargs)

128

124

 

129

125

 

130

 

@deprecated_function(deprecated_in((2, 1, 0)))

131

 

def info(*args, **kwargs):

132

 

    """Deprecated: use trace.note instead."""

133

 

    note(*args, **kwargs)

134

 

 

135

 

 

136

 

@deprecated_function(deprecated_in((2, 1, 0)))

137

 

def log_error(*args, **kwargs):

138

 

    """Deprecated: use bzrlib.trace.show_error instead"""

139

 

    _bzr_logger.error(*args, **kwargs)

140

 

 

141

 

 

142

 

@deprecated_function(deprecated_in((2, 1, 0)))

143

 

def error(*args, **kwargs):

144

 

    """Deprecated: use bzrlib.trace.show_error instead"""

145

 

    _bzr_logger.error(*args, **kwargs)

146

 

 

147

 

 

148

 

def show_error(*args, **kwargs):

149

 

    """Show an error message to the user.

150

 

 

151

 

    Don't use this for exceptions, use report_exception instead.

152

 

    """

153

 

    _bzr_logger.error(*args, **kwargs)

154

 

 

 

126

# configure convenient aliases for output routines

 

127

#

 

128

# TODO: deprecate them, have one name for each.

 

129

info = note

 

130

log_error = _bzr_logger.error

 

131

error =     _bzr_logger.error

 

132

 

 

133

 

 

134

_last_mutter_flush_time = None

155

135

 

156

136

def mutter(fmt, *args):

 

137

    global _last_mutter_flush_time

157

138

    if _trace_file is None:

158

139

        return

159

 

    # XXX: Don't check this every time; instead anyone who closes the file

160

 

    # ought to deregister it.  We can tolerate None.

161

140

    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:

162

141

        return

163

142

 

180

159

    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)

181

160

    out = timestamp + out + '\n'

182

161

    _trace_file.write(out)

183

 

    # there's no explicit flushing; the file is typically line buffered.

 

162

    # We flush if we haven't flushed for a few seconds. We don't want to flush

 

163

    # on every mutter, but when a command takes a while, it can be nice to see

 

164

    # updates in the debug log.

 

165

    if (_last_mutter_flush_time is None

 

166

        or (now - _last_mutter_flush_time) > 2.0):

 

167

        flush = getattr(_trace_file, 'flush', None)

 

168

        if flush is not None:

 

169

            flush()

 

170

        _last_mutter_flush_time = now

184

171

 

185

172

 

186

173

def mutter_callsite(stacklevel, fmt, *args):

238

225

    This sets the global _bzr_log_filename.

239

226

    """

240

227

    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

228

    _bzr_log_filename = _get_bzr_log_filename()

269

229

    _rollover_trace_maybe(_bzr_log_filename)

270

230

    try:

271

 

        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)

 

231

        bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered

 

232

        # bzr_log_file.tell() on windows always return 0 until some writing done

272

233

        bzr_log_file.write('\n')

273

234

        if bzr_log_file.tell() <= 2:

274

235

            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")

275

236

            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")

276

237

            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")

277

 

 

278

238

        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,))

 

239

    except IOError, e:

 

240

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

287

241

    # TODO: What should happen if we fail to open the trace file?  Maybe the

288

242

    # objects should be pointed at /dev/null or the equivalent?  Currently

289

243

    # returns None which will cause failures later.

393

347

    global _verbosity_level

394

348

    _verbosity_level = level

395

349

    _update_logging_level(level < 0)

396

 

    ui.ui_factory.be_quiet(level < 0)

397

350

 

398

351

 

399

352

def get_verbosity_level():

405

358

 

406

359

 

407

360

def be_quiet(quiet=True):

 

361

    # Perhaps this could be deprecated now ...

408

362

    if quiet:

409

363

        set_verbosity_level(-1)

410

364

    else:

468

422

 

469

423

    :return: The appropriate exit code for this error.

470

424

    """

 

425

    exc_type, exc_object, exc_tb = exc_info

471

426

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

472

427

    log_exception_quietly()

473

 

    if 'error' in debug.debug_flags:

474

 

        print_exception(exc_info, err_file)

475

 

        return errors.EXIT_ERROR

476

 

    exc_type, exc_object, exc_tb = exc_info

477

428

    if (isinstance(exc_object, IOError)

478

429

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

479

430

        err_file.write("bzr: broken pipe\n")

481

432

    elif isinstance(exc_object, KeyboardInterrupt):

482

433

        err_file.write("bzr: interrupted\n")

483

434

        return errors.EXIT_ERROR

484

 

    elif isinstance(exc_object, MemoryError):

485

 

        err_file.write("bzr: out of memory\n")

486

 

        return errors.EXIT_ERROR

487

435

    elif isinstance(exc_object, ImportError) \

488

436

        and str(exc_object).startswith("No module named "):

489

437

        report_user_error(exc_info, err_file,

520

468

    :param advice: Extra advice to the user to be printed following the

521

469

        exception.

522

470

    """

 

471

    if 'error' in debug.debug_flags:

 

472

        print_exception(exc_info, err_file)

 

473

        return

523

474

    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))

524

475

    if advice:

525

476

        err_file.write("%s\n" % (advice,))

527

478

 

528

479

def report_bug(exc_info, err_file):

529

480

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

530

 

    from bzrlib.crash import report_bug

531

 

    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()

 

481

    print_exception(exc_info, err_file)

 

482

    err_file.write('\n')

 

483

    err_file.write('bzr %s on python %s (%s)\n' % \

 

484

                       (bzrlib.__version__,

 

485

                        bzrlib._format_version_tuple(sys.version_info),

 

486

                        sys.platform))

 

487

    err_file.write('arguments: %r\n' % sys.argv)

 

488

    err_file.write(

 

489

        'encoding: %r, fsenc: %r, lang: %r\n' % (

 

490

            osutils.get_user_encoding(), sys.getfilesystemencoding(),

 

491

            os.environ.get('LANG')))

 

492

    err_file.write("plugins:\n")

 

493

    for name, a_plugin in sorted(plugin.plugins().items()):

 

494

        err_file.write("  %-20s %s [%s]\n" %

 

495

            (name, a_plugin.path(), a_plugin.__version__))

 

496

    err_file.write(

 

497

"""\

 

498

*** Bazaar has encountered an internal error.

 

499

    Please report a bug at https://bugs.launchpad.net/bzr/+filebug

 

500

    including this traceback, and a description of what you

 

501

    were doing when the error occurred.

 

502

""")

• Older »

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