~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
16
18
 
17
19
import sys
18
20
 
19
21
from bzrlib import (
20
22
    delta as _mod_delta,
21
 
    tree,
 
23
    hooks as _mod_hooks,
 
24
    log,
 
25
    osutils,
 
26
    tsort,
 
27
    revision as _mod_revision,
22
28
    )
23
 
from bzrlib.diff import _raise_if_nonexistent
24
29
import bzrlib.errors as errors
25
 
from bzrlib.log import line_log
26
 
from bzrlib.osutils import is_inside_any
27
 
from bzrlib.symbol_versioning import (deprecated_function,
28
 
        zero_eight,
29
 
        )
30
 
from bzrlib.trace import warning
 
30
from bzrlib.trace import mutter, warning
31
31
 
32
32
# TODO: when showing single-line logs, truncate to the width of the terminal
33
33
# if known, but only if really going to the terminal (not into a file)
34
34
 
35
35
 
36
 
@deprecated_function(zero_eight)
37
 
def show_status(branch, show_unchanged=None,
38
 
                specific_files=None,
39
 
                show_ids=False,
40
 
                to_file=None,
41
 
                show_pending=True,
42
 
                revision=None):
 
36
def report_changes(to_file, old, new, specific_files, 
 
37
                   show_short_reporter, show_long_callback, 
 
38
                   short=False, want_unchanged=False, 
 
39
                   want_unversioned=False, show_ids=False, classify=True):
43
40
    """Display summary of changes.
44
41
 
45
 
    Please use show_tree_status instead.
46
 
 
47
 
    By default this compares the working tree to a previous revision. 
48
 
    If the revision argument is given, summarizes changes between the 
49
 
    working tree and another, or between two revisions.
50
 
 
51
 
    The result is written out as Unicode and to_file should be able 
52
 
    to encode that.
53
 
 
54
 
    show_unchanged
55
 
        If set, includes unchanged files.
56
 
 
57
 
    specific_files
58
 
        If set, only show the status of files in this list.
59
 
 
60
 
    show_ids
61
 
        If set, includes each file's id.
62
 
 
63
 
    to_file
64
 
        If set, write to this file (default stdout.)
65
 
 
66
 
    show_pending
67
 
        If set, write pending merges.
68
 
 
69
 
    revision
70
 
        If None the compare latest revision with working tree
71
 
        If one revision show compared it with working tree.
72
 
        If two revisions show status between first and second.
 
42
    This compares two trees with regards to a list of files, and delegates 
 
43
    the display to underlying elements.
 
44
 
 
45
    For short output, it creates an iterator on all changes, and lets a given
 
46
    reporter display these changes.
 
47
 
 
48
    For stantard output, it creates a delta of the changes, and forwards it
 
49
    to a callback
 
50
 
 
51
    :param to_file: If set, write to this file (default stdout.)
 
52
    :param old: Start tree for the comparison
 
53
    :param end: End tree for the comparison
 
54
    :param specific_files: If set, a list of filenames whose status should be
 
55
        shown.  It is an error to give a filename that is not in the working
 
56
        tree, or in the working inventory or in the basis inventory.
 
57
    :param show_short_reporter: Reporter in charge of display for short output
 
58
    :param show_long_callback: Callback in charge of display for normal output
 
59
    :param short: If True, gives short SVN-style status lines.
 
60
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
 
61
        files.
 
62
    :param show_ids: If set, includes each file's id.
 
63
    :param want_unversioned: If False, only shows versioned files.
 
64
    :param classify: Add special symbols to indicate file kind.
73
65
    """
74
 
    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 
75
 
                     specific_files, show_ids, to_file, show_pending, revision)
 
66
 
 
67
    if short:
 
68
        changes = new.iter_changes(old, want_unchanged, specific_files,
 
69
            require_versioned=False, want_unversioned=want_unversioned)
 
70
        _mod_delta.report_changes(changes, show_short_reporter)
 
71
        
 
72
    else:
 
73
        delta = new.changes_from(old, want_unchanged=want_unchanged,
 
74
                              specific_files=specific_files,
 
75
                              want_unversioned=want_unversioned)
 
76
        # filter out unknown files. We may want a tree method for
 
