~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Robert Collins
  • Date: 2009-07-07 04:32:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4524.
  • Revision ID: robertc@robertcollins.net-20090707043213-4hjjhgr40iq7gk2d
More informative assertions in xml serialisation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
19
19
from bzrlib import (
20
20
    delta as _mod_delta,
 
21
    log,
 
22
    osutils,
21
23
    tree,
 
24
    tsort,
 
25
    revision as _mod_revision,
22
26
    )
23
 
from bzrlib.diff import _raise_if_nonexistent
24
27
import bzrlib.errors as errors
25
 
from bzrlib.log import line_log
26
28
from bzrlib.osutils import is_inside_any
27
29
from bzrlib.symbol_versioning import (deprecated_function,
28
 
        zero_eight,
29
30
        )
30
 
from bzrlib.trace import warning
 
31
from bzrlib.trace import mutter, warning
31
32
 
32
33
# TODO: when showing single-line logs, truncate to the width of the terminal
33
34
# if known, but only if really going to the terminal (not into a file)
34
35
 
35
36
 
36
 
@deprecated_function(zero_eight)
37
 
def show_status(branch, show_unchanged=None,
38
 
                specific_files=None,
39
 
                show_ids=False,
40
 
                to_file=None,
41
 
                show_pending=True,
42
 
                revision=None):
43
 
    """Display summary of changes.
44
 
 
45
 
    Please use show_tree_status instead.
46
 
 
47
 
    By default this compares the working tree to a previous revision. 
48
 
    If the revision argument is given, summarizes changes between the 
49
 
    working tree and another, or between two revisions.
50
 
 
51
 
    The result is written out as Unicode and to_file should be able 
52
 
    to encode that.
53
 
 
54
 
    show_unchanged
55
 
        If set, includes unchanged files.
56
 
 
57
 
    specific_files
58
 
        If set, only show the status of files in this list.
59
 
 
60
 
    show_ids
61
 
        If set, includes each file's id.
62
 
 
63
 
    to_file
64
 
        If set, write to this file (default stdout.)
65
 
 
66
 
    show_pending
67
 
        If set, write pending merges.
68
 
 
69
 
    revision
70
 
        If None the compare latest revision with working tree
71
 
        If one revision show compared it with working tree.
72
 
        If two revisions show status between first and second.
73
 
    """
74
 
    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 
75
 
                     specific_files, show_ids, to_file, show_pending, revision)
76
 
 
77
 
 
78
37
def show_tree_status(wt, show_unchanged=None,
79
38
                     specific_files=None,
80
39
                     show_ids=False,
82
41
                     show_pending=True,
83
42
                     revision=None,
84
43
                     short=False,
 
44
                     verbose=False,
85
45
                     versioned=False):
86
46
    """Display summary of changes.
87
47
 
88
 
    By default this compares the working tree to a previous revision. 
89
 
    If the revision argument is given, summarizes changes between the 
 
48
    By default this compares the working tree to a previous revision.
 
49
    If the revision argument is given, summarizes changes between the
90
50
    working tree and another, or between two revisions.
91
51
 
92
 
    The result is written out as Unicode and to_file should be able 
 
52
    The result is written out as Unicode and to_file should be able
93
53
    to encode that.
94
54
 
95
55
    If showing the status of a working tree, extra information is included
96
56
    about unknown files, conflicts, and pending merges.
97
57
 
98
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
58
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
99
59
        files.
100
60
    :param specific_files: If set, a list of filenames whose status should be
101
 
        shown.  It is an error to give a filename that is not in the working 
 
61
        shown.  It is an error to give a filename that is not in the working
102
62
        tree, or in the working inventory or in the basis inventory.
103
63
    :param show_ids: If set, includes each file's id.
104
64
    :param to_file: If set, write to this file (default stdout.)
105
65
    :param show_pending: If set, write pending merges.
106
 
    :param revision: If None the compare latest revision with working tree
107
 
        If not None it must be a RevisionSpec list.
108
 
        If one revision show compared it with working tree.
109
 
        If two revisions show status between first and second.
 
66
    :param revision: If None, compare latest revision with working tree
 
67
        If not None, it must be a RevisionSpec list.
 
68
        If one revision, compare with working tree.
 
69
        If two revisions, show status between first and second.
110
70
    :param short: If True, gives short SVN-style status lines.
 
71
    :param verbose: If True, show all merged revisions, not just
 
72
        the merge tips
111
73
    :param versioned: If True, only shows versioned files.
112
74
    """
