/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: Martin
  • Date: 2018-11-17 17:37:42 UTC
  • mto: This revision was merged to the branch mainline in revision 7188.
  • Revision ID: gzlist@googlemail.com-20181117173742-nojh69vdpnofhtw7
Fix E27* lint errors

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/status.py
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import sys
 
20
 
 
21
from . import (
 
22
    delta as _mod_delta,
 
23
    hooks as _mod_hooks,
 
24
    log,
 
25
    osutils,
 
26
    tsort,
 
27
    revision as _mod_revision,
 
28
    )
 
29
from . import errors as errors
 
30
from .trace import mutter, warning
 
31
from .workingtree import ShelvingUnsupported
 
32
 
 
33
 
 
34
# TODO: when showing single-line logs, truncate to the width of the terminal
 
35
# if known, but only if really going to the terminal (not into a file)
 
36
 
 
37
 
 
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):
 
42
    """Display summary of changes.
 
43
 
 
44
    This compares two trees with regards to a list of files, and delegates
 
45
    the display to underlying elements.
 
46
 
 
47
    For short output, it creates an iterator on all changes, and lets a given
 
48
    reporter display these changes.
 
49
 
 
50
    For stantard output, it creates a delta of the changes, and forwards it
 
51
    to a callback
 
52
 
 
53
    :param to_file: If set, write to this file (default stdout.)
 
54
    :param old: Start tree for the comparison
 
55
    :param end: End tree for the comparison
 
56
    :param specific_files: If set, a list of filenames whose status should be
 
57
        shown.  It is an error to give a filename that is not in the working
 
58
        tree, or in the working inventory or in the basis inventory.
 
59
    :param show_short_reporter: Reporter in charge of display for short output
 
60
    :param show_long_callback: Callback in charge of display for normal output
 
61
    :param short: If True, gives short SVN-style status lines.
 
62
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
 
63
        files.
 
64
    :param show_ids: If set, includes each file's id.
 
65
    :param want_unversioned: If False, only shows versioned files.
 
66
    :param classify: Add special symbols to indicate file kind.
 
67
    """
 
68
 
 
69
    if short:
 
70
        changes = new.iter_changes(old, want_unchanged, specific_files,
 
71
                                   require_versioned=False, want_unversioned=want_unversioned)
 
72
        _mod_delta.report_changes(changes, show_short_reporter)
 
73
    else:
 
74
        delta = new.changes_from(old, want_unchanged=want_unchanged,
 
75
                                 specific_files=specific_files,
 
76
                                 want_unversioned=want_unversioned)
 
77
        # filter out unknown files. We may want a tree method for
 
78
        # this
 
79
        delta.unversioned = [unversioned for unversioned in
 
80
                             delta.unversioned if not new.is_ignored(unversioned[0])]
 
81
        show_long_callback(to_file, delta,
 
82
                           show_ids=show_ids,
 
83
                           show_unchanged=want_unchanged,
 
84
                           classify=classify)
 
85
 
 
86
 
 
87
def show_tree_status(wt,
 
88
                     specific_files=None,
 
89
                     show_ids=False,
 
90
                     to_file=None,
 
91
                     show_pending=True,
 
92
                     revision=None,
 
93
                     short=False,
 
94
                     verbose=False,
 
95
                     versioned=False,
 
96
                     classify=True,
 
97
                     show_long_callback=_mod_delta.report_delta):
 
98
    """Display summary of changes.
 
99
 
 
100
    By default this compares the working tree to a previous revision.
 
101
    If the revision argument is given, summarizes changes between the
 
102
    working tree and another, or between two revisions.
 
103
 
 
104
    The result is written out as Unicode and to_file should be able
 
105
    to encode that.
 
106
 
 
107
    If showing the status of a working tree, extra information is included
 
108
    about unknown files, conflicts, and pending merges.
 
109
 
 
110
    :param specific_files: If set, a list of filenames whose status should be
 
111
        shown.  It is an error to give a filename that is not in the working
 
112
        tree, or in the working inventory or in the basis inventory.
 
113
    :param show_ids: If set, includes each file's id.
 
114
    :param to_file: If set, write to this file (default stdout.)
 
115
    :param show_pending: If set, write pending merges.
 
116
    :param revision: If None, compare latest revision with working tree
 
117
        If not None, it must be a RevisionSpec list.
 
118
        If one revision, compare with working tree.
 
119
        If two revisions, show status between first and second.
 
120
    :param short: If True, gives short SVN-style status lines.
 
121
    :param verbose: If True, show all merged revisions, not just
 
122
        the merge tips
 
123
    :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,
 
126
        show_ids, show_unchanged, indent, filter), only used with the long output
 
127
    """
 