77
        # this
 
78
        delta.unversioned = [unversioned for unversioned in
 
79
            delta.unversioned if not new.is_ignored(unversioned[0])]
 
80
        show_long_callback(to_file, delta, 
 
81
                           show_ids=show_ids,
 
82
                           show_unchanged=want_unchanged,
 
83
                           classify=classify)
76
84
 
77
85
 
78
86
def show_tree_status(wt, show_unchanged=None,
82
90
                     show_pending=True,
83
91
                     revision=None,
84
92
                     short=False,
85
 
                     versioned=False):
 
93
                     verbose=False,
 
94
                     versioned=False,
 
95
                     classify=True,
 
96
                     show_long_callback=_mod_delta.report_delta):
86
97
    """Display summary of changes.
87
98
 
88
 
    By default this compares the working tree to a previous revision. 
89
 
    If the revision argument is given, summarizes changes between the 
 
99
    By default this compares the working tree to a previous revision.
 
100
    If the revision argument is given, summarizes changes between the
90
101
    working tree and another, or between two revisions.
91
102
 
92
 
    The result is written out as Unicode and to_file should be able 
 
103
    The result is written out as Unicode and to_file should be able
93
104
    to encode that.
94
105
 
95
106
    If showing the status of a working tree, extra information is included
96
107
    about unknown files, conflicts, and pending merges.
97
108
 
98
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
109
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
99
110
        files.
100
111
    :param specific_files: If set, a list of filenames whose status should be
101
 
        shown.  It is an error to give a filename that is not in the working 
 
112
        shown.  It is an error to give a filename that is not in the working
102
113
        tree, or in the working inventory or in the basis inventory.
103
114
    :param show_ids: If set, includes each file's id.
104
115
    :param to_file: If set, write to this file (default stdout.)
105
116
    :param show_pending: If set, write pending merges.
106
 
    :param revision: If None the compare latest revision with working tree
107
 
        If not None it must be a RevisionSpec list.
108
 
        If one revision show compared it with working tree.
109
 
        If two revisions show status between first and second.
 
117
    :param revision: If None, compare latest revision with working tree
 
118
        If not None, it must be a RevisionSpec list.
 
119
        If one revision, compare with working tree.
 
120
        If two revisions, show status between first and second.
110
121
    :param short: If True, gives short SVN-style status lines.
 
122
    :param verbose: If True, show all merged revisions, not just
 
123
        the merge tips
111
124
    :param versioned: If True, only shows versioned files.
 
125
    :param classify: Add special symbols to indicate file kind.
 
126
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
 
127
        show_ids, show_unchanged, indent, filter), only used with the long output
112
128
    """
113
129
    if show_unchanged is not None:
