/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 breezy/status.py

  • Committer: Jelmer Vernooij
  • Date: 2018-03-01 23:44:14 UTC
  • mto: This revision was merged to the branch mainline in revision 6871.
  • Revision ID: jelmer@jelmer.uk-20180301234414-5btxmc1z8pz131ob
Fix context manager for RecordingUIFactory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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
 
17
19
import sys
18
20
 
19
 
from bzrlib import (
 
21
from . import (
20
22
    delta as _mod_delta,
 
23
    hooks as _mod_hooks,
21
24
    log,
22
25
    osutils,
23
26
    tsort,
24
27
    revision as _mod_revision,
25
28
    )
26
 
import bzrlib.errors as errors
27
 
from bzrlib.trace import mutter, warning
 
29
from . import errors as errors
 
30
from .trace import mutter, warning
 
31
from .workingtree import ShelvingUnsupported
 
32
 
28
33
 
29
34
# TODO: when showing single-line logs, truncate to the width of the terminal
30
35
# if known, but only if really going to the terminal (not into a file)
31
36
 
32
37
 
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):
 
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):
37
42
    """Display summary of changes.
38
43
 
39
 
    This compares two trees with regards to a list of files, and delegates 
 
44
    This compares two trees with regards to a list of files, and delegates
40
45
    the display to underlying elements.
41
46
 
42
47
    For short output, it creates an iterator on all changes, and lets a given
58
63
        files.
59
64
    :param show_ids: If set, includes each file's id.
60
65
    :param want_unversioned: If False, only shows versioned files.
 
66
    :param classify: Add special symbols to indicate file kind.
61
67
    """
62
68
 
63
69
    if short:
64
70
        changes = new.iter_changes(old, want_unchanged, specific_files,
65
71
            require_versioned=False, want_unversioned=want_unversioned)
66
72
        _mod_delta.report_changes(changes, show_short_reporter)
67
 
        
68
73
    else:
69
74
        delta = new.changes_from(old, want_unchanged=want_unchanged,
70
75
                              specific_files=specific_files,
73
78
        # this
74
79
        delta.unversioned = [unversioned for unversioned in
75
80
            delta.unversioned if not new.is_ignored(unversioned[0])]
76
 
        show_long_callback(to_file, delta, 
 
81
        show_long_callback(to_file, delta,
77
82
                           show_ids=show_ids,
78
 
                           show_unchanged=want_unchanged)
79
 
 
80
 
 
81
 
def show_tree_status(wt, show_unchanged=None,
 
83
                           show_unchanged=want_unchanged,
 
84
                           classify=classify)
 
85
 
 
86
 
 
87
def show_tree_status(wt,
82
88
                     specific_files=None,
83
89
                     show_ids=False,
84
90
                     to_file=None,
87
93
                     short=False,
88
94
                     verbose=False,
89
95
                     versioned=False,
 
96
                     classify=True,
90
97
                     show_long_callback=_mod_delta.report_delta):
91
98
    """Display summary of changes.
92
99
 
100
107
    If showing the status of a working tree, extra information is included
101
108
    about unknown files, conflicts, and pending merges.
102
109
 
103
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
104
 
        files.
105
110
    :param specific_files: If set, a list of filenames whose status should be
106
111
        shown.  It is an error to give a filename that is not in the working
107
112
        tree, or in the working inventory or in the basis inventory.
116
121
    :param verbose: If True, show all merged revisions, not just
117
122
        the merge tips
118
123
    :param versioned: If True, only shows versioned files.
119
 
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
 
124
    :param classify: Add special symbols to indicate file kind.
 
125
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta,
120
126
        show_ids, show_unchanged, indent, filter), only used with the long output
121
127
    """
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
 
 
126
128
    if to_file is None:
127
129
        to_file = sys.stdout
128
130
 
131
133
        new_is_working_tree = True
132
134
        if revision is None:
133
135
            if wt.last_revision() != wt.branch.last_revision():
134
 
                warning("working tree is out of date, run 'bzr update'")
 
136
                warning("working tree is out of date, run 'brz update'")
135
137
            new = wt
136
138
            old = new.basis_tree()
137
139
        elif len(revision) > 0:
138
140
            try:
139
141
                old = revision[0].as_tree(wt.branch)
140
 
            except errors.NoSuchRevision, e:
 
142
            except errors.NoSuchRevision as e:
141
143
                raise errors.BzrCommandError(str(e))
142
144
            if (len(revision) > 1) and (revision[1].spec is not None):
143
145
                try:
144
146
                    new = revision[1].as_tree(wt.branch)
145
147
                    new_is_working_tree = False
146
 
                except errors.NoSuchRevision, e:
 
148
                except errors.NoSuchRevision as e:
147
149
                    raise errors.BzrCommandError(str(e))
148
150
            else:
149
151
                new = wt
150
152
        old.lock_read()
151
153
        new.lock_read()
152
154
        try:
 
155
            for hook in hooks['pre_status']:
 
156
                hook(StatusHookParams(old, new, to_file, versioned,
 
157
                    show_ids, short, verbose, specific_files=specific_files))
 
158
 
153
159
            specific_files, nonexistents \
154
160
                = _filter_nonexistent(specific_files, old, new)
155
161
            want_unversioned = not versioned
156
162
 
157
163
            # Reporter used for short outputs
158
164
            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)
 
165
                unversioned_filter=new.is_ignored, classify=classify)
 
