/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 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

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
 
        delta.unversioned = [change for change in delta.unversioned
80
 
                             if not new.is_ignored(change.path[1])]
81
 
        show_long_callback(to_file, delta,
 
74
        delta.unversioned = [unversioned for unversioned in
 
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(
154
 
                    old, new, to_file, versioned, show_ids, short, verbose,
155
 
                    specific_files=specific_files))
156
 
 
 
150
        old.lock_read()
 
151
        new.lock_read()
 
152
        try:
157
153
            specific_files, nonexistents \
158
154
                = _filter_nonexistent(specific_files, old, new)
159
155
            want_unversioned = not versioned
160
156
 
161
157
            # Reporter used for short outputs
162
 
            reporter = _mod_delta._ChangeReporter(
163
 
                output_file=to_file, unversioned_filter=new.is_ignored,
164
 
                classify=classify)
165
 
            report_changes(to_file, old, new, specific_files,
166
 
                           reporter, show_long_callback,
167
 
                           short=short, want_unversioned=want_unversioned,
168
 
                           show_ids=show_ids, classify=classify)
 
158
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
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)
169
164
 
170
165
            # show the ignored files among specific files (i.e. show the files
171
 
            # identified from input that we choose to ignore).
 
166
            # identified from input that we choose to ignore). 
172
167
            if specific_files is not None:
173
168
                # Ignored files is sorted because specific_files is already sorted
174
169
                ignored_files = [specific for specific in
175
 
                                 specific_files if new.is_ignored(specific)]
 
170
                    specific_files if new.is_ignored(specific)]
176
171
                if len(ignored_files) > 0 and not short:
177
172
                    to_file.write("ignored:\n")
178
173
                    prefix = ' '
185
180
            # delta.
186
181
            conflicts = new.conflicts()
187
182
            if specific_files is not None:
188
 
                conflicts = conflicts.select_conflicts(
189
 
                    new, specific_files, ignore_misses=True, recurse=True)[1]
 
183
                conflicts = conflicts.select_conflicts(new, specific_files,
 
184
                    ignore_misses=True, recurse=True)[1]
190
185
            if len(conflicts) > 0 and not short:
191
186
                to_file.write("conflicts:\n")
192
187
            for conflict in conflicts:
194
189
                    prefix = 'C  '
195
190
                else:
196
191
                    prefix = ' '
197
 
                to_file.write("%s %s\n" % (prefix, conflict.describe()))
 
192
                to_file.write("%s %s\n" % (prefix, conflict))
198
193
            # Show files that were requested but don't exist (and are
199
194
            # not versioned).  We don't involve delta in this; these
200
195
            # paths are really the province of just the status
215
210
                show_pending_merges(new, to_file, short, verbose=verbose)
216
211
            if nonexistents:
217
212
                raise errors.PathsDoNotExist(nonexistents)
218
 
            for hook in hooks['post_status']:
219
 
                hook(StatusHookParams(
220
 
                    old, new, to_file, versioned, show_ids, short, verbose,
221
 
                    specific_files=specific_files))
 
213
        finally:
 
214
            old.unlock()
 
215
            new.unlock()
 
216
    finally:
 
217
        wt.unlock()
222
218
 
223
219
 
224
220
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
237
233
    # of any references pointing outside of this graph.
238
234
    parent_graph = {}
239
235
    for revision_id in revision_ids:
240
 
        if revision_id not in parent_map:  # ghost
 
236
        if revision_id not in parent_map: # ghost
241
237
            parent_graph[revision_id] = []
242
238
        else:
243
239
            # Only include parents which are in this sub-graph
244
240
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
245
 
                                         if p in revision_ids]
 
241
                                            if p in revision_ids]
246
242
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
247
243
    return sorter.iter_topo_order()
248
244
 
286
282
    log_formatter = log.LineLogFormatter(to_file)
287
283
    for merge in pending:
288
284
        try:
289
 
            rev = branch.repository.get_revision(merge)
 
285
            rev = branch.repository.get_revisions([merge])[0]
290
286
        except errors.NoSuchRevision:
291
287
            # If we are missing a revision, just print out the revision id
292
 
            to_file.write(first_prefix + '(ghost) ' +
293
 
                          merge.decode('utf-8') + '\n')
 
288
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
294
289
            other_revisions.append(merge)
295
290
            continue
296
291
 
306
301
        merge_extra.discard(_mod_revision.NULL_REVISION)
307
302
 
308
303
        # Get a handle to all of the revisions we will need
309
 
        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
310
317
 
311
318
        # Display the revisions brought in by this merge.
312
319
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
313
 
                                                branch.repository.get_parent_map(merge_extra))
 
320
                            branch.repository.get_parent_map(merge_extra))
314
321
        # Skip the first node
315
 
        num, first, depth, eom = next(rev_id_iterator)
 
322
        num, first, depth, eom = rev_id_iterator.next()
316
323
        if first != merge:
317
324
            raise AssertionError('Somehow we misunderstood how'
318
 
                                 ' iter_topo_order works %s != %s' % (first, merge))
 
325
                ' iter_topo_order works %s != %s' % (first, merge))
319
326
        for num, sub_merge, depth, eom in rev_id_iterator:
320
327
            rev = revisions[sub_merge]
321
328
            if rev is None:
322
 
                to_file.write(sub_prefix + '(ghost) ' +
323
 
                              sub_merge.decode('utf-8') + '\n')
 
