~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import sys
18
18
 
20
20
    delta as _mod_delta,
21
21
    log,
22
22
    osutils,
23
 
    tree,
24
23
    tsort,
25
24
    revision as _mod_revision,
26
25
    )
27
 
from bzrlib.diff import _raise_if_nonexistent
28
26
import bzrlib.errors as errors
29
 
from bzrlib.osutils import is_inside_any
30
 
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        )
32
 
from bzrlib.trace import warning
 
27
from bzrlib.trace import mutter, warning
33
28
 
34
29
# TODO: when showing single-line logs, truncate to the width of the terminal
35
30
# if known, but only if really going to the terminal (not into a file)
36
31
 
37
32
 
 
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):
 
37
    """Display summary of changes.
 
38
 
 
39
    This compares two trees with regards to a list of files, and delegates 
 
40
    the display to underlying elements.
 
41
 
 
42
    For short output, it creates an iterator on all changes, and lets a given
 
43
    reporter display these changes.
 
44
 
 
45
    For stantard output, it creates a delta of the changes, and forwards it
 
46
    to a callback
 
47
 
 
48
    :param to_file: If set, write to this file (default stdout.)
 
49
    :param old: Start tree for the comparison
 
50
    :param end: End tree for the comparison
 
51
    :param specific_files: If set, a list of filenames whose status should be
 
52
        shown.  It is an error to give a filename that is not in the working
 
53
        tree, or in the working inventory or in the basis inventory.
 
54
    :param show_short_reporter: Reporter in charge of display for short output
 
55
    :param show_long_callback: Callback in charge of display for normal output
 
56
    :param short: If True, gives short SVN-style status lines.
 
57
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
 
58
        files.
 
59
    :param show_ids: If set, includes each file's id.
 
60
    :param want_unversioned: If False, only shows versioned files.
 
61
    """
 
62
 
 
63
    if short:
 
64
        changes = new.iter_changes(old, want_unchanged, specific_files,
 
65
            require_versioned=False, want_unversioned=want_unversioned)
 
66
        _mod_delta.report_changes(changes, show_short_reporter)
 
67
        
 
68
    else:
 
69
        delta = new.changes_from(old, want_unchanged=want_unchanged,
 
70
                              specific_files=specific_files,
 
71
                              want_unversioned=want_unversioned)
 
72
        # filter out unknown files. We may want a tree method for
 
73
        # this
 
74
        delta.unversioned = [unversioned for unversioned in
 
75
            delta.unversioned if not new.is_ignored(unversioned[0])]
 
76
        show_long_callback(to_file, delta, 
 
77
                           show_ids=show_ids,
 
78
                           show_unchanged=want_unchanged)
 
79
 
 
80
 
38
81
def show_tree_status(wt, show_unchanged=None,
39
82
                     specific_files=None,
40
83
                     show_ids=False,
42
85
                     show_pending=True,
43
86
                     revision=None,
44
87
                     short=False,
45
 
                     versioned=False):
 
88
                     verbose=False,
 
89
                     versioned=False,
 
90
                     show_long_callback=_mod_delta.report_delta):
46
91
    """Display summary of changes.
47
92
 
48
 
    By default this compares the working tree to a previous revision. 
49
 
    If the revision argument is given, summarizes changes between the 
 
93
    By default this compares the working tree to a previous revision.
 
94
    If the revision argument is given, summarizes changes between the
50
95
    working tree and another, or between two revisions.
51
96
 
52
 
    The result is written out as Unicode and to_file should be able 
 
97
    The result is written out as Unicode and to_file should be able
53
98
    to encode that.
54
99
 
55
100
    If showing the status of a working tree, extra information is included
56
101
    about unknown files, conflicts, and pending merges.
57
102
 
58
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
103
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
59
104
        files.
60
105
    :param specific_files: If set, a list of filenames whose status should be
61
 
        shown.  It is an error to give a filename that is not in the working 
 
106
        shown.  It is an error to give a filename that is not in the working
62
107
        tree, or in the working inventory or in the basis inventory.
63
108
    :param show_ids: If set, includes each file's id.
64
109
    :param to_file: If set, write to this file (default stdout.)
68
113
        If one revision, compare with working tree.
69
114
        If two revisions, show status between first and second.
70
115
    :param short: If True, gives short SVN-style status lines.
 
116
    :param verbose: If True, show all merged revisions, not just
 
117
        the merge tips
71
118
    :param versioned: If True, only shows versioned files.
 
119
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
 
120
        show_ids, show_unchanged, indent, filter), only used with the long output
72
121
    """