114
 
        warn("show_status_trees with show_unchanged has been deprecated "
 
130
        warn("show_tree_status with show_unchanged has been deprecated "
115
131
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
116
132
 
117
133
    if to_file is None:
118
134
        to_file = sys.stdout
119
 
    
 
135
 
120
136
    wt.lock_read()
121
137
    try:
122
138
        new_is_working_tree = True
127
143
            old = new.basis_tree()
128
144
        elif len(revision) > 0:
129
145
            try:
130
 
                rev_id = revision[0].in_history(wt.branch).rev_id
131
 
                old = wt.branch.repository.revision_tree(rev_id)
 
146
                old = revision[0].as_tree(wt.branch)
132
147
            except errors.NoSuchRevision, e:
133
148
                raise errors.BzrCommandError(str(e))
134
149
            if (len(revision) > 1) and (revision[1].spec is not None):
135
150
                try:
136
 
                    rev_id = revision[1].in_history(wt.branch).rev_id
137
 
                    new = wt.branch.repository.revision_tree(rev_id)
 
151
                    new = revision[1].as_tree(wt.branch)
138
152
                    new_is_working_tree = False
139
153
                except errors.NoSuchRevision, e:
140
154
                    raise errors.BzrCommandError(str(e))
143
157
        old.lock_read()
144
158
        new.lock_read()
145
159
        try:
146
 
            _raise_if_nonexistent(specific_files, old, new)
 
160
            for hook in hooks['pre_status']:
 
161
                hook(StatusHookParams(old, new, to_file, versioned,
 
162
                    show_ids, short, verbose, specific_files=specific_files))
 
163
 
 
164
            specific_files, nonexistents \
 
165
                = _filter_nonexistent(specific_files, old, new)
147
166
            want_unversioned = not versioned
148
 
            if short:
149
 
                changes = new._iter_changes(old, show_unchanged, specific_files,
150
 
                    require_versioned=False, want_unversioned=want_unversioned)
151
 
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
152
 
                    unversioned_filter=new.is_ignored)
153
 
                _mod_delta.report_changes(changes, reporter)
154
 
            else:
155
 
                delta = new.changes_from(old, want_unchanged=show_unchanged,
156
 
                                      specific_files=specific_files,
157
 
                                      want_unversioned=want_unversioned)
158
 
                # filter out unknown files. We may want a tree method for
159
 
                # this
160
 
                delta.unversioned = [unversioned for unversioned in
161
 
                    delta.unversioned if not new.is_ignored(unversioned[0])]
162
 
                delta.show(to_file,
163
 
                           show_ids=show_ids,
164
 
                           show_unchanged=show_unchanged,
165
 
                           short_status=False)
166
 
            conflict_title = False
167
 
            # show the new conflicts only for now. XXX: get them from the delta.
168
 
            for conflict in new.conflicts():
169
 
                if not short and conflict_title is False:
170
 
                    print >> to_file, "conflicts:"
171
 
                    conflict_title = True
 
167
 
 
168
            # Reporter used for short outputs
 
169
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
170
                unversioned_filter=new.is_ignored, classify=classify)
 
171
            report_changes(to_file, old, new, specific_files, 
 
172
                           reporter, show_long_callback, 
 
173
                           short=short, want_unchanged=show_unchanged, 
 
174
                           want_unversioned=want_unversioned, show_ids=show_ids,
 
175
                           classify=classify)
 
176
 
 
177
            # show the ignored files among specific files (i.e. show the files
 
178
            # identified from input that we choose to ignore). 
 
179
            if specific_files is not None:
 
180
                # Ignored files is sorted because specific_files is already sorted
 
181
                ignored_files = [specific for specific in
 
182
                    specific_files if new.is_ignored(specific)]
 
183
                if len(ignored_files) > 0 and not short:
 
184
                    to_file.write("ignored:\n")
 
185
                    prefix = ' '
 
186
                else:
 
187
                    prefix = 'I  '
 
188
                for ignored_file in ignored_files:
 
189
                    to_file.write("%s %s\n" % (prefix, ignored_file))
 
190
 
 
191
            # show the new conflicts only for now. XXX: get them from the
 
192
            # delta.
 
193
            conflicts = new.conflicts()
 
194
            if specific_files is not None:
 
195
                conflicts = conflicts.select_conflicts(new, specific_files,
 
196
                    ignore_misses=True, recurse=True)[1]
 
197
            if len(conflicts) > 0 and not short:
 
198
                to_file.write("conflicts:\n")
 
199
            for conflict in conflicts:
172
200
                if short:
173
201
                    prefix = 'C  '
174
202
                else:
175
203
                    prefix = ' '
176
 
                print >> to_file, "%s %s" % (prefix, conflict)
177
 
            if new_is_working_tree and show_pending:
178
 
                show_pending_merges(new, to_file, short)
 
204
                to_file.write("%s %s\n" % (prefix, unicode(conflict)))
 
205
            # Show files that were requested but don't exist (and are
 
206
            # not versioned).  We don't involve delta in this; these
 
207
            # paths are really the province of just the status
 
208
            # command, since they have more to do with how it was
 
209
            # invoked than with the tree it's operating on.
 
210
            if nonexistents and not short:
 
211
                to_file.write("nonexistent:\n")
 
212
            for nonexistent in nonexistents:
 
213
                # We could calculate prefix outside the loop but, given
 
214
                # how rarely this ought to happen, it's OK and arguably
 
215
                # slightly faster to do it here (ala conflicts above)
 
216
                if short:
 
217
                    prefix = 'X  '
 
218
                else:
 
219
                    prefix = ' '
 
220
                to_file.write("%s %s\n" % (prefix, nonexistent))
 