329
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
324
330
                continue
325
331
            show_log_message(revisions[sub_merge], sub_prefix)
326
332
 
335
341
 
336
342
    If either of the two lists is empty, return it as an empty list.
337
343
 
338
 
    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
339
345
    unknown or ignored files.
340
346
    """
341
347
    mutter("check paths: %r", orig_paths)
344
350
    s = old_tree.filter_unversioned_files(orig_paths)
345
351
    s = new_tree.filter_unversioned_files(s)
346
352
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
347
 
    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]
348
354
    # Sorting the 'remaining' list doesn't have much effect in
349
355
    # practice, since the various status output sections will sort
350
356
    # their groups individually.  But for consistency of this
351
357
    # function's API, it's better to sort both than just 'nonexistent'.
352
358
    return sorted(remaining), sorted(nonexistent)
353
 
 
354
 
 
355
 
class StatusHooks(_mod_hooks.Hooks):
356
 
    """A dictionary mapping hook name to a list of callables for status hooks.
357
 
 
358
 
    e.g. ['post_status'] Is the list of items to be called when the
359
 
    status command has finished printing the status.
360
 
    """
361
 
 
362
 
    def __init__(self):
363
 
        """Create the default hooks.
364
 
 
365
 
        These are all empty initially, because by default nothing should get
366
 
        notified.
367
 
        """
368
 
        _mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
369
 
        self.add_hook(
370
 
            'post_status',
371
 
            "Called with argument StatusHookParams after Bazaar has "
372
 
            "displayed the status. StatusHookParams has the attributes "
373
 
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
374
 
            "verbose). The last four arguments correspond to the command "
375
 
            "line options specified by the user for the status command. "
376
 
            "to_file is the output stream for writing.",
377
 
            (2, 3))
378
 
        self.add_hook(
379
 
            'pre_status',
380
 
            "Called with argument StatusHookParams before Bazaar "
381
 
            "displays the status. StatusHookParams has the attributes "
382
 
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
383
 
            "verbose). The last four arguments correspond to the command "
384
 
            "line options specified by the user for the status command. "
385
 
            "to_file is the output stream for writing.",
386
 
            (2, 3))
387
 
 
388
 
 
389
 
class StatusHookParams(object):
390
 
    """Object holding parameters passed to post_status hooks.
391
 
 
392
 
    :ivar old_tree: Start tree (basis tree) for comparison.
393
 
    :ivar new_tree: Working tree.
394
 
    :ivar to_file: If set, write to this file.
395
 
    :ivar versioned: Show only versioned files.
396
 
    :ivar show_ids: Show internal object ids.
397
 
    :ivar short: Use short status indicators.
398
 
    :ivar verbose: Verbose flag.
399
 
    """
400
 
 
401
 
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
402
 
                 short, verbose, specific_files=None):
403
 
        """Create a group of post_status hook parameters.
404
 
 
405
 
        :param old_tree: Start tree (basis tree) for comparison.
406
 
        :param new_tree: Working tree.
407
 
        :param to_file: If set, write to this file.
408
 
        :param versioned: Show only versioned files.
409
 
        :param show_ids: Show internal object ids.
410
 
        :param short: Use short status indicators.
411
 
        :param verbose: Verbose flag.
412
 
        :param specific_files: If set, a list of filenames whose status should be
413
 
            shown.  It is an error to give a filename that is not in the
414
 
            working tree, or in the working inventory or in the basis inventory.
415
 
        """
416
 
        self.old_tree = old_tree
417
 
        self.new_tree = new_tree
418
 
        self.to_file = to_file
419
 
        self.versioned = versioned
420
 
        self.show_ids = show_ids
421
 
        self.short = short
422
 
        self.verbose = verbose
423
 
        self.specific_files = specific_files
424
 
 
425
 
    def __eq__(self, other):
426
 
        return self.__dict__ == other.__dict__
427
 
 
428
 
    def __repr__(self):
429
 
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (
430
 
            self.__class__.__name__, self.old_tree, self.new_tree,
431
 
            self.to_file, self.versioned, self.show_ids, self.short,
432
 
            self.verbose, self.specific_files)
433
 
 
434
 
 
435
 
def _show_shelve_summary(params):
436
 
    """post_status hook to display a summary of shelves.
437
 
 
438
 
    :param params: StatusHookParams.
439
 
    """
440
 
    # Don't show shelves if status of specific files is being shown, only if
441
 
    # no file arguments have been passed
442
 
    if params.specific_files:
443
 
        return
444
 
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
445
 
    if get_shelf_manager is None:
446
 
        return
447
 
    try:
448
 
        manager = get_shelf_manager()
449
 
    except ShelvingUnsupported:
450
 
        mutter('shelving not supported by tree, not displaying shelves.')
451
 
    else:
452
 
        shelves = manager.active_shelves()
453
 
        if shelves:
454
 
            singular = '%d shelf exists. '
455
 
            plural = '%d shelves exist. '
456
 
            if len(shelves) == 1:
457
 
                fmt = singular
458
 
            else:
459
 
                fmt = plural
460
 
            params.to_file.write(fmt % len(shelves))
461
 
            params.to_file.write('See "brz shelve --list" for details.\n')
462
 
 
463
 
 
464
 
hooks = StatusHooks()
465
 
 
466
 
 
467
 
hooks.install_named_hook('post_status', _show_shelve_summary,
468
 
                         'brz status')