/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/status.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import sys
20
18
 
21
 
from . import (
 
19
from bzrlib import (
22
20
    delta as _mod_delta,
23
 
    hooks as _mod_hooks,
24
21
    log,
25
22
    osutils,
26
23
    tsort,
27
24
    revision as _mod_revision,
28
25
    )
29
 
from . import errors as errors
30
 
from .trace import mutter, warning
31
 
from .workingtree import ShelvingUnsupported
32
 
 
 
26
import bzrlib.errors as errors
 
27
from bzrlib.trace import mutter, warning
33
28
 
34
29
# TODO: when showing single-line logs, truncate to the width of the terminal
35
30
# if known, but only if really going to the terminal (not into a file)
36
31
 
37
32
 
38
 
def report_changes(to_file, old, new, specific_files,
39
 
                   show_short_reporter, show_long_callback,
40
 
                   short=False, want_unchanged=False,
41
 
                   want_unversioned=False, show_ids=False, classify=True):
 
33
def report_changes(to_file, old, new, specific_files, 
 
34
                   show_short_reporter, show_long_callback, 
 
35
                   short=False, want_unchanged=False, 
 
36
                   want_unversioned=False, show_ids=False):
42
37
    """Display summary of changes.
43
38
 
44
 
    This compares two trees with regards to a list of files, and delegates
 
39
    This compares two trees with regards to a list of files, and delegates 
45
40
    the display to underlying elements.
46
41
 
47
42
    For short output, it creates an iterator on all changes, and lets a given
63
58
        files.
64
59
    :param show_ids: If set, includes each file's id.
65
60
    :param want_unversioned: If False, only shows versioned files.
66
 
    :param classify: Add special symbols to indicate file kind.
67
61
    """
68
62
 
69
63
    if short:
70
64
        changes = new.iter_changes(old, want_unchanged, specific_files,
71
 
                                   require_versioned=False, want_unversioned=want_unversioned)
 
65
            require_versioned=False, want_unversioned=want_unversioned)
72
66
        _mod_delta.report_changes(changes, show_short_reporter)
 
67
        
73
68
    else:
74
69
        delta = new.changes_from(old, want_unchanged=want_unchanged,
75
 
                                 specific_files=specific_files,
76
 
                                 want_unversioned=want_unversioned)
 
70
                              specific_files=specific_files,
 
71
                              want_unversioned=want_unversioned)
77
72
        # filter out unknown files. We may want a tree method for
78
73
        # this
79
74
        delta.unversioned = [unversioned for unversioned in
80
 
                             delta.unversioned if not new.is_ignored(unversioned[0])]
81
 
        show_long_callback(to_file, delta,
 
75
            delta.unversioned if not new.is_ignored(unversioned[0])]
 
76
        show_long_callback(to_file, delta, 
82
77
                           show_ids=show_ids,
83
 
                           show_unchanged=want_unchanged,
84
 
                           classify=classify)
85
 
 
86
 
 
87
 
def show_tree_status(wt,
 
78
                           show_unchanged=want_unchanged)
 
79
 
 
80
 
 
81
def show_tree_status(wt, show_unchanged=None,
88
82
                     specific_files=None,
89
83
                     show_ids=False,
90
84
                     to_file=None,
93
87
                     short=False,
94
88
                     verbose=False,
95
89
                     versioned=False,
96
 
                     classify=True,
97
90
                     show_long_callback=_mod_delta.report_delta):
98
91
    """Display summary of changes.
99
92
 
107
100
    If showing the status of a working tree, extra information is included
108
101
    about unknown files, conflicts, and pending merges.
109
102
 
 
103
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
 
104
        files.
110
105
    :param specific_files: If set, a list of filenames whose status should be
111
106
        shown.  It is an error to give a filename that is not in the working
112
107
        tree, or in the working inventory or in the basis inventory.
121
116
    :param verbose: If True, show all merged revisions, not just
122
117
        the merge tips
123
118
    :param versioned: If True, only shows versioned files.
124
 
    :param classify: Add special symbols to indicate file kind.
125
 
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta,
 
119
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
126
120
        show_ids, show_unchanged, indent, filter), only used with the long output
127
121
    """
 
122
    if show_unchanged is not None:
 
