← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-19 17:53:37 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619175337-uozt3bntdd48lh4z
Update time_graph to use X:1 ratios rather than 0.xxx ratios.
It is just easier to track now that the new code is much faster.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/status.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
18
18
 
19
19
from bzrlib import (
20
20
    delta as _mod_delta,
21
 
    hooks as _mod_hooks,
22
21
    log,
23
22
    osutils,
 
23
    tree,
24
24
    tsort,
25
25
    revision as _mod_revision,
26
26
    )
27
27
import bzrlib.errors as errors
 
28
from bzrlib.osutils import is_inside_any
 
29
from bzrlib.symbol_versioning import (deprecated_function,
 
30
        )
28
31
from bzrlib.trace import mutter, warning
29
32
 
30
33
# TODO: when showing single-line logs, truncate to the width of the terminal
31
34
# if known, but only if really going to the terminal (not into a file)
32
35
 
33
36
 
34
 
def report_changes(to_file, old, new, specific_files, 
35
 
                   show_short_reporter, show_long_callback, 
36
 
                   short=False, want_unchanged=False, 
37
 
                   want_unversioned=False, show_ids=False):
38
 
    """Display summary of changes.
39
 
 
40
 
    This compares two trees with regards to a list of files, and delegates 
41
 
    the display to underlying elements.
42
 
 
43
 
    For short output, it creates an iterator on all changes, and lets a given
44
 
    reporter display these changes.
45
 
 
46
 
    For stantard output, it creates a delta of the changes, and forwards it
47
 
    to a callback
48
 
 
49
 
    :param to_file: If set, write to this file (default stdout.)
50
 
    :param old: Start tree for the comparison
51
 
    :param end: End tree for the comparison
52
 
    :param specific_files: If set, a list of filenames whose status should be
53
 
        shown.  It is an error to give a filename that is not in the working
54
 
        tree, or in the working inventory or in the basis inventory.
55
 
    :param show_short_reporter: Reporter in charge of display for short output
56
 
    :param show_long_callback: Callback in charge of display for normal output
57
 
    :param short: If True, gives short SVN-style status lines.
58
 
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
59
 
        files.
60
 
    :param show_ids: If set, includes each file's id.
61
 
    :param want_unversioned: If False, only shows versioned files.
62
 
    """
63
 
 
64
 
    if short:
65
 
        changes = new.iter_changes(old, want_unchanged, specific_files,
66
 
            require_versioned=False, want_unversioned=want_unversioned)
67
 
        _mod_delta.report_changes(changes, show_short_reporter)
68
 
        
69
 
    else:
70
 
        delta = new.changes_from(old, want_unchanged=want_unchanged,
71
 
                              specific_files=specific_files,
72
 
                              want_unversioned=want_unversioned)
73
 
        # filter out unknown files. We may want a tree method for
74
 
        # this
75
 
        delta.unversioned = [unversioned for unversioned in
76
 
            delta.unversioned if not new.is_ignored(unversioned[0])]
77
 
        show_long_callback(to_file, delta, 
78
 
                           show_ids=show_ids,
79
 
                           show_unchanged=want_unchanged)
80
 
 
81
 
 
82
37
def show_tree_status(wt, show_unchanged=None,
83
38
                     specific_files=None,
84
39
                     show_ids=False,
87
42
                     revision=None,
88
43
                     short=False,
89
44
                     verbose=False,
90
 
                     versioned=False,
91
 
                     show_long_callback=_mod_delta.report_delta):
 
45
                     versioned=False):
92
46
    """Display summary of changes.
93
47
 
94
48
    By default this compares the working tree to a previous revision.
117
71
    :param verbose: If True, show all merged revisions, not just
118
72
        the merge tips
119
73
    :param versioned: If True, only shows versioned files.
120
 
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
121
 
        show_ids, show_unchanged, indent, filter), only used with the long output
122
74
    """
123
75
    if show_unchanged is not None:
124
76
        warn("show_tree_status with show_unchanged has been deprecated "
151
103
        old.lock_read()
152
104
        new.lock_read()
153
105
        try:
154
 
            for hook in hooks['pre_status']:
155
 
                hook(StatusHookParams(old, new, to_file, versioned,
156
 
                    show_ids, short, verbose))
157
 
 
158
106
            specific_files, nonexistents \
159
107
                = _filter_nonexistent(specific_files, old, new)
160
108
            want_unversioned = not versioned
161
 
 
162
 
            # Reporter used for short outputs
163
 
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
164
 
                unversioned_filter=new.is_ignored)
