← 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-30 01:39:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050530013913-4ac43c29e1302170
- make sure any bzr output is flushed before 
  running external diff

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
20
17
__author__ = "Martin Pool <mbp@canonical.com>"
21
18
 
22
19
 
23
 
import sys, os, time, socket, stat, codecs
24
 
import bzrlib
 
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
25
27
 
26
28
######################################################################
27
29
# messages and logging
28
30
 
29
 
## TODO: If --verbose is given then write to both stderr and
30
 
## _tracefile; perhaps replace _tracefile with a tee thing.
31
 
 
32
31
global _tracefile, _starttime
33
32
_tracefile = None
34
33
 
40
39
silent = False
41
40
 
42
41
 
43
 
# TODO: Somehow tie this to the --verbose option?
44
 
verbose = False
45
 
 
46
 
 
47
42
# fix this if we ever fork within python
48
43
_mypid = os.getpid()
49
44
_logprefix = '[%d] ' % _mypid
50
45
 
51
46
 
52
47
def _write_trace(msg):
53
 
    _tracefile.write(_logprefix + msg + '\n')
 
48
    if _tracefile:
 
49
        _tracefile.write(_logprefix + msg + '\n')
54
50
 
55
51
 
56
52
def warning(msg):
73
69
    _write_trace(msg)
74
70
 
75
71
 
76
 
# TODO: Something to log exceptions in here.
77
 
 
78
 
 
79
 
 
80
72
def _rollover_trace_maybe(trace_fname):
 
73
    import stat
81
74
    try:
82
75
        size = os.stat(trace_fname)[stat.ST_SIZE]
83
 
        if size <= 1 << 20:
 
76
        if size <= 4 << 20:
84
77
            return
85
78
        old_fname = trace_fname + '.old'
86
79
 
100
93
 
101
94
 
102
95
 
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
 
 
 
96
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
108
97
    # Messages are always written to here, so that we have some
109
98
    # information if something goes wrong.  In a future version this
110
99
    # file will be removed on successful completion.
111
100
    global _starttime, _tracefile
 
101
    import stat, codecs
112
102
 
113
103
    _starttime = os.times()[4]
114
104
 
115
 
    trace_fname = os.path.join(os.path.expanduser('~/.bzr.log'))
 
105
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
116
106
    _rollover_trace_maybe(trace_fname)
117
107
 
118
108
    # 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
 
 
 
109
    try:
 
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
        import bzrlib
 
119
        _write_trace('bzr %s invoked on python %s (%s)'
 
120
                     % (bzrlib.__version__,
 
121
                        '.'.join(map(str, sys.version_info)),
 
122
                        sys.platform))
 
123
 
 
124
        _write_trace('  arguments: %r' % argv)
 
125
        _write_trace('  working dir: ' + os.getcwdu())
 
126
    except IOError, e:
 
127
        warning("failed to open trace file: %s" % (e))
138
128
 
139
129
def close_trace():
140
130
    times = os.times()
143
133
 
144
134
 
145
135
 
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'):
 
136
def log_exception():
 
137
    """Log the last exception into the trace file."""
 
138
    import cgitb
 
139
    s = cgitb.text(sys.exc_info())
 
140
    for l in s.split('\n'):
151
141
        _write_trace(l)
152
142
        
153
143