128
    if to_file is None:
 
129
        to_file = sys.stdout
 
130
 
 
131
    with wt.lock_read():
 
132
        new_is_working_tree = True
 
133
        if revision is None:
 
134
            if wt.last_revision() != wt.branch.last_revision():
 
135
                warning("working tree is out of date, run 'brz update'")
 
136
            new = wt
 
137
            old = new.basis_tree()
 
138
        elif len(revision) > 0:
 
139
            try:
 
140
                old = revision[0].as_tree(wt.branch)
 
141
            except errors.NoSuchRevision as e:
 
142
                raise errors.BzrCommandError(str(e))
 
143
            if (len(revision) > 1) and (revision[1].spec is not None):
 
144
                try:
 
145
                    new = revision[1].as_tree(wt.branch)
 
146
                    new_is_working_tree = False
 
147
                except errors.NoSuchRevision as e:
 
148
                    raise errors.BzrCommandError(str(e))
 
149
            else:
 
150
                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
 
 
156
            specific_files, nonexistents \
 
157
                = _filter_nonexistent(specific_files, old, new)
 
158
            want_unversioned = not versioned
 
159
 
 
160
            # Reporter used for short outputs
 
161
            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)
 
167
 
 
168
            # show the ignored files among specific files (i.e. show the files
 
169
            # identified from input that we choose to ignore).
 
170
            if specific_files is not None:
 
171
                # Ignored files is sorted because specific_files is already sorted
 
172
                ignored_files = [specific for specific in
 
173
                                 specific_files if new.is_ignored(specific)]
 
174
                if len(ignored_files) > 0 and not short:
 
175
                    to_file.write("ignored:\n")
 
176
                    prefix = ' '
 
177
                else:
 
178
                    prefix = 'I  '
 
179
                for ignored_file in ignored_files:
 
180
                    to_file.write("%s %s\n" % (prefix, ignored_file))
 
181
 
 
182
            # show the new conflicts only for now. XXX: get them from the
 
183
            # delta.
 
184
            conflicts = new.conflicts()
 
185
            if specific_files is not None:
 
186
                conflicts = conflicts.select_conflicts(new, specific_files,
 
187
                                                       ignore_misses=True, recurse=True)[1]
 
188
            if len(conflicts) > 0 and not short:
 
189
                to_file.write("conflicts:\n")
 
190
            for conflict in conflicts:
 
191
                if short:
 
192
                    prefix = 'C  '
 
193
                else:
 
194
                    prefix = ' '
 
195
                to_file.write("%s %s\n" % (prefix, conflict.describe()))
 
196
            # Show files that were requested but don't exist (and are
 
197
            # not versioned).  We don't involve delta in this; these
 
198
            # paths are really the province of just the status
 
199
            # command, since they have more to do with how it was
 
200
            # invoked than with the tree it's operating on.
 
201
            if nonexistents and not short:
 
202
                to_file.write("nonexistent:\n")
 
203
            for nonexistent in nonexistents:
 
204
                # We could calculate prefix outside the loop but, given
 
205
                # how rarely this ought to happen, it's OK and arguably
 
206
                # slightly faster to do it here (ala conflicts above)
 
207
                if short:
 
208
                    prefix = 'X  '
 
209
                else:
 
210
                    prefix = ' '
 
211
                to_file.write("%s %s\n" % (prefix, nonexistent))
 
212
            if (new_is_working_tree and show_pending):
 
213
                show_pending_merges(new, to_file, short, verbose=verbose)
 
214
            if nonexistents:
 
215
                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))
 
219
 
 
220
 
 
221
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
222
    """Get an iterator which will return the revisions in merge sorted order.
 
223
 
 
224
    This will build up a list of all nodes, such that only nodes in the list
 
225
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
226
    order.
 
227
 
 
228
    :param revision_ids: A set of revision_ids
 
229
    :param parent_map: The parent information for each node. Revisions which
 
230
        are considered ghosts should not be present in the map.
 
231
    :return: iterator from MergeSorter.iter_topo_order()
 
232
    """
 
233
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
234
    # of any references pointing outside of this graph.
 
235
    parent_graph = {}
 
236
    for revision_id in revision_ids:
 
237
        if revision_id not in parent_map:  # ghost
 
