/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-16 18:26:22 UTC
  • mfrom: (7167.1.4 run-flake8)
  • Revision ID: breezy.the.bot@gmail.com-20181116182622-qw3gan3hz78a2imw
Add a flake8 test.

Merged from https://code.launchpad.net/~jelmer/brz/run-flake8/+merge/358902

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
 
129
 
    wt.lock_read()
130
 
    try:
 
131
    with wt.lock_read():
131
132
        new_is_working_tree = True
132
133
        if revision is None:
133
134
            if wt.last_revision() != wt.branch.last_revision():
134
 
                warning("working tree is out of date, run 'bzr update'")
 
135
                warning("working tree is out of date, run 'brz update'")
135
136
            new = wt
136
137
            old = new.basis_tree()
137
138
        elif len(revision) > 0:
138
139
            try:
139
140
                old = revision[0].as_tree(wt.branch)
140
 
            except errors.NoSuchRevision, e:
 
141
            except errors.NoSuchRevision as e:
141
142
                raise errors.BzrCommandError(str(e))
142
143
            if (len(revision) > 1) and (revision[1].spec is not None):
143
144
                try:
144
145
                    new = revision[1].as_tree(wt.branch)
145
146
                    new_is_working_tree = False
146
 
                except errors.NoSuchRevision, e:
 
147
                except errors.NoSuchRevision as e:
147
148
                    raise errors.BzrCommandError(str(e))
148
149
            else:
149
150
                new = wt
150
 
        old.lock_read()
151
 
        new.lock_read()
152
 
        try:
 
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
 
153
156
            specific_files, nonexistents \
154
157
                = _filter_nonexistent(specific_files, old, new)
155
158
            want_unversioned = not versioned
156
159
 
157
160
            # Reporter used for short outputs
158
161
            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)
 
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)
164
167
 
165
168
            # show the ignored files among specific files (i.e. show the files
166
 
            # identified from input that we choose to ignore). 
 
169
            # identified from input that we choose to ignore).
167
170
            if specific_files is not None:
168
171
                # Ignored files is sorted because specific_files is already sorted
169
172
                ignored_files = [specific for specific in
189
192
                    prefix = 'C  '
190
193
                else:
191
194
                    prefix = ' '
192
 
                to_file.write("%s %s\n" % (prefix, conflict))
 
195
                to_file.write("%s %s\n" % (prefix, conflict.describe()))
193
196
            # Show files that were requested but don't exist (and are
194
197
            # not versioned).  We don't involve delta in this; these
195
198
            # paths are really the province of just the status
210
213
                show_pending_merges(new, to_file, short, verbose=verbose)
211
214
            if nonexistents:
212
215
                raise errors.PathsDoNotExist(nonexistents)
213
 
        finally:
214
 
            old.unlock()
215
 
            new.unlock()
216
 
    finally:
217
 
        wt.unlock()
 
216
            for hook in hooks['post_status']:
 
217
                hook(StatusHookParams(old, new, to_file, versioned,
 
218
                    show_ids, short, verbose, specific_files=specific_files))
218
219
 
219
220
 
220
221
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
282
283
    log_formatter = log.LineLogFormatter(to_file)
283
284
    for merge in pending:
284
285
        try:
285
 
            rev = branch.repository.get_revisions([merge])[0]
 
286
            rev = branch.repository.get_revision(merge)
286
287
        except errors.NoSuchRevision:
287
288
            # If we are missing a revision, just print out the revision id
288
 
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
289
            to_file.write(first_prefix + '(ghost) ' + merge.decode('utf-8') + '\n')
289
290
            other_revisions.append(merge)
290
291
            continue
291
292
 
301
302
        merge_extra.discard(_mod_revision.NULL_REVISION)
302
303
 
303
304
        # 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
 
305
        revisions = dict(branch.repository.iter_revisions(merge_extra))
317
306
 
318
307
        # Display the revisions brought in by this merge.
319
308
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
320
309
                            branch.repository.get_parent_map(merge_extra))
321
310
        # Skip the first node
322
 
        num, first, depth, eom = rev_id_iterator.next()
 
311
        num, first, depth, eom = next(rev_id_iterator)
323
312
        if first != merge:
324
313
            raise AssertionError('Somehow we misunderstood how'
325
314
                ' iter_topo_order works %s != %s' % (first, merge))
326
315
        for num, sub_merge, depth, eom in rev_id_iterator:
327
316
            rev = revisions[sub_merge]
328
317
            if rev is None:
329
 
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
318
                to_file.write(sub_prefix + '(ghost) ' + sub_merge.decode('utf-8') + '\n')
330
319
                continue
331
320
            show_log_message(revisions[sub_merge], sub_prefix)
332
321
 
341
330
 
