← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/status.py
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
16
 
17
17
import sys
18
18
 
19
19
from bzrlib import (
20
20
    delta as _mod_delta,
 
21
    hooks as _mod_hooks,
21
22
    log,
22
23
    osutils,
23
 
    tree,
24
24
    tsort,
25
25
    revision as _mod_revision,
26
26
    )
27
 
from bzrlib.diff import _raise_if_nonexistent
28
27
import bzrlib.errors as errors
29
 
from bzrlib.osutils import is_inside_any
30
 
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        )
32
 
from bzrlib.trace import warning
 
28
from bzrlib.trace import mutter, warning
33
29
 
34
30
# TODO: when showing single-line logs, truncate to the width of the terminal
35
31
# if known, but only if really going to the terminal (not into a file)
36
32
 
37
33
 
 
34
def report_changes(to_file, old, new, specific_files, 
 
35
                   show_short_reporter, show_long_callback, 
 
36
                   short=False, want_unchanged=False, 
 
37
                   want_unversioned=False, show_ids=False, classify=True):
 
38
    """Display summary of changes.
 
39
 
 
40
    This compares two trees with regards to a list of files, and delegates 
 
41
    the display to underlying elements.
 
42
 
 
43
    For short output, it creates an iterator on all changes, and lets a given
 
44
    reporter display these changes.
 
45
 
 
46
    For stantard output, it creates a delta of the changes, and forwards it
 
47
    to a callback
 
48
 
 
49
    :param to_file: If set, write to this file (default stdout.)
 
50
    :param old: Start tree for the comparison
 
51
    :param end: End tree for the comparison
 
52
    :param specific_files: If set, a list of filenames whose status should be
 
53
        shown.  It is an error to give a filename that is not in the working
 
54
        tree, or in the working inventory or in the basis inventory.
 
55
    :param show_short_reporter: Reporter in charge of display for short output
 
56
    :param show_long_callback: Callback in charge of display for normal output
 
57
    :param short: If True, gives short SVN-style status lines.
 
58
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
 
59
        files.
 
60
    :param show_ids: If set, includes each file's id.
 
61
    :param want_unversioned: If False, only shows versioned files.
 
62
    :param classify: Add special symbols to indicate file kind.
 
63
    """
 
64
 
 
65
    if short:
 
66
        changes = new.iter_changes(old, want_unchanged, specific_files,
 
67
            require_versioned=False, want_unversioned=want_unversioned)
 
68
        _mod_delta.report_changes(changes, show_short_reporter)
 
69
        
 
70
    else:
 
71
        delta = new.changes_from(old, want_unchanged=want_unchanged,
 
72
                              specific_files=specific_files,
 
73
                              want_unversioned=want_unversioned)
 
74
        # filter out unknown files. We may want a tree method for
 
75
        # this
 
76
        delta.unversioned = [unversioned for unversioned in
 
77
            delta.unversioned if not new.is_ignored(unversioned[0])]
 
78
        show_long_callback(to_file, delta, 
 
79
                           show_ids=show_ids,
 
80
                           show_unchanged=want_unchanged,
 
81
                           classify=classify)
 
82
 
 
83
 
38
84
def show_tree_status(wt, show_unchanged=None,
39
85
                     specific_files=None,
40
86
                     show_ids=False,
42
88
                     show_pending=True,
43
89
                     revision=None,
44
90
                     short=False,
45
 
                     versioned=False):
 
91
                     verbose=False,
 
92
                     versioned=False,
 
93
                     classify=True,
 
94
                     show_long_callback=_mod_delta.report_delta):
46
95
    """Display summary of changes.
47
96
 
48
 
    By default this compares the working tree to a previous revision. 
49
 
    If the revision argument is given, summarizes changes between the 
 
97
    By default this compares the working tree to a previous revision.
 
98
    If the revision argument is given, summarizes changes between the
50
99
    working tree and another, or between two revisions.
51
100
 
52
 
    The result is written out as Unicode and to_file should be able 
 
101
    The result is written out as Unicode and to_file should be able
53
102
    to encode that.
54
103
 
55
104
    If showing the status of a working tree, extra information is included
56
105
    about unknown files, conflicts, and pending merges.
57
106
 
58
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
107
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
59
108
        files.
60
109
    :param specific_files: If set, a list of filenames whose status should be
61
 
        shown.  It is an error to give a filename that is not in the working 
 
110
        shown.  It is an error to give a filename that is not in the working
62
111
        tree, or in the working inventory or in the basis inventory.
63
112
    :param show_ids: If set, includes each file's id.
64
113
    :param to_file: If set, write to this file (default stdout.)
68
117
        If one revision, compare with working tree.
69
118
        If two revisions, show status between first and second.
70
119
    :param short: If True, gives short SVN-style status lines.
 
120
    :param verbose: If True, show all merged revisions, not just
 
121
        the merge tips
71
122
    :param versioned: If True, only shows versioned files.
 
123
    :param classify: Add special symbols to indicate file kind.
 
124
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
 
125
        show_ids, show_unchanged, indent, filter), only used with the long output
72
126
    """