221
            if (new_is_working_tree and show_pending):
 
222
                show_pending_merges(new, to_file, short, verbose=verbose)
 
223
            if nonexistents:
 
224
                raise errors.PathsDoNotExist(nonexistents)
 
225
            for hook in hooks['post_status']:
 
226
                hook(StatusHookParams(old, new, to_file, versioned,
 
227
                    show_ids, short, verbose, specific_files=specific_files))
179
228
        finally:
180
229
            old.unlock()
181
230
            new.unlock()
182
231
    finally:
183
232
        wt.unlock()
184
233
 
185
 
def show_pending_merges(new, to_file, short=False):
 
234
 
 
235
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
236
    """Get an iterator which will return the revisions in merge sorted order.
 
237
 
 
238
    This will build up a list of all nodes, such that only nodes in the list
 
239
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
240
    order.
 
241
 
 
242
    :param revision_ids: A set of revision_ids
 
243
    :param parent_map: The parent information for each node. Revisions which
 
244
        are considered ghosts should not be present in the map.
 
245
    :return: iterator from MergeSorter.iter_topo_order()
 
246
    """
 
247
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
248
    # of any references pointing outside of this graph.
 
249
    parent_graph = {}
 
250
    for revision_id in revision_ids:
 
251
        if revision_id not in parent_map: # ghost
 
252
            parent_graph[revision_id] = []
 
253
        else:
 
254
            # Only include parents which are in this sub-graph
 
255
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
256
                                            if p in revision_ids]
 
257
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
258
    return sorter.iter_topo_order()
 
259
 
 
260
 
 
261
def show_pending_merges(new, to_file, short=False, verbose=False):
186
262
    """Write out a display of pending merges in a working tree."""
187
263
    parents = new.get_parent_ids()
188
264
    if len(parents) < 2:
189
265
        return
 
266
 
 
267
    term_width = osutils.terminal_width()
 
268
    if term_width is not None:
 
269
        # we need one extra space for terminals that wrap on last char
 
270
        term_width = term_width - 1
 
271
    if short:
 
272
        first_prefix = 'P   '
 
273
        sub_prefix = 'P.   '
 
274
    else:
 
275
        first_prefix = '  '
 
276
        sub_prefix = '    '
 
277
 
 
278
    def show_log_message(rev, prefix):
 
279
        if term_width is None:
 
280
            width = term_width
 
281
        else:
 
282
            width = term_width - len(prefix)
 
283
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
 
284
        to_file.write(log_message + '\n')
 
285
 
190
286
    pending = parents[1:]
191
287
    branch = new.branch
192
288
    last_revision = parents[0]
193
289
    if not short:
194
 
        print >>to_file, 'pending merges:'
195
 
    if last_revision is not None:
196
 
        try:
197
 
            ignore = set(branch.repository.get_ancestry(last_revision))
198
 
        except errors.NoSuchRevision:
199
 
            # the last revision is a ghost : assume everything is new 
200
 
            # except for it
201
 
            ignore = set([None, last_revision])
202
 
    else:
203
 
        ignore = set([None])
204
 
    # TODO: this could be improved using merge_sorted - we'd get the same 
205
 
    # output rather than one level of indent.
 
290
        if verbose:
 
291
            to_file.write('pending merges:\n')
 
292
        else:
 
293
            to_file.write('pending merge tips:'
 
294
                          ' (use -v to see all merge revisions)\n')
 
295
    graph = branch.repository.get_graph()
 
296
    other_revisions = [last_revision]
 
297
    log_formatter = log.LineLogFormatter(to_file)
206
298
    for merge in pending:
207
 
        ignore.add(merge)
208
 
        try:
209
 
            from bzrlib.osutils import terminal_width
210
 
            width = terminal_width()
211
 
            m_revision = branch.repository.get_revision(merge)
212
 
            if short:
213
 
                prefix = 'P  '
214
 
            else:
215
 
                prefix = ' '
216
 
            print >> to_file, prefix, line_log(m_revision, width - 4)
217
 
            inner_merges = branch.repository.get_ancestry(merge)
218
 
            assert inner_merges[0] is None
219
 
            inner_merges.pop(0)
