← 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-04-09 06:21:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050409062144-e47a4b64106e4c21af99beaf
debug output

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
# 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
def warning(msg):
 
48
    b = 'bzr: warning: ' + msg + '\n'
 
49
    sys.stderr.write(b)
 
50
    _tracefile.write(b)
 
51
    #_tracefile.flush()
 
52
 
 
53
def mutter(msg):
 
54
    _tracefile.write(msg)
 
55
    _tracefile.write('\n')
 
56
    # _tracefile.flush()
 
57
    if verbose:
 
58
        sys.stderr.write('- ' + msg + '\n')
 
59
 
 
60
 
 
61
def note(msg):
 
62
    b = '* ' + str(msg) + '\n'
 
63
    if not silent:
 
64
        sys.stderr.write(b)
 
65
    _tracefile.write(b)
 
66
    # _tracefile.flush()
 
67
 
 
68
 
 
69
def log_error(msg):
 
70
    sys.stderr.write(msg)
 
71
    _tracefile.write(msg)
 
72
    # _tracefile.flush()
 
73
 
 
74
 
 
75
 
 
76
def create_tracefile(argv):
 
77
    # TODO: Also show contents of /etc/lsb-release, if it can be parsed.
 
78
    #       Perhaps that should eventually go into the platform library?
 
79
    # TODO: If the file doesn't exist, add a note describing it.
 
80
 
 
81
    # Messages are always written to here, so that we have some
 
82
    # information if something goes wrong.  In a future version this
 
83
    # file will be removed on successful completion.
 
84
    global _starttime, _tracefile
 
85
 
 
86
    _starttime = os.times()[4]
 
87
 
 
88
    # XXX: Is HOME always set on Windows?
 
89
    trace_fname = os.path.join(os.environ['HOME'], '.bzr.log')
 
90
    _tracefile = codecs.open(trace_fname, 'at', 'utf8')
 
91
    t = _tracefile
 
92
 
 
93
    if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
 
94
        t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
95
        t.write("you can delete or truncate this file, or include sections in\n")
 
96
        t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
97
 
 
98
    # TODO: If we failed to create the file, perhaps give a warning
 
99
    # but don't abort; send things to /dev/null instead?
 
100
 
 
101
    
 
102
    t.write('-' * 60 + '\n')
 
103
    t.write('bzr invoked at %s\n' % bzrlib.osutils.format_date(time.time()))
 
104
    t.write('  version: %s\n' % bzrlib.__version__)
 
105
    t.write('  by %s on %s\n' % (bzrlib.osutils.username(), socket.getfqdn()))
 
106
    t.write('  arguments: %r\n' % argv)
 
107
    t.write('  working dir: %s\n' % os.getcwdu())
 
108
 
 
109
    t.write('  platform: %s\n' % sys.platform)
 
110
    t.write('  python: %s\n' % (sys.version_info,))
 
111
 
 
112
    import atexit
 
113
    atexit.register(_close_trace)
 
114
 
 
115
 
 
116
def _close_trace():
 
117
    times = os.times()
 
118
    mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
 
119
           % (times[:4] + ((times[4] - _starttime),)))
 
120
 
 
121
 
 
122