166
            report_changes(to_file, old, new, specific_files,
 
167
                           reporter, show_long_callback,
 
168
                           short=short, want_unversioned=want_unversioned,
 
169
                           show_ids=show_ids, classify=classify)
164
170
 
165
171
            # show the ignored files among specific files (i.e. show the files
166
 
            # identified from input that we choose to ignore). 
 
172
            # identified from input that we choose to ignore).
167
173
            if specific_files is not None:
168
174
                # Ignored files is sorted because specific_files is already sorted
169
175
                ignored_files = [specific for specific in
189
195
                    prefix = 'C  '
190
196
                else:
191
197
                    prefix = ' '
192
 
                to_file.write("%s %s\n" % (prefix, conflict))
 
198
                to_file.write("%s %s\n" % (prefix, unicode(conflict)))
193
199
            # Show files that were requested but don't exist (and are
194
200
            # not versioned).  We don't involve delta in this; these
195
201
            # paths are really the province of just the status
210
216
                show_pending_merges(new, to_file, short, verbose=verbose)
211
217
            if nonexistents:
212
218
                raise errors.PathsDoNotExist(nonexistents)
 
219
            for hook in hooks['post_status']:
 
220
                hook(StatusHookParams(old, new, to_file, versioned,
 
221
                    show_ids, short, verbose, specific_files=specific_files))
213
222
        finally:
214
223
            old.unlock()
215
224
            new.unlock()
282
291
    log_formatter = log.LineLogFormatter(to_file)
283
292
    for merge in pending:
284
293
        try:
285
 
            rev = branch.repository.get_revisions([merge])[0]
 
294
            rev = branch.repository.get_revision(merge)
286
295
        except errors.NoSuchRevision:
287
296
            # If we are missing a revision, just print out the revision id
288
297
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
301
310
        merge_extra.discard(_mod_revision.NULL_REVISION)
302
311
 
303
312
        # Get a handle to all of the revisions we will need
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
 
313
        revisions = dict(branch.repository.iter_revisions(merge_extra))
317
314
 
318
315
        # Display the revisions brought in by this merge.
319
316
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
320
317
                            branch.repository.get_parent_map(merge_extra))
321
318
        # Skip the first node
322
 
        num, first, depth, eom = rev_id_iterator.next()
 
319
        num, first, depth, eom = next(rev_id_iterator)