113
75
    if show_unchanged is not None:
114
 
        warn("show_status_trees with show_unchanged has been deprecated "
 
76
        warn("show_tree_status with show_unchanged has been deprecated "
115
77
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
116
78
 
117
79
    if to_file is None:
118
80
        to_file = sys.stdout
119
 
    
 
81
 
120
82
    wt.lock_read()
121
83
    try:
122
84
        new_is_working_tree = True
127
89
            old = new.basis_tree()
128
90
        elif len(revision) > 0:
129
91
            try:
130
 
                rev_id = revision[0].in_history(wt.branch).rev_id
131
 
                old = wt.branch.repository.revision_tree(rev_id)
 
92
                old = revision[0].as_tree(wt.branch)
132
93
            except errors.NoSuchRevision, e:
133
94
                raise errors.BzrCommandError(str(e))
134
95
            if (len(revision) > 1) and (revision[1].spec is not None):
135
96
                try:
136
 
                    rev_id = revision[1].in_history(wt.branch).rev_id
137
 
                    new = wt.branch.repository.revision_tree(rev_id)
 
97
                    new = revision[1].as_tree(wt.branch)
138
98
                    new_is_working_tree = False
139
99
                except errors.NoSuchRevision, e:
140
100
                    raise errors.BzrCommandError(str(e))
143
103
        old.lock_read()
144
104
        new.lock_read()
145
105
        try:
146
 
            _raise_if_nonexistent(specific_files, old, new)
 
106
            specific_files, nonexistents \
 
107
                = _filter_nonexistent(specific_files, old, new)
147
108
            want_unversioned = not versioned
148
109
            if short:
149
 
                changes = new._iter_changes(old, show_unchanged, specific_files,
 
110
                changes = new.iter_changes(old, show_unchanged, specific_files,
150
111
                    require_versioned=False, want_unversioned=want_unversioned)
151
112
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
152
113
                    unversioned_filter=new.is_ignored)
163
124
                           show_ids=show_ids,
164
125
                           show_unchanged=show_unchanged,
165
126
                           short_status=False)
166
 
            conflict_title = False
167
 
            # show the new conflicts only for now. XXX: get them from the delta.
168
 
            for conflict in new.conflicts():
169
 
                if not short and conflict_title is False:
170
 
                    print >> to_file, "conflicts:"
171
 
                    conflict_title = True
 
127
            # show the new conflicts only for now. XXX: get them from the
 
128
            # delta.
 
129
            conflicts = new.conflicts()
 
130
            if specific_files is not None:
 
131
                conflicts = conflicts.select_conflicts(new, specific_files,
 
132
                    ignore_misses=True, recurse=True)[1]
 
133
            if len(conflicts) > 0 and not short:
 
134
                to_file.write("conflicts:\n")
 
135
            for conflict in conflicts:
172
136
                if short:
173
137
                    prefix = 'C  '
174
138
                else:
175
139
                    prefix = ' '
176
 
                print >> to_file, "%s %s" % (prefix, conflict)
177
 
            if new_is_working_tree and show_pending:
178
 
                show_pending_merges(new, to_file, short)
 
140
                to_file.write("%s %s\n" % (prefix, conflict))
 
141
            # Show files that were requested but don't exist (and are
 
142
            # not versioned).  We don't involve delta in this; these
 
143
            # paths are really the province of just the status
 
144
            # command, since they have more to do with how it was
 
145
            # invoked than with the tree it's operating on.
 
146
            if nonexistents and not short:
 
147
                to_file.write("nonexistent:\n")
 
148
            for nonexistent in nonexistents:
 
149
                # We could calculate prefix outside the loop but, given
 
150
                # how rarely this ought to happen, it's OK and arguably
 
151
                # slightly faster to do it here (ala conflicts above)
 
152
                if short:
 
153
                    prefix = 'X  '
 
154
                else:
 
155
                    prefix = ' '
 
156
                to_file.write("%s %s\n" % (prefix, nonexistent))
 
157
            if (new_is_working_tree and show_pending):
 
158
                show_pending_merges(new, to_file, short, verbose=verbose)
179
159
        finally:
180
160
            old.unlock()
181
161
            new.unlock()
 
162
            if nonexistents:
 
163
              raise errors.PathsDoNotExist(nonexistents)
182
164
    finally:
183
165
        wt.unlock()
184
166
 
185
 
def show_pending_merges(new, to_file, short=False):
 
167
 
 
168
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
169
    """Get an iterator which will return the revisions in merge sorted order.
 
170
 
 
171
    This will build up a list of all nodes, such that only nodes in the list
 
172
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
173
    order.
 
174
 
 
175
    :param revision_ids: A set of revision_ids
 
176
    :param parent_map: The parent information for each node. Revisions which
 
177
        are considered ghosts should not be present in the map.
 
178
    :return: iterator from MergeSorter.iter_topo_order()
 
179
    """
 
180
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
181
    # of any references pointing outside of this graph.
 
182
    parent_graph = {}
 
183
    for revision_id in revision_ids:
 
184
        if revision_id not in parent_map: # ghost
 
185
            parent_graph[revision_id] = []
 
186
        else:
 
187
            # Only include parents which are in this sub-graph
 
188
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
189
                                            if p in revision_ids]
 