123
        warn("show_tree_status with show_unchanged has been deprecated "
 
124
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
 
125
 
128
126
    if to_file is None:
129
127
        to_file = sys.stdout
130
128
 
131
 
    with wt.lock_read():
 
129
    wt.lock_read()
 
130
    try:
132
131
        new_is_working_tree = True
133
132
        if revision is None:
134
133
            if wt.last_revision() != wt.branch.last_revision():
135
 
                warning("working tree is out of date, run 'brz update'")
 
134
                warning("working tree is out of date, run 'bzr update'")
136
135
            new = wt
137
136
            old = new.basis_tree()
138
137
        elif len(revision) > 0:
139
138
            try:
140
139
                old = revision[0].as_tree(wt.branch)
141
 
            except errors.NoSuchRevision as e:
 
140
            except errors.NoSuchRevision, e:
142
141
                raise errors.BzrCommandError(str(e))
143
142
            if (len(revision) > 1) and (revision[1].spec is not None):
144
143
                try:
145
144
                    new = revision[1].as_tree(wt.branch)
146
145
                    new_is_working_tree = False
147
 
                except errors.NoSuchRevision as e:
 
146
                except errors.NoSuchRevision, e:
148
147
                    raise errors.BzrCommandError(str(e))
149
148
            else:
150
149
                new = wt
151
 
        with old.lock_read(), new.lock_read():
152
 
            for hook in hooks['pre_status']:
153
 
                hook(StatusHookParams(old, new, to_file, versioned,
154
 
                                      show_ids, short, verbose, specific_files=specific_files))
155
 
 
 
150
        old.lock_read()
 
151
        new.lock_read()
 
152
        try:
156
153
            specific_files, nonexistents \
157
154
                = _filter_nonexistent(specific_files, old, new)
158
155
            want_unversioned = not versioned
159
156
 
160
157
            # Reporter used for short outputs
161
158
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
162
 
                                                  unversioned_filter=new.is_ignored, classify=classify)
163
 
            report_changes(to_file, old, new, specific_files,
164
 
                           reporter, show_long_callback,
165
 
                           short=short, want_unversioned=want_unversioned,
166
 
                           show_ids=show_ids, classify=classify)
 
159
                unversioned_filter=new.is_ignored)
 
160
            report_changes(to_file, old, new, specific_files, 
 
161
                           reporter, show_long_callback, 
 
162
                           short=short, want_unchanged=show_unchanged, 
 
163
                           want_unversioned=want_unversioned, show_ids=show_ids)
167
164
 
168
165
            # show the ignored files among specific files (i.e. show the files
169
 
            # identified from input that we choose to ignore).
 
166
            # identified from input that we choose to ignore). 
170
167
            if specific_files is not None:
171
168
                # Ignored files is sorted because specific_files is already sorted
172
169
                ignored_files = [specific for specific in
173
 
                                 specific_files if new.is_ignored(specific)]
 
170
                    specific_files if new.is_ignored(specific)]
174
171
                if len(ignored_files) > 0 and not short:
175
172
                    to_file.write("ignored:\n")
176
173
                    prefix = ' '
184
181
            conflicts = new.conflicts()
185
182
            if specific_files is not None:
186
183
                conflicts = conflicts.select_conflicts(new, specific_files,
187
 
                                                       ignore_misses=True, recurse=True)[1]
 
184
                    ignore_misses=True, recurse=True)[1]
188
185
            if len(conflicts) > 0 and not short:
189
186
                to_file.write("conflicts:\n")
190
187
            for conflict in conflicts:
192
189
                    prefix = 'C  '
193
190
                else:
194
191
                    prefix = ' '
195
 
                to_file.write("%s %s\n" % (prefix, conflict.describe()))
 
192
                to_file.write("%s %s\n" % (prefix, conflict))
196
193
            # Show files that were requested but don't exist (and are
197
194
            # not versioned).  We don't involve delta in this; these
198
195
            # paths are really the province of just the status
213
210
                show_pending_merges(new, to_file, short, verbose=verbose)
214
211
            if nonexistents:
215
212
                raise errors.PathsDoNotExist(nonexistents)
216
 
            for hook in hooks['post_status']:
217
 
                hook(StatusHookParams(old, new, to_file, versioned,
218
 
                                      show_ids, short, verbose, specific_files=specific_files))
 
213
        finally:
 
214
            old.unlock()
 
215
            new.unlock()
 
