← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

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
13
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
14
17
 
15
18
 
16
 
 
17
 
# TODO: Could probably replace this with something based on Python logging
18
 
# module.
19
 
 
20
 
 
21
 
 
22
 
 
23
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
20
__author__ = "Martin Pool <mbp@canonical.com>"
25
21
 
26
22
 
27
 
"""Messages and logging for bazaar-ng
28
 
 
29
 
Nothing is actually logged unless you call bzrlib.open_tracefile().
30
 
"""
31
 
 
32
 
 
33
 
import sys, os
 
23
import sys
34
24
 
35
25
######################################################################
36
26
# messages and logging
37
27
 
38
 
global _tracefile, _starttime
39
 
_tracefile = None
 
28
# Messages are always written to here, so that we have some
 
29
# information if something goes wrong.  In a future version this
 
30
# file will be removed on successful completion.
 
31
_tracefile = file('.bzr.log', 'at')
 
32
 
 
33
## TODO: If --verbose is given then write to both stderr and
 
34
## _tracefile; perhaps replace _tracefile with a tee thing.
40
35
 
41
36
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
42
 
_starttime = None
 
37
 
43
38
 
44
39
# If false, notes also go to stdout; should replace this with --silent
45
40
# at some point.
46
41
silent = False
47
42
 
48
 
 
49
 
# fix this if we ever fork within python
50
 
_mypid = os.getpid()
51
 
_logprefix = '[%d] ' % _mypid
52
 
 
53
 
 
54
 
def _write_trace(msg):
55
 
    if 0:
56
 
        if _tracefile:
57
 
            _tracefile.write(_logprefix + msg + '\n')
58
 
 
59
 
 
60
 
def warning(msg):
61
 
    sys.stderr.write('bzr: warning: ' + msg + '\n')
62
 
    _write_trace('warning: ' + msg)
63
 
 
64
 
 
65
 
mutter = _write_trace
 
43
verbose = False
 
44
 
 
45
 
 
46
def mutter(msg):
 
47
    _tracefile.write(msg)
 
48
    _tracefile.write('\n')
 
49
    _tracefile.flush()
 
50
    if verbose:
 
51
        sys.stderr.write('- ' + msg + '\n')
66
52
 
67
53
 
68
54
def note(msg):
69
55
    b = '* ' + str(msg) + '\n'
70
56
    if not silent:
71
57
        sys.stderr.write(b)
72
 
    _write_trace('note: ' + msg)
 
58
    _tracefile.write(b)
 
59
    _tracefile.flush()
73
60
 
74
61
 
75
62
def log_error(msg):
76
 
    sys.stderr.write(msg + '\n')
77
 
    _write_trace(msg)
78
 
 
79
 
 
80
 
def _rollover_trace_maybe(trace_fname):
81
 
    import stat
82
 
    try:
83
 
        size = os.stat(trace_fname)[stat.ST_SIZE]
84
 
        if size <= 4 << 20:
85
 
            return
86
 
        old_fname = trace_fname + '.old'
87
 
 
88
 
        try:
89
 
            # must remove before rename on windows
90
 
            os.remove(old_fname)
91
 
        except OSError:
92
 
            pass
93
 
 
94
 
        try:
95
 
            # might fail if in use on windows
96
 
            os.rename(trace_fname, old_fname)
97
 
        except OSError:
98
 
            pass
99
 
    except OSError:
100
 
        return
101
 
 
102
 
 
103
 
 
104
 
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
105
 
    # Messages are always written to here, so that we have some
106
 
    # information if something goes wrong.  In a future version this
107
 
    # file will be removed on successful completion.
108
 
    global _starttime, _tracefile
109
 
    import stat, codecs
110
 
 
111
 
    _starttime = os.times()[4]
112
 
 
113
 
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
114
 
    _rollover_trace_maybe(trace_fname)
115
 
 
116
 
    # buffering=1 means line buffered
117
 
    try:
118
 
        _tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
119
 
        t = _tracefile
120
 
 
121
 
        if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
122
 
            t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
123
 
            t.write("you can delete or truncate this file, or include sections in\n")
124
 
            t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
125
 
 
126
 
        import bzrlib
127
 
        _write_trace('bzr %s invoked on python %s (%s)'
128
 
                     % (bzrlib.__version__,
129
 
                        '.'.join(map(str, sys.version_info)),
130
 
                        sys.platform))
131
 
 
132
 
        _write_trace('  arguments: %r' % argv)
133
 
        _write_trace('  working dir: ' + os.getcwdu())
134
 
    except IOError, e:
135
 
        warning("failed to open trace file: %s" % (e))
136
 
 
137
 
def close_trace():
138
 
    times = os.times()
139
 
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
140
 
           % (times[:4] + ((times[4] - _starttime),)))
141
 
 
142
 
 
143
 
 
144
 
def log_exception():
145
 
    """Log the last exception into the trace file."""
146
 
    import cgitb
147
 
    s = cgitb.text(sys.exc_info())
148
 
    for l in s.split('\n'):
149
 
        _write_trace(l)
150
 
        
151
 
    
 
63
    sys.stderr.write(msg)
 
64
    _tracefile.write(msg)
 
65
    _tracefile.flush()