190
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
191
    return sorter.iter_topo_order()
 
192
 
 
193
 
 
194
def show_pending_merges(new, to_file, short=False, verbose=False):
186
195
    """Write out a display of pending merges in a working tree."""
187
196
    parents = new.get_parent_ids()
188
197
    if len(parents) < 2:
189
198
        return
 
199
 
 
200
    # we need one extra space for terminals that wrap on last char
 
201
    term_width = osutils.terminal_width() - 1
 
202
    if short:
 
203
        first_prefix = 'P   '
 
204
        sub_prefix = 'P.   '
 
205
    else:
 
206
        first_prefix = '  '
 
207
        sub_prefix = '    '
 
208
 
190
209
    pending = parents[1:]
191
210
    branch = new.branch
192
211
    last_revision = parents[0]
193
212
    if not short:
194
 
        print >>to_file, 'pending merges:'
195
 
    if last_revision is not None:
196
 
        try:
197
 
            ignore = set(branch.repository.get_ancestry(last_revision,
198
 
                                                        topo_sorted=False))
199
 
        except errors.NoSuchRevision:
200
 
            # the last revision is a ghost : assume everything is new 
201
 
            # except for it
202
 
            ignore = set([None, last_revision])
203
 
    else:
204
 
        ignore = set([None])
205
 
    # TODO: this could be improved using merge_sorted - we'd get the same 
206
 
    # output rather than one level of indent.
 
213
        if verbose:
 
214
            to_file.write('pending merges:\n')
 
215
        else:
 
216
            to_file.write('pending merge tips: (use -v to see all merge revisions)\n')
 
217
    graph = branch.repository.get_graph()
 
218
    other_revisions = [last_revision]
 
219
    log_formatter = log.LineLogFormatter(to_file)
207
220
    for merge in pending:
208
 
        ignore.add(merge)
209
 
        try:
210
 
            from bzrlib.osutils import terminal_width
211
 
            width = terminal_width()
212
 
            m_revision = branch.repository.get_revision(merge)
213
 
            if short:
214
 
                prefix = 'P  '
215
 
            else:
216
 
                prefix = ' '
217
 
            print >> to_file, prefix, line_log(m_revision, width - 4)
218
 
            inner_merges = branch.repository.get_ancestry(merge)
219
 
            assert inner_merges[0] is None
