~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Aaron Bentley
  • Date: 2008-11-15 19:41:37 UTC
  • mto: This revision was merged to the branch mainline in revision 3841.
  • Revision ID: aaron@aaronbentley.com-20081115194137-wghezl9da7aluk3p
Add tests for plugins

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import sys
18
18
 
20
20
    delta as _mod_delta,
21
21
    log,
22
22
    osutils,
 
23
    tree,
23
24
    tsort,
24
25
    revision as _mod_revision,
25
26
    )
26
27
import bzrlib.errors as errors
 
28
from bzrlib.osutils import is_inside_any
 
29
from bzrlib.symbol_versioning import (deprecated_function,
 
30
        )
27
31
from bzrlib.trace import mutter, warning
28
32
 
29
33
# TODO: when showing single-line logs, truncate to the width of the terminal
30
34
# if known, but only if really going to the terminal (not into a file)
31
35
 
32
36
 
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
 
 
81
37
def show_tree_status(wt, show_unchanged=None,
82
38
                     specific_files=None,
83
39
                     show_ids=False,
85
41
                     show_pending=True,
86
42
                     revision=None,
87
43
                     short=False,
88
 
                     verbose=False,
89
 
                     versioned=False,
90
 
                     show_long_callback=_mod_delta.report_delta):
 
44
                     versioned=False):
91
45
    """Display summary of changes.
92
46
 
93
 
    By default this compares the working tree to a previous revision.
94
 
    If the revision argument is given, summarizes changes between the
 
47
    By default this compares the working tree to a previous revision. 
 
48
    If the revision argument is given, summarizes changes between the 
95
49
    working tree and another, or between two revisions.
96
50
 
97
 
    The result is written out as Unicode and to_file should be able
 
51
    The result is written out as Unicode and to_file should be able 
98
52
    to encode that.
99
53
 
100
54
    If showing the status of a working tree, extra information is included
101
55
    about unknown files, conflicts, and pending merges.
102
56
 
103
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
 
57
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
104
58
        files.
105
59
    :param specific_files: If set, a list of filenames whose status should be
106
 
        shown.  It is an error to give a filename that is not in the working
 
60
        shown.  It is an error to give a filename that is not in the working 
107
61
        tree, or in the working inventory or in the basis inventory.
108
62
    :param show_ids: If set, includes each file's id.
109
63
    :param to_file: If set, write to this file (default stdout.)
113
67
        If one revision, compare with working tree.
114
68
        If two revisions, show status between first and second.
115
69
    :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
118
70
    :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
121
71
    """
122
72
    if show_unchanged is not None:
123
73
        warn("show_tree_status with show_unchanged has been deprecated "
125
75
 
126
76
    if to_file is None:
127
77
        to_file = sys.stdout
128
 
 
 
78
    
129
79
    wt.lock_read()
130
80
    try:
131
81
        new_is_working_tree = True
150
100
        old.lock_read()
151
101
        new.lock_read()
152
102
        try:
153
 
            specific_files, nonexistents \
154
 
                = _filter_nonexistent(specific_files, old, new)
 
103
            _raise_if_nonexistent(specific_files, old, new)
155
104
            want_unversioned = not versioned
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
 
 
 
105
            if short:
 
106
                changes = new.iter_changes(old, show_unchanged, specific_files,
 
107
                    require_versioned=False, want_unversioned=want_unversioned)
 
108
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
109
                    unversioned_filter=new.is_ignored)
 
110
                _mod_delta.report_changes(changes, reporter)
 
111
            else:
 
112
                delta = new.changes_from(old, want_unchanged=show_unchanged,
 
113
                                      specific_files=specific_files,
 
114
                                      want_unversioned=want_unversioned)
 
115
                # filter out unknown files. We may want a tree method for
 
116
                # this
 
117
                delta.unversioned = [unversioned for unversioned in
 
118
                    delta.unversioned if not new.is_ignored(unversioned[0])]
 
119
                delta.show(to_file,
 
120
                           show_ids=show_ids,
 
121
                           show_unchanged=show_unchanged,
 
122
                           short_status=False)
179
123
            # show the new conflicts only for now. XXX: get them from the
180
124
            # delta.
181
125
            conflicts = new.conflicts()
190
134
                else:
191
135
                    prefix = ' '
192
136
                to_file.write("%s %s\n" % (prefix, conflict))
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
137
            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)
 
138
                show_pending_merges(new, to_file, short)
213
139
        finally:
214
140
            old.unlock()
215
141
            new.unlock()
243
169
    return sorter.iter_topo_order()
244
170
 
245
171
 
246
 
def show_pending_merges(new, to_file, short=False, verbose=False):
 
172
def show_pending_merges(new, to_file, short=False):
247
173
    """Write out a display of pending merges in a working tree."""
248
174
    parents = new.get_parent_ids()
249
175
    if len(parents) < 2:
250
176
        return
251
177
 
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
 
178
    # we need one extra space for terminals that wrap on last char
 
179
    term_width = osutils.terminal_width() - 1
256
180
    if short:
257
181
        first_prefix = 'P   '
258
182
        sub_prefix = 'P.   '
260
184
        first_prefix = '  '
261
185
        sub_prefix = '    '
262
186
 
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
 
 
271
187
    pending = parents[1:]
272
188
    branch = new.branch
273
189
    last_revision = parents[0]
274
190
    if not short:
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')
 
191
        to_file.write('pending merges:\n')
280
192
    graph = branch.repository.get_graph()
281
193
    other_revisions = [last_revision]
282
194
    log_formatter = log.LineLogFormatter(to_file)
290
202
            continue
291
203
 
292
204
        # Log the merge, as it gets a slightly different formatting
293
 
        show_log_message(rev, first_prefix)
294
 
        if not verbose:
295
 
            continue
296
 
 
 
205
        log_message = log_formatter.log_string(None, rev,
 
206
                        term_width - len(first_prefix))
 
207
        to_file.write(first_prefix + log_message + '\n')
297
208
        # Find all of the revisions in the merge source, which are not in the
298
209
        # last committed revision.
299
210
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
328
239
            if rev is None:
329
240
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
330
241
                continue
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
 
 
 
242
            log_message = log_formatter.log_string(None,
 
243
                            revisions[sub_merge],
 
244
                            term_width - len(sub_prefix))
 
245
            to_file.write(sub_prefix + log_message + '\n')
 
246
 
 
247
 
 
248
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
249
    """Complain if paths are not in either inventory or tree.
 
250
 
 
251
    It's OK with the files exist in either tree's inventory, or 
 
252
    if they exist in the tree but are not versioned.
 
253
    
344
254
    This can be used by operations such as bzr status that can accept
345
255
    unknown or ignored files.
346
256
    """
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)
 
257
    mutter("check paths: %r", paths)
 
258
    if not paths:
 
259
        return
 
260
    s = old_tree.filter_unversioned_files(paths)
351
261
    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)
 
262
    s = [path for path in s if not new_tree.has_filename(path)]
 
263
    if s:
 
264
        raise errors.PathsDoNotExist(sorted(s))
 
265
 
 
266