← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lsprof.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-10 06:09:30 UTC
  • mfrom: (5409.4.1 ui-factory)
  • Revision ID: pqm@pqm.ubuntu.com-20100910060930-0ukm0h7txwadstll
(mbp) split out ui-factory docs (Martin Pool)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lsprof.py
112
112
 
113
113
 
114
114
class Stats(object):
115
 
    """Wrapper around the collected data.
116
 
 
117
 
    A Stats instance is created when the profiler finishes. Normal
118
 
    usage is to use save() to write out the data to a file, or pprint()
119
 
    to write human-readable information to the command line.
120
 
    """
 
115
    """XXX docstring"""
121
116
 
122
117
    def __init__(self, data, threads):
123
118
        self.data = data
124
119
        self.threads = threads
125
120
 
126
121
    def sort(self, crit="inlinetime"):
127
 
        """Sort the data by the supplied critera.
128
 
 
129
 
        :param crit: the data attribute used as the sort key."""
 
122
        """XXX docstring"""
130
123
        if crit not in profiler_entry.__dict__:
131
124
            raise ValueError, "Can't sort by %s" % crit
132
125
        self.data.sort(lambda b, a: cmp(getattr(a, crit),
137
130
                                              getattr(b, crit)))
138
131
 
139
132
    def pprint(self, top=None, file=None):
140
 
        """Pretty-print the data as plain text for human consumption.
141
 
 
142
 
        :param top: only output the top n entries.
143
 
            The default value of None means output all data.
144
 
        :param file: the output file; if None, output will
145
 
            default to stdout."""
 
133
        """XXX docstring"""
146
134
        if file is None:
147
135
            file = sys.stdout
148
136
        d = self.data