73
127
    if show_unchanged is not None:
74
128
        warn("show_tree_status with show_unchanged has been deprecated "
76
130
 
77
131
    if to_file is None:
78
132
        to_file = sys.stdout
79
 
    
 
133
 
80
134
    wt.lock_read()
81
135
    try:
82
136
        new_is_working_tree = True
87
141
            old = new.basis_tree()
88
142
        elif len(revision) > 0:
89
143
            try:
90
 
                rev_id = revision[0].as_revision_id(wt.branch)
91
 
                old = wt.branch.repository.revision_tree(rev_id)
 
144
                old = revision[0].as_tree(wt.branch)
92
145
            except errors.NoSuchRevision, e:
93
146
                raise errors.BzrCommandError(str(e))
94
147
            if (len(revision) > 1) and (revision[1].spec is not None):
95
148
                try:
96
 
                    rev_id = revision[1].as_revision_id(wt.branch)
97
 
                    new = wt.branch.repository.revision_tree(rev_id)
 
149
                    new = revision[1].as_tree(wt.branch)
98
150
                    new_is_working_tree = False
99
151
                except errors.NoSuchRevision, e:
100
152
                    raise errors.BzrCommandError(str(e))
103
155
        old.lock_read()
104
156
        new.lock_read()
105
157
        try:
106
 
            _raise_if_nonexistent(specific_files, old, new)
 
158
            for hook in hooks['pre_status']:
 
159
                hook(StatusHookParams(old, new, to_file, versioned,
 
160
                    show_ids, short, verbose))
 
161
 
 
162
            specific_files, nonexistents \
 
163
                = _filter_nonexistent(specific_files, old, new)
107
164
            want_unversioned = not versioned
108
 
            if short:
109
 
                changes = new.iter_changes(old, show_unchanged, specific_files,
110
 
                    require_versioned=False, want_unversioned=want_unversioned)
111
 
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
112
 
                    unversioned_filter=new.is_ignored)
113
 
                _mod_delta.report_changes(changes, reporter)
114
 
            else:
115
 
                delta = new.changes_from(old, want_unchanged=show_unchanged,
116
 
                                      specific_files=specific_files,
117
 
                                      want_unversioned=want_unversioned)
118
 
                # filter out unknown files. We may want a tree method for
119
 
                # this
120
 
                delta.unversioned = [unversioned for unversioned in
121
 
                    delta.unversioned if not new.is_ignored(unversioned[0])]
122
 
                delta.show(to_file,
123
 
                           show_ids=show_ids,
124
 
                           show_unchanged=show_unchanged,
125
 
                           short_status=False)
 
165
 
 
166
            # Reporter used for short outputs
 
167
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
168
                unversioned_filter=new.is_ignored, classify=classify)
 
169
            report_changes(to_file, old, new, specific_files, 
 
170
                           reporter, show_long_callback, 
 
171
                           short=short, want_unchanged=show_unchanged, 
 
172
                           want_unversioned=want_unversioned, show_ids=show_ids,
 
173
                           classify=classify)
 
174
 
 
175
            # show the ignored files among specific files (i.e. show the files
 
176
            # identified from input that we choose to ignore). 
 
177
            if specific_files is not None:
 
178
                # Ignored files is sorted because specific_files is already sorted
 
179
                ignored_files = [specific for specific in
 
180
                    specific_files if new.is_ignored(specific)]
 
181
                if len(ignored_files) > 0 and not short:
 
182
                    to_file.write("ignored:\n")
 
183
                    prefix = ' '
 
184
                else:
 
185
                    prefix = 'I  '
 
186
                for ignored_file in ignored_files:
 
187
                    to_file.write("%s %s\n" % (prefix, ignored_file))
 
188
 
126
189
            # show the new conflicts only for now. XXX: get them from the
127
190
            # delta.
128
191
            conflicts = new.conflicts()
136
199
                    prefix = 'C  '
137
200
                else:
138
201
                    prefix = ' '
139
 
                to_file.write("%s %s\n" % (prefix, conflict))
 
202
                to_file.write("%s %s\n" % (prefix, unicode(conflict)))
 