165
 
            report_changes(to_file, old, new, specific_files, 
166
 
                           reporter, show_long_callback, 
167
 
                           short=short, want_unchanged=show_unchanged, 
168
 
                           want_unversioned=want_unversioned, show_ids=show_ids)
169
 
 
170
 
            # show the ignored files among specific files (i.e. show the files
171
 
            # identified from input that we choose to ignore). 
172
 
            if specific_files is not None:
173
 
                # Ignored files is sorted because specific_files is already sorted
174
 
                ignored_files = [specific for specific in
175
 
                    specific_files if new.is_ignored(specific)]
176
 
                if len(ignored_files) > 0 and not short:
177
 
                    to_file.write("ignored:\n")
178
 
                    prefix = ' '
179
 
                else:
180
 
                    prefix = 'I  '
181
 
                for ignored_file in ignored_files:
182
 
                    to_file.write("%s %s\n" % (prefix, ignored_file))
183
 
 
 
109
            if short:
 
110
                changes = new.iter_changes(old, show_unchanged, specific_files,
 
111
                    require_versioned=False, want_unversioned=want_unversioned)
 
112
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
113
                    unversioned_filter=new.is_ignored)
 
114
                _mod_delta.report_changes(changes, reporter)
 
115
            else:
 
116
                delta = new.changes_from(old, want_unchanged=show_unchanged,
 
117
                                      specific_files=specific_files,
 
118
                                      want_unversioned=want_unversioned)
 
119
                # filter out unknown files. We may want a tree method for
 
120
                # this
 
121
                delta.unversioned = [unversioned for unversioned in
 
122
                    delta.unversioned if not new.is_ignored(unversioned[0])]
 
123
                delta.show(to_file,
 
124
                           show_ids=show_ids,
 
125
                           show_unchanged=show_unchanged,
 
126
                           short_status=False)
184
127
            # show the new conflicts only for now. XXX: get them from the
185
128
            # delta.
186
129
            conflicts = new.conflicts()
213
156
                to_file.write("%s %s\n" % (prefix, nonexistent))
214
157
            if (new_is_working_tree and show_pending):
215
158
                show_pending_merges(new, to_file, short, verbose=verbose)
216
 
            if nonexistents:
217
 
                raise errors.PathsDoNotExist(nonexistents)
218
 
            for hook in hooks['post_status']:
219
 
                hook(StatusHookParams(old, new, to_file, versioned,
220
 
                    show_ids, short, verbose))
221
159
        finally:
222
160
            old.unlock()
223
161
            new.unlock()
 
162
            if nonexistents:
 
163
              raise errors.PathsDoNotExist(nonexistents)
224
164
    finally:
225
165
        wt.unlock()
226
166
 
257
197
    if len(parents) < 2:
258
198
        return
259
199
 
260
 
    term_width = osutils.terminal_width()
261
 
    if term_width is not None:
262
 
        # we need one extra space for terminals that wrap on last char
263
 
        term_width = term_width - 1
 
200
    # we need one extra space for terminals that wrap on last char
 
201
    term_width = osutils.terminal_width() - 1
264
202
    if short:
265
203
        first_prefix = 'P   '
266
204
        sub_prefix = 'P.   '
268
206
        first_prefix = '  '
269
207
        sub_prefix = '    '
270
208
 
271
 
    def show_log_message(rev, prefix):
272
 
        if term_width is None:
273
 
            width = term_width
274
 
        else:
275
 
            width = term_width - len(prefix)
276
 
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
277
 
        to_file.write(log_message + '\n')
278
 
 
279
209
    pending = parents[1:]
280
210
    branch = new.branch
281
211
    last_revision = parents[0]
283
213
        if verbose:
284
214
            to_file.write('pending merges:\n')
285
215
        else:
286
 
            to_file.write('pending merge tips:'
287
 
                          ' (use -v to see all merge revisions)\n')
 
216
            to_file.write('pending merge tips: (use -v to see all merge revisions)\n')
288
217
    graph = branch.repository.get_graph()
289
218
    other_revisions = [last_revision]
290
219
    log_formatter = log.LineLogFormatter(to_file)
298
227
            continue
299
228
 
300
229
        # Log the merge, as it gets a slightly different formatting
301
 
        show_log_message(rev, first_prefix)
 
230
        log_message = log_formatter.log_string(None, rev,
 
231
                        term_width - len(first_prefix))
 
232
        to_file.write(first_prefix + log_message + '\n')
302
233
        if not verbose:
303
234
            continue
304
235
 
