← 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-05-06 03:20:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050506032014-decf4918803147d2
- split out notes on storing annotations in revfiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
 
1
# This program is free software; you can redistribute it and/or modify
 
2
# it under the terms of the GNU General Public License as published by
 
3
# the Free Software Foundation; either version 2 of the License, or
 
4
# (at your option) any later version.
 
5
 
 
6
# This program is distributed in the hope that it will be useful,
 
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
9
# GNU General Public License for more details.
 
10
 
 
11
# You should have received a copy of the GNU General Public License
 
12
# along with this program; if not, write to the Free Software
 
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
14
 
 
15
 
 
16
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
17
__author__ = "Martin Pool <mbp@canonical.com>"
 
18
 
 
19
 
 
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
 
27
import bzrlib
 
28
 
 
29
######################################################################
 
30
# messages and logging
 
31
 
 
32
global _tracefile, _starttime
 
33
_tracefile = None
 
34
 
 
35
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
 
36
_starttime = None
 
37
 
 
38
# If false, notes also go to stdout; should replace this with --silent
 
39
# at some point.
 
40
silent = False
 
41
 
 
42
 
 
43
# fix this if we ever fork within python
 
44
_mypid = os.getpid()
 
45
_logprefix = '[%d] ' % _mypid
 
46
 
 
47
 
 
48
def _write_trace(msg):
 
49
    if _tracefile:
 
50
        _tracefile.write(_logprefix + msg + '\n')
 
51
 
 
52
 
 
53
def warning(msg):
 
54
    sys.stderr.write('bzr: warning: ' + msg + '\n')
 
55
    _write_trace('warning: ' + msg)
 
56
 
 
57
 
 
58
mutter = _write_trace
 
59
 
 
60
 
 
61
def note(msg):
 
62
    b = '* ' + str(msg) + '\n'
 
63
    if not silent:
 
64
        sys.stderr.write(b)
 
65
    _write_trace('note: ' + msg)
 
66
 
 
67
 
 
68
def log_error(msg):
 
69
    sys.stderr.write(msg + '\n')
 
70
    _write_trace(msg)
 
71
 
 
72
 
 
73
def _rollover_trace_maybe(trace_fname):
 
74
    import stat
 
75
    try:
 
76
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
77
        if size <= 4 << 20:
 
78
            return
 
79
        old_fname = trace_fname + '.old'
 
80
 
 
81
        try:
 
82
            # must remove before rename on windows
 
83
            os.remove(old_fname)
 
84
        except OSError:
 
85
            pass
 
86
 
 
87
        try:
 
88
            # might fail if in use on windows
 
89
            os.rename(trace_fname, old_fname)
 
90
        except OSError:
 
91
            pass
 
92
    except OSError:
 
93
        return
 
94
 
 
95
 
 
96
 
 
97
def open_tracefile(argv):
 
98
    # Messages are always written to here, so that we have some
 
99
    # information if something goes wrong.  In a future version this
 
100
    # file will be removed on successful completion.
 
101
    global _starttime, _tracefile
 
102
    import stat, codecs
 
103
 
 
104
    _starttime = os.times()[4]
 
105
 
 
106
    trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
 
107
    _rollover_trace_maybe(trace_fname)
 
108
 
 
109
    # buffering=1 means line buffered
 
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
    # TODO: If we failed to create the file, perhaps give a warning
 
119
    # but don't abort; send things to /dev/null instead?
 
120
 
 
121
    _write_trace('bzr %s invoked on python %s (%s)'
 
122
                 % (bzrlib.__version__,
 
123
                    '.'.join(map(str, sys.version_info)),
 
124
                    sys.platform))
 
125
 
 
126
    _write_trace('  arguments: %r' % argv)
 
127
    _write_trace('  working dir: ' + os.getcwdu())
 
128
 
 
129
 
 
130
def close_trace():
 
131
    times = os.times()
 
132
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
 
133
           % (times[:4] + ((times[4] - _starttime),)))
 
134
 
 
135
 
 
136
 
 
137
def log_exception():
 
138
    """Log the last exception into the trace file."""
 
139
    import cgitb
 
140
    s = cgitb.text(sys.exc_info())
 
141
    for l in s.split('\n'):
 
142
        _write_trace(l)
 
143
        
 
144