216
    finally:
 
217
        wt.unlock()
219
218
 
220
219
 
221
220
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
234
233
    # of any references pointing outside of this graph.
235
234
    parent_graph = {}
236
235
    for revision_id in revision_ids:
237
 
        if revision_id not in parent_map:  # ghost
 
236
        if revision_id not in parent_map: # ghost
238
237
            parent_graph[revision_id] = []
239
238
        else:
240
239
            # Only include parents which are in this sub-graph
241
240
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
242
 
                                         if p in revision_ids]
 
241
                                            if p in revision_ids]
243
242
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
244
243
    return sorter.iter_topo_order()
245
244
 
283
282
    log_formatter = log.LineLogFormatter(to_file)
284
283
    for merge in pending:
285
284
        try:
286
 
            rev = branch.repository.get_revision(merge)
 
285
            rev = branch.repository.get_revisions([merge])[0]
287
286
        except errors.NoSuchRevision:
288
287
            # If we are missing a revision, just print out the revision id
289
 
            to_file.write(first_prefix + '(ghost) ' +
290
 
                          merge.decode('utf-8') + '\n')
 
288
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
291
289
            other_revisions.append(merge)
292
290
            continue
293
291
 
303
301
        merge_extra.discard(_mod_revision.NULL_REVISION)
304
302
 
305
303
        # Get a handle to all of the revisions we will need
306
 
        revisions = dict(branch.repository.iter_revisions(merge_extra))
 
304
        try:
 
305
            revisions = dict((rev.revision_id, rev) for rev in
 
306
                             branch.repository.get_revisions(merge_extra))
 
307
        except errors.NoSuchRevision:
 
308
            # One of the sub nodes is a ghost, check each one
 
309
            revisions = {}
 
310
            for revision_id in merge_extra:
 
311
                try:
 
312
                    rev = branch.repository.get_revisions([revision_id])[0]
 
313
                except errors.NoSuchRevision:
 
314
                    revisions[revision_id] = None
 
315
                else:
 
316
                    revisions[revision_id] = rev
307
317
 
308
318
        # Display the revisions brought in by this merge.
309
319
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
310
 
                                                branch.repository.get_parent_map(merge_extra))
 
320
                            branch.repository.get_parent_map(merge_extra))
311
321
        # Skip the first node
312
 
        num, first, depth, eom = next(rev_id_iterator)
 
322
        num, first, depth, eom = rev_id_iterator.next()
313
323
        if first != merge:
314
324
            raise AssertionError('Somehow we misunderstood how'
315
 
                                 ' iter_topo_order works %s != %s' % (first, merge))
 
325
                ' iter_topo_order works %s != %s' % (first, merge))
316
326
        for num, sub_merge, depth, eom in rev_id_iterator:
317
327
            rev = revisions[sub_merge]
318
328
            if rev is None:
319
 
                to_file.write(sub_prefix + '(ghost) ' +
320
 
                              sub_merge.decode('utf-8') + '\n')
 
329
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
321
330
                continue
322
331
            show_log_message(revisions[sub_merge], sub_prefix)
323
332
 
332
341
 
333
342
    If either of the two lists is empty, return it as an empty list.
334
343
 
335
 
    This can be used by operations such as brz status that can accept
 
344
    This can be used by operations such as bzr status that can accept
336
345
    unknown or ignored files.
337
346
    """
338
347
    mutter("check paths: %r", orig_paths)
341
350
    s = old_tree.filter_unversioned_files(orig_paths)
342
351
    s = new_tree.filter_unversioned_files(s)
343
352
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
344
 
    remaining = [path for path in orig_paths if path not in nonexistent]
 
353
    remaining   = [path for path in orig_paths if not path in nonexistent]
345
354
    # Sorting the 'remaining' list doesn't have much effect in
346
355
    # practice, since the various status output sections will sort
347
356
    # their groups individually.  But for consistency of this
348
357
    # function's API, it's better to sort both than just 'nonexistent'.
349
358
    return sorted(remaining), sorted(nonexistent)
350
 
 
351
 
 
352
 
class StatusHooks(_mod_hooks.Hooks):
353
 
    """A dictionary mapping hook name to a list of callables for status hooks.
354
 
 
355
 
    e.g. ['post_status'] Is the list of items to be called when the
356
 
    status command has finished printing the status.