73
122
    if show_unchanged is not None:
74
123
        warn("show_tree_status with show_unchanged has been deprecated "
76
125
 
77
126
    if to_file is None:
78
127
        to_file = sys.stdout
79
 
    
 
128
 
80
129
    wt.lock_read()
81
130
    try:
82
131
        new_is_working_tree = True
87
136
            old = new.basis_tree()
88
137
        elif len(revision) > 0:
89
138
            try:
90
 
                rev_id = revision[0].as_revision_id(wt.branch)
91
 
                old = wt.branch.repository.revision_tree(rev_id)
 
139
                old = revision[0].as_tree(wt.branch)
92
140
            except errors.NoSuchRevision, e:
93
141
                raise errors.BzrCommandError(str(e))
94
142
            if (len(revision) > 1) and (revision[1].spec is not None):
95
143
                try:
96
 
                    rev_id = revision[1].as_revision_id(wt.branch)
97
 
                    new = wt.branch.repository.revision_tree(rev_id)
 
144
                    new = revision[1].as_tree(wt.branch)
98
145
                    new_is_working_tree = False
99
146
                except errors.NoSuchRevision, e:
100
147
                    raise errors.BzrCommandError(str(e))
103
150
        old.lock_read()
104
151
        new.lock_read()
105
152
        try:
106
 
            _raise_if_nonexistent(specific_files, old, new)
 
153
            specific_files, nonexistents \
 
154
                = _filter_nonexistent(specific_files, old, new)
107
155
            want_unversioned = not versioned
108
 
            if short:
109
 
                changes = new.iter_changes(old, show_unchanged, specific_files,
110
 
                    require_versioned=False, want_unversioned=want_unversioned)
111
 
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
112
 
                    unversioned_filter=new.is_ignored)
113
 
                _mod_delta.report_changes(changes, reporter)
114
 
            else:
115
 
                delta = new.changes_from(old, want_unchanged=show_unchanged,
116
 
                                      specific_files=specific_files,
117
 
                                      want_unversioned=want_unversioned)
118
 
                # filter out unknown files. We may want a tree method for
119
 
                # this
120
 
                delta.unversioned = [unversioned for unversioned in
121
 
                    delta.unversioned if not new.is_ignored(unversioned[0])]
122
 
                delta.show(to_file,
123
 
                           show_ids=show_ids,
124
 
                           show_unchanged=show_unchanged,
125
 
                           short_status=False)
 
156
 
 
157
            # Reporter used for short outputs
 
158
            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)
 
164
 
 
165
            # show the ignored files among specific files (i.e. show the files
 
166
            # identified from input that we choose to ignore). 
 
167
            if specific_files is not None:
 
168
                # Ignored files is sorted because specific_files is already sorted
 
169
                ignored_files = [specific for specific in
 
170
                    specific_files if new.is_ignored(specific)]
 
171
                if len(ignored_files) > 0 and not short:
 
172
                    to_file.write("ignored:\n")
 
173
                    prefix = ' '
 
174
                else:
 
175
                    prefix = 'I  '
 
176
                for ignored_file in ignored_files:
 
177
                    to_file.write("%s %s\n" % (prefix, ignored_file))
 
178
 
126
179
            # show the new conflicts only for now. XXX: get them from the
127
180
            # delta.
128
181
            conflicts = new.conflicts()
137
190
                else:
138
191
                    prefix = ' '
139
192
                to_file.write("%s %s\n" % (prefix, conflict))
140
 
            if (new_is_working_tree and show_pending
141
 
                and specific_files is None):
142
 
                show_pending_merges(new, to_file, short)
 
193
            # Show files that were requested but don't exist (and are
 
194
            # not versioned).  We don't involve delta in this; these
 
195
            # paths are really the province of just the status
 
196
            # command, since they have more to do with how it was
 
197
            # invoked than with the tree it's operating on.
 
198
            if nonexistents and not short:
 
199
                to_file.write("nonexistent:\n")
 
200
            for nonexistent in nonexistents:
 
201
                # We could calculate prefix outside the loop but, given
 
202
                # how rarely this ought to happen, it's OK and arguably
 
203
                # slightly faster to do it here (ala conflicts above)
 
204
                if short:
 
