/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 bzrlib/status.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

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