← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Pool
  • Date: 2005-04-15 01:31:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
1
4
# This program is free software; you can redistribute it and/or modify
2
5
# it under the terms of the GNU General Public License as published by
3
6
# the Free Software Foundation; either version 2 of the License, or
17
20
__author__ = "Martin Pool <mbp@canonical.com>"
18
21
 
19
22
 
20
 
"""Messages and logging for bazaar-ng
21
 
 
22
 
Nothing is actually logged unless you call bzrlib.open_tracefile().
23
 
"""
24
 
 
25
 
 
26
 
import sys, os
 
23
import sys, os, time, socket, stat, codecs
 
24
import bzrlib
27
25
 
28
26
######################################################################
29
27
# messages and logging
30
28
 
 
29
## TODO: If --verbose is given then write to both stderr and
 
30
## _tracefile; perhaps replace _tracefile with a tee thing.
 
31
 
31
32
global _tracefile, _starttime
32
33
_tracefile = None
33
34
 
39
40
silent = False
40
41
 
41
42
 
42
 
# fix this if we ever fork within python
43
 
_mypid = os.getpid()
44
 
_logprefix = '[%d] ' % _mypid
45
 
 
46
 
 
47
 
def _write_trace(msg):
48
 
    if _tracefile:
49
 
        _tracefile.write(_logprefix + msg + '\n')
 
43
# TODO: Somehow tie this to the --verbose option?
 
44
verbose = False
50
45
 
51
46
 
52
47
def warning(msg):
53
 
    sys.stderr.write('bzr: warning: ' + msg + '\n')
54
 
    _write_trace('warning: ' + msg)
55
 
 
56
 
 
57
 
mutter = _write_trace
 
48
    b = 'bzr: warning: ' + msg + '\n'
 
49
    sys.stderr.write(b)
 
50
    _tracefile.write(b)
 
51
    #_tracefile.flush()
 
52
 
 
53
def mutter(msg):
 
54
    _tracefile.write(msg)
 
55
    _tracefile.write('\n')
 
56
    # _tracefile.flush()
 
57
    if verbose:
 
58
        sys.stderr.write('- ' + msg + '\n')
58
59
 
59
60
 
60
61
def note(msg):
61
62
    b = '* ' + str(msg) + '\n'
62
63
    if not silent:
63
64
        sys.stderr.write(b)
64
 
    _write_trace('note: ' + msg)
 
65
    _tracefile.write(b)
 
66
    # _tracefile.flush()
65
67
 
66
68
 
67
69
def log_error(msg):
68
 
    sys.stderr.write(msg + '\n')
69
 
    _write_trace(msg)
70
 
 
71
 
 
72
 
def _rollover_trace_maybe(trace_fname):
73
 
    import stat
74
 
    try:
75
 
        size = os.stat(trace_fname)[stat.ST_SIZE]
76
 
        if size <= 4 << 20:
77
 
            return
78
 
        old_fname = trace_fname + '.old'
79
 
 
80
 
        try:
81
 
            # must remove before rename on windows
82
 
            os.remove(old_fname)
83
 
        except OSError:
84
 
            pass
85
 
 
86
 
        try:
87
 
            # might fail if in use on windows
88
 
            os.rename(trace_fname, old_fname)
89
 
        except OSError:
90
 
            pass
91
 
    except OSError:
92
 
        return
93
 
 
94
 
 
95
 
 
96
 
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
 
70
    sys.stderr.write(msg)
 
71
    _tracefile.write(msg)
 
72
    # _tracefile.flush()
 
73
 
 
74
 
 
75
 
 
76
def create_tracefile(argv):
 
77
    # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
 
78
    #       Perhaps that should eventually go into the platform library?
 
79
    # TODO: If the file doesn't exist, add a note describing it.
 
80
 
97
81
    # Messages are always written to here, so that we have some
98
82
    # information if something goes wrong.  In a future version this
99
83
    # file will be removed on successful completion.
100
84
    global _starttime, _tracefile
101
 
    import stat, codecs
102
85
 
103
86
    _starttime = os.times()[4]
104
87
 
105
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
106
 
    _rollover_trace_maybe(trace_fname)
107
 
 
108
 
    # buffering=1 means line buffered
109
 
    try:
110
 
        _tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
111
 
        t = _tracefile
112
 
 
113
 
        if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
114
 
            t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
115
 
            t.write("you can delete or truncate this file, or include sections in\n")
116
 
            t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
117
 
 
118
 
        import bzrlib
119
 
        _write_trace('bzr %s invoked on python %s (%s)'
120
 
                     % (bzrlib.__version__,
121
 
                        '.'.join(map(str, sys.version_info)),
122
 
                        sys.platform))
123
 
 
124
 
        _write_trace('  arguments: %r' % argv)
125
 
        _write_trace('  working dir: ' + os.getcwdu())
126
 
    except IOError, e:
127
 
        warning("failed to open trace file: %s" % (e))
128
 
 
129
 
def close_trace():
 
88
    # XXX:  Does this always work on Windows?
 
89
    trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
 
90
    _tracefile = codecs.open(trace_fname, 'at', 'utf8')
 
91
    t = _tracefile
 
92
 
 
93
    if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
 
94
        t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
95
        t.write("you can delete or truncate this file, or include sections in\n")
 
96
        t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
97
 
 
98
    # TODO: If we failed to create the file, perhaps give a warning
 
99
    # but don't abort; send things to /dev/null instead?
 
100
 
 
101
    
 
102
    t.write('-' * 60 + '\n')
 
103
    t.write('bzr invoked at %s\n' % bzrlib.osutils.format_date(time.time()))
 
104
    t.write('  version: %s\n' % bzrlib.__version__)
 
105
    t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
 
106
    t.write('  arguments: %r\n' % argv)
 
107
    t.write('  working dir: %s\n' % os.getcwdu())
 
108
 
 
109
    t.write('  platform: %s\n' % sys.platform)
 
110
    t.write('  python: %s\n' % (sys.version_info,))
 
111
 
 
112
    import atexit
 
113
    atexit.register(_close_trace)
 
114
 
 
115
 
 
116
def _close_trace():
130
117
    times = os.times()
131
118
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
132
119
           % (times[:4] + ((times[4] - _starttime),)))
133
120
 
134
121
 
135
122
 
136
 
def log_exception():
137
 
    """Log the last exception into the trace file."""
138
 
    import cgitb
139
 
    s = cgitb.text(sys.exc_info())
140
 
    for l in s.split('\n'):
141
 
        _write_trace(l)
142
 
        
143