← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Robert Collins
  • Date: 2005-08-23 06:52:09 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050823065209-81cd5962c401751b
move io redirection into each test case from the global runner

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
 
 
4
1
# This program is free software; you can redistribute it and/or modify
5
2
# it under the terms of the GNU General Public License as published by
6
3
# the Free Software Foundation; either version 2 of the License, or
16
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
14
 
18
15
 
 
16
 
 
17
# TODO: Could probably replace this with something based on Python logging
 
18
# module.
 
19
 
 
20
 
 
21
 
 
22
 
19
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
24
__author__ = "Martin Pool <mbp@canonical.com>"
21
25
 
22
26
 
23
 
import sys, os, time, socket, stat
24
 
import bzrlib
 
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
25
34
 
26
35
######################################################################
27
36
# messages and logging
28
37
 
29
 
## TODO: If --verbose is given then write to both stderr and
30
 
## _tracefile; perhaps replace _tracefile with a tee thing.
31
 
 
32
38
global _tracefile, _starttime
 
39
_tracefile = None
33
40
 
34
41
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
35
 
 
 
42
_starttime = None
36
43
 
37
44
# If false, notes also go to stdout; should replace this with --silent
38
45
# at some point.
39
46
silent = False
40
47
 
41
 
verbose = False
42
 
 
43
 
 
44
 
def mutter(msg):
45
 
    _tracefile.write(msg)
46
 
    _tracefile.write('\n')
47
 
    _tracefile.flush()
48
 
    if verbose:
49
 
        sys.stderr.write('- ' + msg + '\n')
 
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
50
66
 
51
67
 
52
68
def note(msg):
53
69
    b = '* ' + str(msg) + '\n'
54
70
    if not silent:
55
71
        sys.stderr.write(b)
56
 
    _tracefile.write(b)
57
 
    _tracefile.flush()
 
72
    _write_trace('note: ' + msg)
58
73
 
59
74
 
60
75
def log_error(msg):
61
 
    sys.stderr.write(msg)
62
 
    _tracefile.write(msg)
63
 
    _tracefile.flush()
64
 
 
65
 
 
66
 
 
67
 
def create_tracefile(argv):
68
 
    # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
69
 
    #       Perhaps that should eventually go into the platform library?
70
 
    # TODO: If the file doesn't exist, add a note describing it.
71
 
 
 
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'):
72
105
    # Messages are always written to here, so that we have some
73
106
    # information if something goes wrong.  In a future version this
74
107
    # file will be removed on successful completion.
75
108
    global _starttime, _tracefile
 
109
    import stat, codecs
76
110
 
77
111
    _starttime = os.times()[4]
78
112
 
79
 
    _tracefile = file('.bzr.log', 'at')
80
 
    t = _tracefile
81
 
 
82
 
    if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
83
 
        t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
84
 
        t.write("you can delete or truncate this file, or include sections in\n")
85
 
        t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
86
 
 
87
 
    # TODO: If we failed to create the file, perhaps give a warning
88
 
    # but don't abort; send things to /dev/null instead?
89
 
 
90
 
    
91
 
    t.write('-' * 60 + '\n')
92
 
    t.write('bzr invoked at %s\n' % bzrlib.osutils.format_date(time.time()))
93
 
    t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
94
 
    t.write('  arguments: %r\n' % argv)
95
 
 
96
 
    import platform
97
 
    t.write('  platform: %s\n' % platform.platform())
98
 
    t.write('  python: %s\n' % platform.python_version())
99
 
 
100
 
    import atexit
101
 
    atexit.register(_close_trace)
102
 
 
103
 
 
104
 
def _close_trace():
 
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():
105
138
    times = os.times()
106
139
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
107
140
           % (times[:4] + ((times[4] - _starttime),)))
108
141
 
109
142
 
110
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