357
 
    """
358
 
 
359
 
    def __init__(self):
360
 
        """Create the default hooks.
361
 
 
362
 
        These are all empty initially, because by default nothing should get
363
 
        notified.
364
 
        """
365
 
        _mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
366
 
        self.add_hook(
367
 
            'post_status',
368
 
            "Called with argument StatusHookParams after Bazaar has "
369
 
            "displayed the status. StatusHookParams has the attributes "
370
 
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
371
 
            "verbose). The last four arguments correspond to the command "
372
 
            "line options specified by the user for the status command. "
373
 
            "to_file is the output stream for writing.",
374
 
            (2, 3))
375
 
        self.add_hook(
376
 
            'pre_status',
377
 
            "Called with argument StatusHookParams before Bazaar "
378
 
            "displays the status. StatusHookParams has the attributes "
379
 
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
380
 
            "verbose). The last four arguments correspond to the command "
381
 
            "line options specified by the user for the status command. "
382
 
            "to_file is the output stream for writing.",
383
 
            (2, 3))
384
 
 
385
 
 
386
 
class StatusHookParams(object):
387
 
    """Object holding parameters passed to post_status hooks.
388
 
 
389
 
    :ivar old_tree: Start tree (basis tree) for comparison.
390
 
    :ivar new_tree: Working tree.
391
 
    :ivar to_file: If set, write to this file.
392
 
    :ivar versioned: Show only versioned files.
393
 
    :ivar show_ids: Show internal object ids.
394
 
    :ivar short: Use short status indicators.
395
 
    :ivar verbose: Verbose flag.
396
 
    """
397
 
 
398
 
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
399
 
                 short, verbose, specific_files=None):
400
 
        """Create a group of post_status hook parameters.
401
 
 
402
 
        :param old_tree: Start tree (basis tree) for comparison.
403
 
        :param new_tree: Working tree.
404
 
        :param to_file: If set, write to this file.
405
 
        :param versioned: Show only versioned files.
406
 
        :param show_ids: Show internal object ids.
407
 
        :param short: Use short status indicators.
408
 
        :param verbose: Verbose flag.
409
 
        :param specific_files: If set, a list of filenames whose status should be
410
 
            shown.  It is an error to give a filename that is not in the
411
 
            working tree, or in the working inventory or in the basis inventory.
412
 
        """
413
 
        self.old_tree = old_tree
414
 
        self.new_tree = new_tree
415
 
        self.to_file = to_file
416
 
        self.versioned = versioned
417
 
        self.show_ids = show_ids
418
 
        self.short = short
419
 
        self.verbose = verbose
420
 
        self.specific_files = specific_files
421
 
 
422
 
    def __eq__(self, other):
423
 
        return self.__dict__ == other.__dict__
424
 
 
425
 
    def __repr__(self):
426
 
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (
427
 
            self.__class__.__name__, self.old_tree, self.new_tree,
428
 
            self.to_file, self.versioned, self.show_ids, self.short,
429
 
            self.verbose, self.specific_files)
430
 
 
431
 
 
432
 
def _show_shelve_summary(params):
433
 
    """post_status hook to display a summary of shelves.
434
 
 
435
 
    :param params: StatusHookParams.
436
 
    """
437
 
    # Don't show shelves if status of specific files is being shown, only if
438
 
    # no file arguments have been passed
439
 
    if params.specific_files:
440
 
        return
441
 
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
442
 
    if get_shelf_manager is None:
443
 
        return
444
 
    try:
445
 
        manager = get_shelf_manager()
446
 
    except ShelvingUnsupported:
447
 
        mutter('shelving not supported by tree, not displaying shelves.')
448
 
    else:
449
 
        shelves = manager.active_shelves()
450
 
        if shelves:
451
 
            singular = '%d shelf exists. '
452
 
            plural = '%d shelves exist. '
453
 
            if len(shelves) == 1:
454
 
                fmt = singular
455
 
            else:
456
 
                fmt = plural
457
 
            params.to_file.write(fmt % len(shelves))
458
 
            params.to_file.write('See "brz shelve --list" for details.\n')
459
 
 
460
 
 
461
 
hooks = StatusHooks()
462
 
 
463
 
 
464
 
hooks.install_named_hook('post_status', _show_shelve_summary,
465
 
                         'brz status')