238
            parent_graph[revision_id] = []
 
239
        else:
 
240
            # Only include parents which are in this sub-graph
 
241
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
242
                                         if p in revision_ids]
 
243
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
244
    return sorter.iter_topo_order()
 
245
 
 
246
 
 
247
def show_pending_merges(new, to_file, short=False, verbose=False):
 
248
    """Write out a display of pending merges in a working tree."""
 
249
    parents = new.get_parent_ids()
 
250
    if len(parents) < 2:
 
251
        return
 
252
 
 
253
    term_width = osutils.terminal_width()
 
254
    if term_width is not None:
 
255
        # we need one extra space for terminals that wrap on last char
 
256
        term_width = term_width - 1
 
257
    if short:
 
258
        first_prefix = 'P   '
 
259
        sub_prefix = 'P.   '
 
260
    else:
 
261
        first_prefix = '  '
 
262
        sub_prefix = '    '
 
263
 
 
264
    def show_log_message(rev, prefix):
 
265
        if term_width is None:
 
266
            width = term_width
 
267
        else:
 
268
            width = term_width - len(prefix)
 
269
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
 
270
        to_file.write(log_message + '\n')
 
271
 
 
272
    pending = parents[1:]
 
273
    branch = new.branch
 
274
    last_revision = parents[0]
 
275
    if not short:
 
276
        if verbose:
 
277
            to_file.write('pending merges:\n')
 
278
        else:
 
279
            to_file.write('pending merge tips:'
 
280
                          ' (use -v to see all merge revisions)\n')
 
281
    graph = branch.repository.get_graph()
 
282
    other_revisions = [last_revision]
 
283
    log_formatter = log.LineLogFormatter(to_file)
 
284
    for merge in pending:
 
285
        try:
 
286
            rev = branch.repository.get_revision(merge)
 
287
        except errors.NoSuchRevision:
 
288
            # 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')
 
291
            other_revisions.append(merge)
 
292
            continue
 
293
 
 
294
        # Log the merge, as it gets a slightly different formatting
 
295
        show_log_message(rev, first_prefix)
 
296
        if not verbose:
 
297
            continue
 
298
 
 
299
        # Find all of the revisions in the merge source, which are not in the
 
300
        # last committed revision.
 
301
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
302
        other_revisions.append(merge)
 
303
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
304
 
 
305
        # Get a handle to all of the revisions we will need
 
306
        revisions = dict(branch.repository.iter_revisions(merge_extra))
 
307
 
 
308
        # Display the revisions brought in by this merge.
 
309
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
310
                                                branch.repository.get_parent_map(merge_extra))
 
311
        # Skip the first node
 
312
        num, first, depth, eom = next(rev_id_iterator)
 
313
        if first != merge:
 
314
            raise AssertionError('Somehow we misunderstood how'
 
315
                                 ' iter_topo_order works %s != %s' % (first, merge))
 
316
        for num, sub_merge, depth, eom in rev_id_iterator:
 
317
            rev = revisions[sub_merge]
 
318
            if rev is None:
 
319
                to_file.write(sub_prefix + '(ghost) ' +
 
320
                              sub_merge.decode('utf-8') + '\n')
 
321
                continue
 
322
            show_log_message(revisions[sub_merge], sub_prefix)
 
323
 
 
324
 
 
325
def _filter_nonexistent(orig_paths, old_tree, new_tree):
 
326
    """Convert orig_paths to two sorted lists and return them.
 
327
 
 
328
    The first is orig_paths paths minus the items in the second list,
 
329
    and the second list is paths that are not in either inventory or
 
330
    tree (they don't qualify if they exist in the tree's inventory, or
 
331
    if they exist in the tree but are not versioned.)
 
332
 
 
333
    If either of the two lists is empty, return it as an empty list.
 
334
 
 
335
    This can be used by operations such as brz status that can accept
 
336
    unknown or ignored files.
 
337
    """
 
338
    mutter("check paths: %r", orig_paths)
 
339
    if not orig_paths:
 
340
        return orig_paths, []
 
341
    s = old_tree.filter_unversioned_files(orig_paths)
 
342
    s = new_tree.filter_unversioned_files(s)
 
343
    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]
 
345
    # Sorting the 'remaining' list doesn't have much effect in
 
346
    # practice, since the various status output sections will sort
 
347
    # their groups individually.  But for consistency of this
 
348
    # function's API, it's better to sort both than just 'nonexistent'.
 
349
    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')