220
 
            inner_merges.reverse()
221
 
            for mmerge in inner_merges:
222
 
                if mmerge in ignore:
223
 
                    continue
224
 
                mm_revision = branch.repository.get_revision(mmerge)
225
 
                if short:
226
 
                    prefix = 'P.  '
 
299
        try:
 
300
            rev = branch.repository.get_revisions([merge])[0]
 
301
        except errors.NoSuchRevision:
 
302
            # If we are missing a revision, just print out the revision id
 
303
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
304
            other_revisions.append(merge)
 
305
            continue
 
306
 
 
307
        # Log the merge, as it gets a slightly different formatting
 
308
        show_log_message(rev, first_prefix)
 
309
        if not verbose:
 
310
            continue
 
311
 
 
312
        # Find all of the revisions in the merge source, which are not in the
 
313
        # last committed revision.
 
314
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
315
        other_revisions.append(merge)
 
316
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
317
 
 
318
        # Get a handle to all of the revisions we will need
 
319
        try:
 
320
            revisions = dict((rev.revision_id, rev) for rev in
 
321
                             branch.repository.get_revisions(merge_extra))
 
322
        except errors.NoSuchRevision:
 
323
            # One of the sub nodes is a ghost, check each one
 
324
            revisions = {}
 
325
            for revision_id in merge_extra:
 
326
                try:
 
327
                    rev = branch.repository.get_revisions([revision_id])[0]
 
328
                except errors.NoSuchRevision:
 
329
                    revisions[revision_id] = None
227
330
                else:
228
 
                    prefix = '   '
229
 
                print >> to_file, prefix, line_log(mm_revision, width - 5)
230
 
                ignore.add(mmerge)
231
 
        except errors.NoSuchRevision:
232
 
            if short:
233
 
                prefix = 'P  '
234
 
            else:
235
 
                prefix = ' '
236
 
            print >> to_file, prefix, merge
 
331
                    revisions[revision_id] = rev
 
332
 
 
333
        # Display the revisions brought in by this merge.
 
334
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
335
                            branch.repository.get_parent_map(merge_extra))
 
336
        # Skip the first node
 
337
        num, first, depth, eom = rev_id_iterator.next()
 
338
        if first != merge:
 
339
            raise AssertionError('Somehow we misunderstood how'
 
340
                ' iter_topo_order works %s != %s' % (first, merge))
 
341
        for num, sub_merge, depth, eom in rev_id_iterator:
 
342
            rev = revisions[sub_merge]
 
343
            if rev is None:
 
344
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
345
                continue
 
346
            show_log_message(revisions[sub_merge], sub_prefix)
 
347
 
 
348
 
 
349
def _filter_nonexistent(orig_paths, old_tree, new_tree):
 
350
    """Convert orig_paths to two sorted lists and return them.
 
351
 
 
352
    The first is orig_paths paths minus the items in the second list,
 
353
    and the second list is paths that are not in either inventory or
 
354
    tree (they don't qualify if they exist in the tree's inventory, or
 
355
    if they exist in the tree but are not versioned.)
 
356
 
 
357
    If either of the two lists is empty, return it as an empty list.
 
358
 
 
359
    This can be used by operations such as bzr status that can accept
 
360
    unknown or ignored files.
 
361
    """
 
362
    mutter("check paths: %r", orig_paths)
 
363
    if not orig_paths:
 
364
        return orig_paths, []
 
365
    s = old_tree.filter_unversioned_files(orig_paths)
 
366
    s = new_tree.filter_unversioned_files(s)
 
367
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
 
368
    remaining   = [path for path in orig_paths if not path in nonexistent]
 
369
    # Sorting the 'remaining' list doesn't have much effect in
 
370
    # practice, since the various status output sections will sort
 
371
    # their groups individually.  But for consistency of this
 
372
    # function's API, it's better to sort both than just 'nonexistent'.
 
373
    return sorted(remaining), sorted(nonexistent)
 
374
 
 
375
 
 
376
class StatusHooks(_mod_hooks.Hooks):
 
377
    """A dictionary mapping hook name to a list of callables for status hooks.
 
378
 
 
379
    e.g. ['post_status'] Is the list of items to be called when the
 
380
    status command has finished printing the status.
 
381
    """
 