203
            # Show files that were requested but don't exist (and are
 
204
            # not versioned).  We don't involve delta in this; these
 
205
            # paths are really the province of just the status
 
206
            # command, since they have more to do with how it was
 
207
            # invoked than with the tree it's operating on.
 
208
            if nonexistents and not short:
 
209
                to_file.write("nonexistent:\n")
 
210
            for nonexistent in nonexistents:
 
211
                # We could calculate prefix outside the loop but, given
 
212
                # how rarely this ought to happen, it's OK and arguably
 
213
                # slightly faster to do it here (ala conflicts above)
 
214
                if short:
 
215
                    prefix = 'X  '
 
216
                else:
 
217
                    prefix = ' '
 
218
                to_file.write("%s %s\n" % (prefix, nonexistent))
140
219
            if (new_is_working_tree and show_pending):
141
 
                show_pending_merges(new, to_file, short)
 
220
                show_pending_merges(new, to_file, short, verbose=verbose)
 
221
            if nonexistents:
 
222
                raise errors.PathsDoNotExist(nonexistents)
 
223
            for hook in hooks['post_status']:
 
224
                hook(StatusHookParams(old, new, to_file, versioned,
 
225
                    show_ids, short, verbose))
142
226
        finally:
143
227
            old.unlock()
144
228
            new.unlock()
172
256
    return sorter.iter_topo_order()
173
257
 
174
258
 
175
 
def show_pending_merges(new, to_file, short=False):
 
259
def show_pending_merges(new, to_file, short=False, verbose=False):
176
260
    """Write out a display of pending merges in a working tree."""
177
261
    parents = new.get_parent_ids()
178
262
    if len(parents) < 2:
179
263
        return
180
264
 
181
 
    # we need one extra space for terminals that wrap on last char
182
 
    term_width = osutils.terminal_width() - 1
 
265
    term_width = osutils.terminal_width()
 
266
    if term_width is not None:
 
267
        # we need one extra space for terminals that wrap on last char
 
268
        term_width = term_width - 1
183
269
    if short:
184
270
        first_prefix = 'P   '
185
271
        sub_prefix = 'P.   '
187
273
        first_prefix = '  '
188
274
        sub_prefix = '    '
189
275
 
 
276
    def show_log_message(rev, prefix):
 
277
        if term_width is None:
 
278
            width = term_width
 
279
        else:
 
280
            width = term_width - len(prefix)
 
281
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
 
282
        to_file.write(log_message + '\n')
 
283
 
190
284
    pending = parents[1:]
191
285
    branch = new.branch
192
286
    last_revision = parents[0]
193
287
    if not short:
194
 
        to_file.write('pending merges:\n')
 
288
        if verbose:
 
289
            to_file.write('pending merges:\n')
 
290
        else:
 
291
            to_file.write('pending merge tips:'
 
292
                          ' (use -v to see all merge revisions)\n')
195
293
    graph = branch.repository.get_graph()
196
294
    other_revisions = [last_revision]
197
295
    log_formatter = log.LineLogFormatter(to_file)
205
303
            continue
206
304
 
207
305
        # Log the merge, as it gets a slightly different formatting
208
 
        log_message = log_formatter.log_string(None, rev,
209
 
                        term_width - len(first_prefix))
210
 
        to_file.write(first_prefix + log_message + '\n')
 
306
        show_log_message(rev, first_prefix)
 
307
        if not verbose:
 
308
            continue
 
309
 
211
310
        # Find all of the revisions in the merge source, which are not in the
212
311
        # last committed revision.
213
312
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
242
341
            if rev is None:
243
342
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
244
343
                continue
245
 
            log_message = log_formatter.log_string(None,
246
 
                            revisions[sub_merge],
247
 
                            term_width - len(sub_prefix))
248
 
            to_file.write(sub_prefix + log_message + '\n')
 
344
            show_log_message(revisions[sub_merge], sub_prefix)
 
345
 
 
346
 
 
347
def _filter_nonexistent(orig_paths, old_tree, new_tree):
 
348
    """Convert orig_paths to two sorted lists and return them.
 
349
 
 
350
    The first is orig_paths paths minus the items in the second list,
 
351
    and the second list is paths that are not in either inventory or
 
352
    tree (they don't qualify if they exist in the tree's inventory, or
 
353
    if they exist in the tree but are not versioned.)
 
354
 
 
355
    If either of the two lists is empty, return it as an empty list.
 
356
 
 
357
    This can be used by operations such as bzr status that can accept
 
358
    unknown or ignored files.
 
359
    """
 
360
    mutter("check paths: %r", orig_paths)
 