336
267
            if rev is None:
337
268
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
338
269
                continue
339
 
            show_log_message(revisions[sub_merge], sub_prefix)
 
270
            log_message = log_formatter.log_string(None,
 
271
                            revisions[sub_merge],
 
272
                            term_width - len(sub_prefix))
 
273
            to_file.write(sub_prefix + log_message + '\n')
340
274
 
341
275
 
342
276
def _filter_nonexistent(orig_paths, old_tree, new_tree):
364
298
    # their groups individually.  But for consistency of this
365
299
    # function's API, it's better to sort both than just 'nonexistent'.
366
300
    return sorted(remaining), sorted(nonexistent)
367
 
 
368
 
 
369
 
class StatusHooks(_mod_hooks.Hooks):
370
 
    """A dictionary mapping hook name to a list of callables for status hooks.
371
 
 
372
 
    e.g. ['post_status'] Is the list of items to be called when the
373
 
    status command has finished printing the status.
374
 
    """
375
 
 
376
 
    def __init__(self):
377
 
        """Create the default hooks.
378
 
 
379
 
        These are all empty initially, because by default nothing should get
380
 
        notified.
381
 
        """
382
 
        _mod_hooks.Hooks.__init__(self)
383
 
        self.create_hook(_mod_hooks.HookPoint('post_status',
384
 
            "Called with argument StatusHookParams after Bazaar has "
385
 
            "displayed the status. StatusHookParams has the attributes "
386
 
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
387
 
            "verbose). The last four arguments correspond to the command "
388
 
            "line options specified by the user for the status command. "
389
 
            "to_file is the output stream for writing.",
390
 
            (2, 3), None))
391
 
        self.create_hook(_mod_hooks.HookPoint('pre_status',
392
 
            "Called with argument StatusHookParams before Bazaar "
393
 
            "displays the status. StatusHookParams has the attributes "
394
 
            "(old_tree, new_tree, to_file, versioned, show_ids, short, "
395
 
            "verbose). The last four arguments correspond to the command "
396
 
            "line options specified by the user for the status command. "
397
 
            "to_file is the output stream for writing.",
398
 
            (2, 3), None))
399
 
 
400
 
 
401
 
class StatusHookParams(object):
402
 
    """Object holding parameters passed to post_status hooks.
403
 
 
404
 
    :ivar old_tree: Start tree (basis tree) for comparison.
405
 
    :ivar new_tree: Working tree.
406
 
    :ivar to_file: If set, write to this file.
407
 
    :ivar versioned: Show only versioned files.
408
 
    :ivar show_ids: Show internal object ids.
409
 
    :ivar short: Use short status indicators.
410
 
    :ivar verbose: Verbose flag.
411
 
    """
412
 
 
413
 
    def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
414
 
            short, verbose):
415
 
        """Create a group of post_status hook parameters.
416
 
 
417
 
        :param old_tree: Start tree (basis tree) for comparison.
418
 
        :param new_tree: Working tree.
419
 
        :param to_file: If set, write to this file.
420
 
        :param versioned: Show only versioned files.
421
 
        :param show_ids: Show internal object ids.
422
 
        :param short: Use short status indicators.
423
 
        :param verbose: Verbose flag.
424
 
        """
425
 
        self.old_tree = old_tree
426
 
        self.new_tree = new_tree
427
 
        self.to_file = to_file
428
 
        self.versioned = versioned
429
 
        self.show_ids = show_ids
430
 
        self.short = short
431
 
        self.verbose = verbose
432
 
 
433
 
    def __eq__(self, other):
434
 
        return self.__dict__ == other.__dict__
435
 
 
436
 
    def __repr__(self):
437
 
        return "<%s(%s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
438
 
            self.old_tree, self.new_tree, self.to_file, self.versioned,
439
 
            self.show_ids, self.short, self.verbose)
440
 
 
441
 
 
442
 
def _show_shelve_summary(params):
443
 
    """post_status hook to display a summary of shelves.
444
 
 
445
 
    :param params: StatusHookParams.
446
 
    """
447
 
    manager = params.new_tree.get_shelf_manager()
448
 
    shelves = manager.active_shelves()
449
 
    if shelves:
450
 
        params.to_file.write('%d shelves exist. '
451
 
            'See "bzr shelve --list" for details.\n' % len(shelves))
452
 
 
453
 
 
454
 
hooks = StatusHooks()
455
 
 
456
 
 
457
 
hooks.install_named_hook('post_status', _show_shelve_summary,
458
 
    'bzr status')
459