← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

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
 
17
19
import sys
18
20
 
19
21
from bzrlib import (
20
22
    delta as _mod_delta,
 
23
    hooks as _mod_hooks,
21
24
    log,
22
25
    osutils,
23
 
    tree,
24
26
    tsort,
25
27
    revision as _mod_revision,
26
28
    )
27
29
import bzrlib.errors as errors
28
 
from bzrlib.osutils import is_inside_any
29
 
from bzrlib.symbol_versioning import (deprecated_function,
30
 
        )
31
30
from bzrlib.trace import mutter, warning
32
31
 
33
32
# TODO: when showing single-line logs, truncate to the width of the terminal
37
36
def report_changes(to_file, old, new, specific_files, 
38
37
                   show_short_reporter, show_long_callback, 
39
38
                   short=False, want_unchanged=False, 
40
 
                   want_unversioned=False, show_ids=False):
 
39
                   want_unversioned=False, show_ids=False, classify=True):
41
40
    """Display summary of changes.
42
41
 
43
42
    This compares two trees with regards to a list of files, and delegates 
62
61
        files.
63
62
    :param show_ids: If set, includes each file's id.
64
63
    :param want_unversioned: If False, only shows versioned files.
 
64
    :param classify: Add special symbols to indicate file kind.
65
65
    """
66
66
 
67
67
    if short:
79
79
            delta.unversioned if not new.is_ignored(unversioned[0])]
80
80
        show_long_callback(to_file, delta, 
81
81
                           show_ids=show_ids,
82
 
                           show_unchanged=want_unchanged)
 
82
                           show_unchanged=want_unchanged,
 
83
                           classify=classify)
83
84
 
84
85
 
85
86
def show_tree_status(wt, show_unchanged=None,
91
92
                     short=False,
92
93
                     verbose=False,
93
94
                     versioned=False,
 
95
                     classify=True,
94
96
                     show_long_callback=_mod_delta.report_delta):
95
97
    """Display summary of changes.
96
98
 
120
122
    :param verbose: If True, show all merged revisions, not just
121
123
        the merge tips
122
124
    :param versioned: If True, only shows versioned files.
 
125
    :param classify: Add special symbols to indicate file kind.
123
126
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
124
127
        show_ids, show_unchanged, indent, filter), only used with the long output
125
128
    """
154
157
        old.lock_read()
155
158
        new.lock_read()
156
159
        try:
 
160
            for hook in hooks['pre_status']:
 
161
                hook(StatusHookParams(old, new, to_file, versioned,
 
162
                    show_ids, short, verbose, specific_files=specific_files))
 
163
 
157
164
            specific_files, nonexistents \
158
165
                = _filter_nonexistent(specific_files, old, new)
159
166
            want_unversioned = not versioned
160
167
 
161
168
            # Reporter used for short outputs
162
169
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
163
 
                unversioned_filter=new.is_ignored)
 
170
                unversioned_filter=new.is_ignored, classify=classify)
164
171
            report_changes(to_file, old, new, specific_files, 
165
172
                           reporter, show_long_callback, 
166
173
                           short=short, want_unchanged=show_unchanged, 
167
 
                           want_unversioned=want_unversioned, show_ids=show_ids)
 
174
                           want_unversioned=want_unversioned, show_ids=show_ids,
 
175
                           classify=classify)
 
176
 
 
177
            # show the ignored files among specific files (i.e. show the files
 
178
            # identified from input that we choose to ignore). 
 
179
            if specific_files is not None:
 
180
                # Ignored files is sorted because specific_files is already sorted
 
181
                ignored_files = [specific for specific in
 
182
                    specific_files if new.is_ignored(specific)]
 
183
                if len(ignored_files) > 0 and not short:
 
184
                    to_file.write("ignored:\n")
 
185
                    prefix = ' '
 
186
                else:
 
187
                    prefix = 'I  '
 
188
                for ignored_file in ignored_files:
 
189
                    to_file.write("%s %s\n" % (prefix, ignored_file))
168
190
 
169
191
            # show the new conflicts only for now. XXX: get them from the
170
192
            # delta.
179
201
                    prefix = 'C  '
180
202
                else:
181
203
                    prefix = ' '
182
 
                to_file.write("%s %s\n" % (prefix, conflict))
 
204
                to_file.write("%s %s\n" % (prefix, unicode(conflict)))
183
205
            # Show files that were requested but don't exist (and are
184
206
            # not versioned).  We don't involve delta in this; these
185
207
            # paths are really the province of just the status
200
222
                show_pending_merges(new, to_file, short, verbose=verbose)
201
223
            if nonexistents:
202
224
                raise errors.PathsDoNotExist(nonexistents)
 
225
            for hook in hooks['post_status']:
 