361
    if not orig_paths:
 
362
        return orig_paths, []
 
363
    s = old_tree.filter_unversioned_files(orig_paths)
 
364
    s = new_tree.filter_unversioned_files(s)
 
365
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
 
366
    remaining   = [path for path in orig_paths if not path in nonexistent]
 
367
    # Sorting the 'remaining' list doesn't have much effect in
 
368
    # practice, since the various status output sections will sort
 
369
    # their groups individually.  But for consistency of this
 
370
    # function's API, it's better to sort both than just 'nonexistent'.
 
371
    return sorted(remaining), sorted(nonexistent)
 
372
 
 
373
 
 
374
class StatusHooks(_mod_hooks.Hooks):
 
375
    """A dictionary mapping hook name to a list of callables for status hooks.
 
376
 
 
377
    e.g. ['post_status'] Is the list of items to be called when the
 
378
    status command has finished printing the status.
 
379
    """
 
380
 
 
381
    def __init__(self):
 
382
        """Create the default hooks.
 
383
 
 
384
        These are all empty initially, because by default nothing should get
 
385
        notified.
 
386
        """
 
387
        _mod_hooks.Hooks.__init__(self, "bzrlib.status", "hooks")
 
388
        self.add_hook('post_status',
 
389
            "Called with argument StatusHookParams after Bazaar has "
 
390
            "displayed the status. StatusHookParams has the attributes "
 
391
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
392
            "verbose). The last four arguments correspond to the command "
 
393
            "line options specified by the user for the status command. "
 
394
            "to_file is the output stream for writing.",
 
395
            (2, 3))
 
396
        self.add_hook('pre_status',
 
397
            "Called with argument StatusHookParams before Bazaar "
 
398
            "displays the status. StatusHookParams has the attributes "
 
399
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
400
            "verbose). The last four arguments correspond to the command "
 
401
            "line options specified by the user for the status command. "
 
402
            "to_file is the output stream for writing.",
 
403
            (2, 3))
 
404
 
 
405
 
 
406
class StatusHookParams(object):
 
407
    """Object holding parameters passed to post_status hooks.
 
408
 
 
409
    :ivar old_tree: Start tree (basis tree) for comparison.
 
410
    :ivar new_tree: Working tree.
 
411
    :ivar to_file: If set, write to this file.
 
412
    :ivar versioned: Show only versioned files.
 
413
    :ivar show_ids: Show internal object ids.
 
414
    :ivar short: Use short status indicators.
 
415
    :ivar verbose: Verbose flag.
 
416
    """
 
417
 
 
418
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
 
419
            short, verbose):
 
420
        """Create a group of post_status hook parameters.
 
421
 
 
422
        :param old_tree: Start tree (basis tree) for comparison.
 
423
        :param new_tree: Working tree.
 
424
        :param to_file: If set, write to this file.
 
425
        :param versioned: Show only versioned files.
 
426
        :param show_ids: Show internal object ids.
 
427
        :param short: Use short status indicators.
 
428
        :param verbose: Verbose flag.
 
429
        """
 
430
        self.old_tree = old_tree
 
431
        self.new_tree = new_tree
 
432
        self.to_file = to_file
 
433
        self.versioned = versioned
 
434
        self.show_ids = show_ids
 
435
        self.short = short
 
436
        self.verbose = verbose
 
437
 
 
438
    def __eq__(self, other):
 
439
        return self.__dict__ == other.__dict__
 
440
 
 
441
    def __repr__(self):
 
442
        return "<%s(%s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
 
443
            self.old_tree, self.new_tree, self.to_file, self.versioned,
 
444
            self.show_ids, self.short, self.verbose)
 
445
 
 
446
 
 
447
def _show_shelve_summary(params):
 
448
    """post_status hook to display a summary of shelves.
 
449
 
 
450
    :param params: StatusHookParams.
 
451
    """
 
452
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
 
453
    if get_shelf_manager is None:
 
454
        return
 
455
    manager = get_shelf_manager()
 
456
    shelves = manager.active_shelves()
 
457
    if shelves:
 
458
        singular = '%d shelf exists. '
 
459
        plural = '%d shelves exist. '
 
460
        if len(shelves) == 1:
 
461
            fmt = singular
 
462
        else:
 
463
            fmt = plural
 
464
        params.to_file.write(fmt % len(shelves))
 
465
        params.to_file.write('See "bzr shelve --list" for details.\n')
 
466
 
 
467
 
 
468
hooks = StatusHooks()
 
469
 
 
470
 
 
471
hooks.install_named_hook('post_status', _show_shelve_summary,
 
472
    'bzr status')
 
473