← 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-25 01:16:46 UTC
  • Revision ID: mbp@sourcefrog.net-20050325011646-e3f0af5d6bd1190c
- update version string
- put it in bzrlib

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