342
331
    If either of the two lists is empty, return it as an empty list.
343
332
 
344
 
    This can be used by operations such as bzr status that can accept
 
333
    This can be used by operations such as brz status that can accept
345
334
    unknown or ignored files.
346
335
    """
347
336
    mutter("check paths: %r", orig_paths)
356
345
    # their groups individually.  But for consistency of this
357
346
    # function's API, it's better to sort both than just 'nonexistent'.
358
347
    return sorted(remaining), sorted(nonexistent)
 
348
 
 
349
 
 
350
class StatusHooks(_mod_hooks.Hooks):
 
351
    """A dictionary mapping hook name to a list of callables for status hooks.
 
352
 
 
353
    e.g. ['post_status'] Is the list of items to be called when the
 
354
    status command has finished printing the status.
 
355
    """
 
356
 
 
357
    def __init__(self):
 
358
        """Create the default hooks.
 
359
 
 
360
        These are all empty initially, because by default nothing should get
 
361
        notified.
 
362
        """
 
363
        _mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
 
364
        self.add_hook('post_status',
 
365
            "Called with argument StatusHookParams after Bazaar has "
 
366
            "displayed the status. StatusHookParams has the attributes "
 
367
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
368
            "verbose). The last four arguments correspond to the command "
 
369
            "line options specified by the user for the status command. "
 
370
            "to_file is the output stream for writing.",
 
371
            (2, 3))
 
372
        self.add_hook('pre_status',
 
373
            "Called with argument StatusHookParams before Bazaar "
 
374
            "displays 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
 
 
381
 
 
382
class StatusHookParams(object):
 
383
    """Object holding parameters passed to post_status hooks.
 
384
 
 
385
    :ivar old_tree: Start tree (basis tree) for comparison.
 
386
    :ivar new_tree: Working tree.
 
387
    :ivar to_file: If set, write to this file.
 
388
    :ivar versioned: Show only versioned files.
 
389
    :ivar show_ids: Show internal object ids.
 
390
    :ivar short: Use short status indicators.
 
391
    :ivar verbose: Verbose flag.
 
392
    """
 
393
 
 
394
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
 
395
            short, verbose, specific_files=None):
 
396
        """Create a group of post_status hook parameters.
 
397
 
 
398
        :param old_tree: Start tree (basis tree) for comparison.
 
399
        :param new_tree: Working tree.
 
400
        :param to_file: If set, write to this file.
 
401
        :param versioned: Show only versioned files.
 
402
        :param show_ids: Show internal object ids.
 
403
        :param short: Use short status indicators.
 
404
        :param verbose: Verbose flag.
 
405
        :param specific_files: If set, a list of filenames whose status should be
 
406
            shown.  It is an error to give a filename that is not in the working
 
407
            tree, or in the working inventory or in the basis inventory.
 
408
        """
 
409
        self.old_tree = old_tree
 
410
        self.new_tree = new_tree
 
411
        self.to_file = to_file
 
412
        self.versioned = versioned
 
413
        self.show_ids = show_ids
 
414
        self.short = short
 
415
        self.verbose = verbose
 
416
        self.specific_files = specific_files
 
417
 
 
418
    def __eq__(self, other):
 
419
        return self.__dict__ == other.__dict__
 
420
 
 
421
    def __repr__(self):
 
422
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
 
423
            self.old_tree, self.new_tree, self.to_file, self.versioned,
 
424
            self.show_ids, self.short, self.verbose, self.specific_files)
 
425
 
 
426
 
 
427
def _show_shelve_summary(params):
 
428
    """post_status hook to display a summary of shelves.
 
429
 
 
430
    :param params: StatusHookParams.
 
431
    """
 
432
    # Don't show shelves if status of specific files is being shown, only if
 
433
    # no file arguments have been passed
 
434
    if params.specific_files:
 
435
        return
 
436
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
 
437
    if get_shelf_manager is None:
 
438
        return
 
439
    try:
 
440
        manager = get_shelf_manager()
 
441
    except ShelvingUnsupported:
 
442
        mutter('shelving not supported by tree, not displaying shelves.')
 
443
    else:
 
444
        shelves = manager.active_shelves()
 
445
        if shelves:
 
446
            singular = '%d shelf exists. '
 
447
            plural = '%d shelves exist. '
 
448
            if len(shelves) == 1:
 
449
                fmt = singular
 
450
            else:
 
451
                fmt = plural
 
452
            params.to_file.write(fmt % len(shelves))
 
453
            params.to_file.write('See "brz shelve --list" for details.\n')
 
454
 
 
455
 
 
456
hooks = StatusHooks()
 
457
 
 
458
 
 
459
hooks.install_named_hook('post_status', _show_shelve_summary,
 
460
    'brz status')
 
461