205
                    prefix = 'X  '
 
206
                else:
 
207
                    prefix = ' '
 
208
                to_file.write("%s %s\n" % (prefix, nonexistent))
 
209
            if (new_is_working_tree and show_pending):
 
210
                show_pending_merges(new, to_file, short, verbose=verbose)
 
211
            if nonexistents:
 
212
                raise errors.PathsDoNotExist(nonexistents)
143
213
        finally:
144
214
            old.unlock()
145
215
            new.unlock()
173
243
    return sorter.iter_topo_order()
174
244
 
175
245
 
176
 
def show_pending_merges(new, to_file, short=False):
 
246
def show_pending_merges(new, to_file, short=False, verbose=False):
177
247
    """Write out a display of pending merges in a working tree."""
178
248
    parents = new.get_parent_ids()
179
249
    if len(parents) < 2:
180
250
        return
181
251
 
182
 
    # we need one extra space for terminals that wrap on last char
183
 
    term_width = osutils.terminal_width() - 1
 
252
    term_width = osutils.terminal_width()
 
253
    if term_width is not None:
 
254
        # we need one extra space for terminals that wrap on last char
 
255
        term_width = term_width - 1
184
256
    if short:
185
257
        first_prefix = 'P   '
186
258
        sub_prefix = 'P.   '
188
260
        first_prefix = '  '
189
261
        sub_prefix = '    '
190
262
 
 
263
    def show_log_message(rev, prefix):
 
264
        if term_width is None:
 
265
            width = term_width
 
266
        else:
 
267
            width = term_width - len(prefix)
 
268
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
 
269
        to_file.write(log_message + '\n')
 
270
 
191
271
    pending = parents[1:]
192
272
    branch = new.branch
193
273
    last_revision = parents[0]
194
274
    if not short:
195
 
        to_file.write('pending merges:\n')
 
275
        if verbose:
 
276
            to_file.write('pending merges:\n')
 
277
        else:
 
278
            to_file.write('pending merge tips:'
 
279
                          ' (use -v to see all merge revisions)\n')
196
280
    graph = branch.repository.get_graph()
197
281
    other_revisions = [last_revision]
198
282
    log_formatter = log.LineLogFormatter(to_file)
206
290
            continue
207
291
 
208
292
        # Log the merge, as it gets a slightly different formatting
209
 
        log_message = log_formatter.log_string(None, rev,
210
 
                        term_width - len(first_prefix))
211
 
        to_file.write(first_prefix + log_message + '\n')
 
293
        show_log_message(rev, first_prefix)
 
294
        if not verbose:
 
295
            continue
 
296
 
212
297
        # Find all of the revisions in the merge source, which are not in the
213
298
        # last committed revision.
214
299
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
243
328
            if rev is None:
244
329
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
245
330
                continue
246
 
            log_message = log_formatter.log_string(None,
247
 
                            revisions[sub_merge],
248
 
                            term_width - len(sub_prefix))
249
 
            to_file.write(sub_prefix + log_message + '\n')
 
331
            show_log_message(revisions[sub_merge], sub_prefix)
 
332
 
 
333
 
 
334
def _filter_nonexistent(orig_paths, old_tree, new_tree):
 
335
    """Convert orig_paths to two sorted lists and return them.
 
336
 
 
337
    The first is orig_paths paths minus the items in the second list,
 
338
    and the second list is paths that are not in either inventory or
 
339
    tree (they don't qualify if they exist in the tree's inventory, or
 
340
    if they exist in the tree but are not versioned.)
 
341
 
 
342
    If either of the two lists is empty, return it as an empty list.
 
343
 
 
344
    This can be used by operations such as bzr status that can accept
 
345
    unknown or ignored files.
 
346
    """
 
347
    mutter("check paths: %r", orig_paths)
 
348
    if not orig_paths:
 
349
        return orig_paths, []
 
350
    s = old_tree.filter_unversioned_files(orig_paths)
 
351
    s = new_tree.filter_unversioned_files(s)
 
352
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
 
353
    remaining   = [path for path in orig_paths if not path in nonexistent]
 
354
    # Sorting the 'remaining' list doesn't have much effect in
 
355
    # practice, since the various status output sections will sort
 
356
    # their groups individually.  But for consistency of this
 
357
    # function's API, it's better to sort both than just 'nonexistent'.
 
358
    return sorted(remaining), sorted(nonexistent)