220
 
            inner_merges.pop(0)
221
 
            inner_merges.reverse()
222
 
            for mmerge in inner_merges:
223
 
                if mmerge in ignore:
224
 
                    continue
225
 
                mm_revision = branch.repository.get_revision(mmerge)
226
 
                if short:
227
 
                    prefix = 'P.  '
 
221
        try:
 
222
            rev = branch.repository.get_revisions([merge])[0]
 
223
        except errors.NoSuchRevision:
 
224
            # If we are missing a revision, just print out the revision id
 
225
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
226
            other_revisions.append(merge)
 
227
            continue
 
228
 
 
229
        # Log the merge, as it gets a slightly different formatting
 
230
        log_message = log_formatter.log_string(None, rev,
 
231
                        term_width - len(first_prefix))
 
232
        to_file.write(first_prefix + log_message + '\n')
 
233
        if not verbose:
 
234
            continue
 
235
 
 
236
        # Find all of the revisions in the merge source, which are not in the
 
237
        # last committed revision.
 
238
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
239
        other_revisions.append(merge)
 
240
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
241
 
 
242
        # Get a handle to all of the revisions we will need
 
243
        try:
 
244
            revisions = dict((rev.revision_id, rev) for rev in
 
245
                             branch.repository.get_revisions(merge_extra))
 
246
        except errors.NoSuchRevision:
 
247
            # One of the sub nodes is a ghost, check each one
 
248
            revisions = {}
 
249
            for revision_id in merge_extra:
 
250
                try:
 
251
                    rev = branch.repository.get_revisions([revision_id])[0]
 
252
                except errors.NoSuchRevision:
 
253
                    revisions[revision_id] = None
228
254
                else:
229
 
                    prefix = '   '
230
 
                print >> to_file, prefix, line_log(mm_revision, width - 5)
231
 
                ignore.add(mmerge)
232
 
        except errors.NoSuchRevision:
233
 
            if short:
234
 
                prefix = 'P  '
235
 
            else:
236
 
                prefix = ' '
237
 
            print >> to_file, prefix, merge
 
255
                    revisions[revision_id] = rev
 
256
 
 
257
        # Display the revisions brought in by this merge.
 
258
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
259
                            branch.repository.get_parent_map(merge_extra))
 
260
        # Skip the first node
 
261
        num, first, depth, eom = rev_id_iterator.next()
 
262
        if first != merge:
 
263
            raise AssertionError('Somehow we misunderstood how'
 
264
                ' iter_topo_order works %s != %s' % (first, merge))
 
265
        for num, sub_merge, depth, eom in rev_id_iterator:
 
266
            rev = revisions[sub_merge]
 
267
            if rev is None:
 
268
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
269
                continue
 
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')
 
274
 
 
275
 
 
276
def _filter_nonexistent(orig_paths, old_tree, new_tree):
 
277
    """Convert orig_paths to two sorted lists and return them.
 
278
 
 
279
    The first is orig_paths paths minus the items in the second list,
 
280
    and the second list is paths that are not in either inventory or
 
281
    tree (they don't qualify if they exist in the tree's inventory, or
 
282
    if they exist in the tree but are not versioned.)
 
283
 
 
284
    If either of the two lists is empty, return it as an empty list.
 
285
 
 
286
    This can be used by operations such as bzr status that can accept
 
287
    unknown or ignored files.
 
288
    """
 
289
    mutter("check paths: %r", orig_paths)
 
290
    if not orig_paths:
 
291
        return orig_paths, []
 
292
    s = old_tree.filter_unversioned_files(orig_paths)
 
293
    s = new_tree.filter_unversioned_files(s)
 
294
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
 
295
    remaining   = [path for path in orig_paths if not path in nonexistent]
 
296
    # Sorting the 'remaining' list doesn't have much effect in
 
297
    # practice, since the various status output sections will sort
 
298
    # their groups individually.  But for consistency of this
 
299
    # function's API, it's better to sort both than just 'nonexistent'.
 
300
    return sorted(remaining), sorted(nonexistent)