~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Robert Collins
  • Date: 2005-08-23 06:52:09 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050823065209-81cd5962c401751b
move io redirection into each test case from the global runner

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
16
 
 
17
 
import sys
18
 
 
19
 
from bzrlib import (
20
 
    delta as _mod_delta,
21
 
    log,
22
 
    osutils,
23
 
    tree,
24
 
    tsort,
25
 
    revision as _mod_revision,
26
 
    )
27
 
import bzrlib.errors as errors
28
 
from bzrlib.osutils import is_inside_any
29
 
from bzrlib.symbol_versioning import (deprecated_function,
30
 
        )
31
 
from bzrlib.trace import mutter, warning
32
 
 
33
 
# TODO: when showing single-line logs, truncate to the width of the terminal
34
 
# if known, but only if really going to the terminal (not into a file)
35
 
 
36
 
 
37
 
def show_tree_status(wt, show_unchanged=None,
38
 
                     specific_files=None,
39
 
                     show_ids=False,
40
 
                     to_file=None,
41
 
                     show_pending=True,
42
 
                     revision=None,
43
 
                     short=False,
44
 
                     verbose=False,
45
 
                     versioned=False):
46
 
    """Display summary of changes.
47
 
 
48
 
    By default this compares the working tree to a previous revision.
49
 
    If the revision argument is given, summarizes changes between the
50
 
    working tree and another, or between two revisions.
51
 
 
52
 
    The result is written out as Unicode and to_file should be able
53
 
    to encode that.
54
 
 
55
 
    If showing the status of a working tree, extra information is included
56
 
    about unknown files, conflicts, and pending merges.
57
 
 
58
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
59
 
        files.
60
 
    :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
62
 
        tree, or in the working inventory or in the basis inventory.
63
 
    :param show_ids: If set, includes each file's id.
64
 
    :param to_file: If set, write to this file (default stdout.)
65
 
    :param show_pending: If set, write pending merges.
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.
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
73
 
    :param versioned: If True, only shows versioned files.
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
 
 
19
def show_status(branch, show_unchanged=False,
 
20
                specific_files=None,
 
21
                show_ids=False,
 
22
                to_file=None):
 
23
    """Display single-line status for non-ignored working files.
 
24
 
 
25
    show_all
 
26
        If true, show unmodified files too.
 
27
 
 
28
    specific_files
 
29
        If set, only show the status of files in this list.
 
30
 
 
31
    to_file
 
32
        If set, write to this file (default stdout.)
74
33
    """
75
 
    if show_unchanged is not None:
76
 
        warn("show_tree_status with show_unchanged has been deprecated "
77
 
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
 
34
    import sys
 
35
    from bzrlib.delta import compare_trees
78
36
 
79
 
    if to_file is None:
 
37
    if to_file == None:
80
38
        to_file = sys.stdout
81
 
 
82
 
    wt.lock_read()
 
39
    
 
40
    branch.lock_read()
83
41
    try:
84
 
        new_is_working_tree = True
85
 
        if revision is None:
86
 
            if wt.last_revision() != wt.branch.last_revision():
87
 
                warning("working tree is out of date, run 'bzr update'")
88
 
            new = wt
89
 
            old = new.basis_tree()
90
 
        elif len(revision) > 0:
91
 
            try:
92
 
                old = revision[0].as_tree(wt.branch)
93
 
            except errors.NoSuchRevision, e:
94
 
                raise errors.BzrCommandError(str(e))
95
 
            if (len(revision) > 1) and (revision[1].spec is not None):
96
 
                try:
97
 
                    new = revision[1].as_tree(wt.branch)
98
 
                    new_is_working_tree = False
99
 
                except errors.NoSuchRevision, e:
100
 
                    raise errors.BzrCommandError(str(e))
101
 
            else:
102
 
                new = wt
103
 
        old.lock_read()
104
 
        new.lock_read()
105
 
        try:
106
 
            specific_files, nonexistents \
107
 
                = _filter_nonexistent(specific_files, old, new)
108
 
            want_unversioned = not versioned
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)
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:
136
 
                if short:
137
 
                    prefix = 'C  '
138
 
                else:
139
 
                    prefix = ' '
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)
159
 
        finally:
160
 
            old.unlock()
161
 
            new.unlock()
162
 
            if nonexistents:
163
 
              raise errors.PathsDoNotExist(nonexistents)
 
42
 
 
43
        old = branch.basis_tree()
 
44
        new = branch.working_tree()
 
45
 
 
46
        delta = compare_trees(old, new, want_unchanged=show_unchanged,
 
47
                              specific_files=specific_files)
 
48
 
 
49
        delta.show(to_file,
 
50
                   show_ids=show_ids,
 
51
                   show_unchanged=show_unchanged)
 
52
 
 
53
        unknowns = new.unknowns()
 
54
        done_header = False
 
55
        for path in unknowns:
 
56
            # FIXME: Should also match if the unknown file is within a
 
57
            # specified directory.
 
58
            if specific_files:
 
59
                if path not in specific_files:
 
60
                    continue
 
61
            if not done_header:
 
62
                print >>to_file, 'unknown:'
 
63
                done_header = True
 
64
            print >>to_file, ' ', path
164
65
    finally:
165
 
        wt.unlock()
166
 
 
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):
195
 
    """Write out a display of pending merges in a working tree."""
196
 
    parents = new.get_parent_ids()
197
 
    if len(parents) < 2:
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
 
 
209
 
    pending = parents[1:]
210
 
    branch = new.branch
211
 
    last_revision = parents[0]
212
 
    if not short:
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)
220
 
    for merge in pending:
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
254
 
                else:
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)
 
66
        branch.unlock()
 
67