226
                hook(StatusHookParams(old, new, to_file, versioned,
 
227
                    show_ids, short, verbose, specific_files=specific_files))
203
228
        finally:
204
229
            old.unlock()
205
230
            new.unlock()
346
371
    # their groups individually.  But for consistency of this
347
372
    # function's API, it's better to sort both than just 'nonexistent'.
348
373
    return sorted(remaining), sorted(nonexistent)
 
374
 
 
375
 
 
376
class StatusHooks(_mod_hooks.Hooks):
 
377
    """A dictionary mapping hook name to a list of callables for status hooks.
 
378
 
 
379
    e.g. ['post_status'] Is the list of items to be called when the
 
380
    status command has finished printing the status.
 
381
    """
 
382
 
 
383
    def __init__(self):
 
384
        """Create the default hooks.
 
385
 
 
386
        These are all empty initially, because by default nothing should get
 
387
        notified.
 
388
        """
 
389
        _mod_hooks.Hooks.__init__(self, "bzrlib.status", "hooks")
 
390
        self.add_hook('post_status',
 
391
            "Called with argument StatusHookParams after Bazaar has "
 
392
            "displayed the status. StatusHookParams has the attributes "
 
393
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
394
            "verbose). The last four arguments correspond to the command "
 
395
            "line options specified by the user for the status command. "
 
396
            "to_file is the output stream for writing.",
 
397
            (2, 3))
 
398
        self.add_hook('pre_status',
 
399
            "Called with argument StatusHookParams before Bazaar "
 
400
            "displays the status. StatusHookParams has the attributes "
 
401
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
 
402
            "verbose). The last four arguments correspond to the command "
 
403
            "line options specified by the user for the status command. "
 
404
            "to_file is the output stream for writing.",
 
405
            (2, 3))
 
406
 
 
407
 
 
408
class StatusHookParams(object):
 
409
    """Object holding parameters passed to post_status hooks.
 
410
 
 
411
    :ivar old_tree: Start tree (basis tree) for comparison.
 
412
    :ivar new_tree: Working tree.
 
413
    :ivar to_file: If set, write to this file.
 
414
    :ivar versioned: Show only versioned files.
 
415
    :ivar show_ids: Show internal object ids.
 
416
    :ivar short: Use short status indicators.
 
417
    :ivar verbose: Verbose flag.
 
418
    """
 
419
 
 
420
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
 
421
            short, verbose, specific_files=None):
 
422
        """Create a group of post_status hook parameters.
 
423
 
 
424
        :param old_tree: Start tree (basis tree) for comparison.
 
425
        :param new_tree: Working tree.
 
426
        :param to_file: If set, write to this file.
 
427
        :param versioned: Show only versioned files.
 
428
        :param show_ids: Show internal object ids.
 
429
        :param short: Use short status indicators.
 
430
        :param verbose: Verbose flag.
 
431
        :param specific_files: If set, a list of filenames whose status should be
 
432
            shown.  It is an error to give a filename that is not in the working
 
433
            tree, or in the working inventory or in the basis inventory.
 
434
        """
 
435
        self.old_tree = old_tree
 
436
        self.new_tree = new_tree
 
437
        self.to_file = to_file
 
438
        self.versioned = versioned
 
439
        self.show_ids = show_ids
 
440
        self.short = short
 
441
        self.verbose = verbose
 
442
        self.specific_files = specific_files
 
443
 
 
444
    def __eq__(self, other):
 
445
        return self.__dict__ == other.__dict__
 
446
 
 
447
    def __repr__(self):
 
448
        return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
 
449
            self.old_tree, self.new_tree, self.to_file, self.versioned,
 
450
            self.show_ids, self.short, self.verbose, self.specific_files)
 
451
 
 
452
 
 
453
def _show_shelve_summary(params):
 
454
    """post_status hook to display a summary of shelves.
 
455
 
 
456
    :param params: StatusHookParams.
 
457
    """
 
458
    # Don't show shelves if status of specific files is being shown, only if
 
459
    # no file arguments have been passed
 
460
    if params.specific_files:
 
461
        return
 
462
    get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
 
463
    if get_shelf_manager is None:
 
464
        return
 
465
    manager = get_shelf_manager()
 
466
    shelves = manager.active_shelves()
 
467
    if shelves:
 
468
        singular = '%d shelf exists. '
 
469
        plural = '%d shelves exist. '
 
470
        if len(shelves) == 1:
 
471
            fmt = singular
 
472
        else:
 
473
            fmt = plural
 
474
        params.to_file.write(fmt % len(shelves))
 
475
        params.to_file.write('See "bzr shelve --list" for details.\n')
 
476
 
 
477
 
 
478
hooks = StatusHooks()
 
479
 
 
480
 
 
481
hooks.install_named_hook('post_status', _show_shelve_summary,
 
482
    'bzr status')
 
483