382
 
 
383
    def __init__(self):
 
384
        """Create the default hooks.
 
385
 
 
386
        These are all empty initially, because by default nothing should get
 
387
        notified.
 
388
        """
 
389
        _mod_hooks.Hooks.__init__(self, "bzrlib.status", "hooks")
 
390
        self.add_hook('post_status',
 
391
            "Called with argument StatusHookParams after Bazaar has "
 
392
            "displayed the status. StatusHookParams has the attributes "
 
393
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
394
            "verbose). The last four arguments correspond to the command "
 
395
            "line options specified by the user for the status command. "
 
396
            "to_file is the output stream for writing.",
 
397
            (2, 3))
 
398
        self.add_hook('pre_status',
 
399
            "Called with argument StatusHookParams before Bazaar "
 
400
            "displays the status. StatusHookParams has the attributes "
 
401
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
402
            "verbose). The last four arguments correspond to the command "
 
403
            "line options specified by the user for the status command. "
 
404
            "to_file is the output stream for writing.",
 
405
            (2, 3))
 
406
 
 
407
 
 
408
class StatusHookParams(object):
 
409
    """Object holding parameters passed to post_status hooks.
 
410
 
 
411
    :ivar old_tree: Start tree (basis tree) for comparison.
 
412
    :ivar new_tree: Working tree.
 
413
    :ivar to_file: If set, write to this file.
 
414
    :ivar versioned: Show only versioned files.
 
415
    :ivar show_ids: Show internal object ids.
 
416
    :ivar short: Use short status indicators.
 
417
    :ivar verbose: Verbose flag.
 
418
    """
 
419
 
 
420
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
 
421
            short, verbose, specific_files=None):
 
422
        """Create a group of post_status hook parameters.
 
423
 
 
424
        :param old_tree: Start tree (basis tree) for comparison.
 
425
        :param new_tree: Working tree.
 
426
        :param to_file: If set, write to this file.
 
427
        :param versioned: Show only versioned files.
 
428
        :param show_ids: Show internal object ids.
 
429
        :param short: Use short status indicators.
 
430
        :param verbose: Verbose flag.
 
431
        :param specific_files: If set, a list of filenames whose status should be
 
432
            shown.  It is an error to give a filename that is not in the working
 
433
            tree, or in the working inventory or in the basis inventory.
 
434
        """
 
435
        self.old_tree = old_tree
 
436
        self.new_tree = new_tree
 
437
        self.to_file = to_file
 
438
        self.versioned = versioned
 
439
        self.show_ids = show_ids
 
440
        self.short = short
 
441
        self.verbose = verbose
 
442
        self.specific_files = specific_files
 
443
 
 
444
    def __eq__(self, other):
 
445
        return self.__dict__ == other.__dict__
 
446
 
 
447
    def __repr__(self):
 
448
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
 
449
            self.old_tree, self.new_tree, self.to_file, self.versioned,
 
450
            self.show_ids, self.short, self.verbose, self.specific_files)
 
451
 
 
452
 
 
453
def _show_shelve_summary(params):
 
454
    """post_status hook to display a summary of shelves.
 
455
 
 
456
    :param params: StatusHookParams.
 
457
    """
 
458
    # Don't show shelves if status of specific files is being shown, only if
 
459
    # no file arguments have been passed
 
460
    if params.specific_files:
 
461
        return
 
462
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
 
463
    if get_shelf_manager is None:
 
464
        return
 
465
    manager = get_shelf_manager()
 
466
    shelves = manager.active_shelves()
 
467
    if shelves:
 
468
        singular = '%d shelf exists. '
 
469
        plural = '%d shelves exist. '
 
470
        if len(shelves) == 1:
 
471
            fmt = singular
 
472
        else:
 
473
            fmt = plural
 
474
        params.to_file.write(fmt % len(shelves))
 
475
        params.to_file.write('See "bzr shelve --list" for details.\n')
 
476
 
 
477
 
 
478
hooks = StatusHooks()
 
479
 
 
480
 
 
481
hooks.install_named_hook('post_status', _show_shelve_summary,
 
482
    'bzr status')
 
483