~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Martin Pool
  • Date: 2005-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
 
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
 
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
 
 
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
20
__author__ = "Martin Pool <mbp@canonical.com>"
 
21
 
 
22
 
 
23
import sys, os, time, socket, stat, codecs
 
24
import bzrlib
 
25
 
 
26
######################################################################
 
27
# messages and logging
 
28
 
 
29
## TODO: If --verbose is given then write to both stderr and
 
30
## _tracefile; perhaps replace _tracefile with a tee thing.
 
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
# TODO: Somehow tie this to the --verbose option?
 
44
verbose = False
 
45
 
 
46
 
 
47
# fix this if we ever fork within python
 
48
_mypid = os.getpid()
 
49
_logprefix = '[%d] ' % _mypid
 
50
 
 
51
 
 
52
def _write_trace(msg):
 
53
    _tracefile.write(_logprefix + msg + '\n')
 
54
 
 
55
 
 
56
def warning(msg):
 
57
    sys.stderr.write('bzr: warning: ' + msg + '\n')
 
58
    _write_trace('warning: ' + msg)
 
59
 
 
60
 
 
61
mutter = _write_trace
 
62
 
 
63
 
 
64
def note(msg):
 
65
    b = '* ' + str(msg) + '\n'
 
66
    if not silent:
 
67
        sys.stderr.write(b)
 
68
    _write_trace('note: ' + msg)
 
69
 
 
70
 
 
71
def log_error(msg):
 
72
    sys.stderr.write(msg + '\n')
 
73
    _write_trace(msg)
 
74
 
 
75
 
 
76
# TODO: Something to log exceptions in here.
 
77
 
 
78
 
 
79
 
 
80
def _rollover_trace_maybe(trace_fname):
 
81
    try:
 
82
        size = os.stat(trace_fname)[stat.ST_SIZE]
 
83
        if size <= 1 << 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 create_tracefile(argv):
 
104
    # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
 
105
    #       Perhaps that should eventually go into the platform library?
 
106
    # TODO: If the file doesn't exist, add a note describing it.
 
107
 
 
108
    # Messages are always written to here, so that we have some
 
109
    # information if something goes wrong.  In a future version this
 
110
    # file will be removed on successful completion.
 
111
    global _starttime, _tracefile
 
112
 
 
113
    _starttime = os.times()[4]
 
114
 
 
115
    trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
 
116
    _rollover_trace_maybe(trace_fname)
 
117
 
 
118
    # buffering=1 means line buffered
 
119
    _tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
 
120
    t = _tracefile
 
121
 
 
122
    if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
 
123
        t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
124
        t.write("you can delete or truncate this file, or include sections in\n")
 
125
        t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
126
 
 
127
    # TODO: If we failed to create the file, perhaps give a warning
 
128
    # but don't abort; send things to /dev/null instead?
 
129
 
 
130
    _write_trace('bzr %s invoked on python %s (%s)'
 
131
                 % (bzrlib.__version__,
 
132
                    '.'.join(map(str, sys.version_info)),
 
133
                    sys.platform))
 
134
 
 
135
    _write_trace('  arguments: %r' % argv)
 
136
    _write_trace('  working dir: ' + os.getcwdu())
 
137
 
 
138
 
 
139
def close_trace():
 
140
    times = os.times()
 
141
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
 
142
           % (times[:4] + ((times[4] - _starttime),)))
 
143
 
 
144
 
 
145
 
 
146
def log_exception(e):
 
147
    import traceback, cStringIO
 
148
    s = cStringIO.StringIO()
 
149
    traceback.print_exc(None, s)
 
150
    for l in s.getvalue().split('\n'):
 
151
        _write_trace(l)
 
152
        
 
153