323
320
        if first != merge:
324
321
            raise AssertionError('Somehow we misunderstood how'
325
322
                ' iter_topo_order works %s != %s' % (first, merge))
341
338
 
342
339
    If either of the two lists is empty, return it as an empty list.
343
340
 
344
 
    This can be used by operations such as bzr status that can accept
 
341
    This can be used by operations such as brz status that can accept
345
342
    unknown or ignored files.
346
343
    """
347
344
    mutter("check paths: %r", orig_paths)
356
353
    # their groups individually.  But for consistency of this
357
354
    # function's API, it's better to sort both than just 'nonexistent'.
358
355
    return sorted(remaining), sorted(nonexistent)
 
356
 
 
357
 
 
358
class StatusHooks(_mod_hooks.Hooks):
 
359
    """A dictionary mapping hook name to a list of callables for status hooks.
 
360
 
 
361
    e.g. ['post_status'] Is the list of items to be called when the
 
362
    status command has finished printing the status.
 
363
    """
 
364
 
 
365
    def __init__(self):
 
366
        """Create the default hooks.
 
367
 
 
368
        These are all empty initially, because by default nothing should get
 
369
        notified.
 
370
        """
 
371
        _mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
 
372
        self.add_hook('post_status',
 
373
            "Called with argument StatusHookParams after Bazaar has "
 
374
            "displayed the status. StatusHookParams has the attributes "
 
375
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
376
            "verbose). The last four arguments correspond to the command "
 
377
            "line options specified by the user for the status command. "
 
378
            "to_file is the output stream for writing.",
 
379
            (2, 3))
 
380
        self.add_hook('pre_status',
 
381
            "Called with argument StatusHookParams before Bazaar "
 
382
            "displays the status. StatusHookParams has the attributes "
 
383
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
384
            "verbose). The last four arguments correspond to the command "
 
385
            "line options specified by the user for the status command. "
 
386
            "to_file is the output stream for writing.",
 
387
            (2, 3))
 
388
 
 
389
 
 
390
class StatusHookParams(object):
 
391
    """Object holding parameters passed to post_status hooks.
 
392
 
 
393
    :ivar old_tree: Start tree (basis tree) for comparison.
 
394
    :ivar new_tree: Working tree.
 
395
    :ivar to_file: If set, write to this file.
 
396
    :ivar versioned: Show only versioned files.
 
397
    :ivar show_ids: Show internal object ids.
 
398
    :ivar short: Use short status indicators.
 
399
    :ivar verbose: Verbose flag.
 
400
    """
 
401
 
 
402
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
 
403
            short, verbose, specific_files=None):
 
404
        """Create a group of post_status hook parameters.
 
405
 
 
406
        :param old_tree: Start tree (basis tree) for comparison.
 
407
        :param new_tree: Working tree.
 
408
        :param to_file: If set, write to this file.
 
409
        :param versioned: Show only versioned files.
 
410
        :param show_ids: Show internal object ids.
 
411
        :param short: Use short status indicators.
 
412
        :param verbose: Verbose flag.
 
413
        :param specific_files: If set, a list of filenames whose status should be
 
414
            shown.  It is an error to give a filename that is not in the working
 
415
            tree, or in the working inventory or in the basis inventory.
 
416
        """
 
417
        self.old_tree = old_tree
 
418
        self.new_tree = new_tree
 
419
        self.to_file = to_file
 
420
        self.versioned = versioned
 
421
        self.show_ids = show_ids
 
422
        self.short = short
 
423
        self.verbose = verbose
 
424
        self.specific_files = specific_files
 
425
 
 
426
    def __eq__(self, other):
 
427
        return self.__dict__ == other.__dict__
 
428
 
 
429
    def __repr__(self):
 
430
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
 
431
            self.old_tree, self.new_tree, self.to_file, self.versioned,
 
432
            self.show_ids, self.short, 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')
 
469