← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Martin Pool
  • Date: 2008-06-05 03:27:37 UTC
  • mto: This revision was merged to the branch mainline in revision 3491.
  • Revision ID: mbp@sourcefrog.net-20080605032737-0eytu5y1k9k5a72t
Add plugin and integration guides to doc indexes

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/status.py
1
 
# (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
 
18
 
 
19
 
def show_status(branch, show_unchanged=False,
20
 
                specific_files=None,
21
 
                show_ids=False,
22
 
                to_file=None,
23
 
                show_pending=True):
24
 
    """Display single-line status for non-ignored working files.
25
 
 
26
 
    show_all
27
 
        If true, show unmodified files too.
28
 
 
29
 
    specific_files
30
 
        If set, only show the status of files in this list.
31
 
 
32
 
    to_file
33
 
        If set, write to this file (default stdout.)
 
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
from bzrlib.diff import _raise_if_nonexistent
 
28
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
 
33
 
 
34
# TODO: when showing single-line logs, truncate to the width of the terminal
 
35
# if known, but only if really going to the terminal (not into a file)
 
36
 
 
37
 
 
38
def show_tree_status(wt, show_unchanged=None,
 
39
                     specific_files=None,
 
40
                     show_ids=False,
 
41
                     to_file=None,
 
42
                     show_pending=True,
 
43
                     revision=None,
 
44
                     short=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 versioned: If True, only shows versioned files.
34
72
    """
35
 
    import sys
36
 
    from bzrlib.delta import compare_trees
 
73
    if show_unchanged is not None:
 
74
        warn("show_tree_status with show_unchanged has been deprecated "
 
75
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
37
76
 
38
 
    if to_file == None:
 
77
    if to_file is None:
39
78
        to_file = sys.stdout
40
79
    
41
 
    branch.lock_read()
 
80
    wt.lock_read()
42
81
    try:
43
 
 
44
 
        old = branch.basis_tree()
45
 
        new = branch.working_tree()
46
 
 
47
 
        delta = compare_trees(old, new, want_unchanged=show_unchanged,
48
 
                              specific_files=specific_files)
49
 
 
50
 
        delta.show(to_file,
51
 
                   show_ids=show_ids,
52
 
                   show_unchanged=show_unchanged)
53
 
 
54
 
        unknowns = new.unknowns()
55
 
        done_header = False
56
 
        for path in unknowns:
57
 
            # FIXME: Should also match if the unknown file is within a
58
 
            # specified directory.
59
 
            if specific_files:
60
 
                if path not in specific_files:
61
 
                    continue
62
 
            if not done_header:
63
 
                print >>to_file, 'unknown:'
64
 
                done_header = True
65
 
            print >>to_file, ' ', path
66
 
        if show_pending and len(branch.pending_merges()) > 0:
67
 
            print >>to_file, 'pending merges:'
68
 
            for merge in branch.pending_merges():
69
 
                print >> to_file, ' ', merge
 
82
        new_is_working_tree = True
 
83
        if revision is None:
 
84
            if wt.last_revision() != wt.branch.last_revision():
 
85
                warning("working tree is out of date, run 'bzr update'")
 
86
            new = wt
 
87
            old = new.basis_tree()
 
88
        elif len(revision) > 0:
 
89
            try:
 
90
                rev_id = revision[0].as_revision_id(wt.branch)
 
91
                old = wt.branch.repository.revision_tree(rev_id)
 
92
            except errors.NoSuchRevision, e:
 
93
                raise errors.BzrCommandError(str(e))
 
94
            if (len(revision) > 1) and (revision[1].spec is not None):
 
95
                try:
 
96
                    rev_id = revision[1].as_revision_id(wt.branch)
 
97
                    new = wt.branch.repository.revision_tree(rev_id)
 
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
            _raise_if_nonexistent(specific_files, old, new)
 
107
            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)
 
126
            # show the new conflicts only for now. XXX: get them from the
 
127
            # delta.
 
128
            conflicts = new.conflicts()
 
129
            if specific_files is not None:
 
130
                conflicts = conflicts.select_conflicts(new, specific_files,
 
131
                    ignore_misses=True, recurse=True)[1]
 
132
            if len(conflicts) > 0 and not short:
 
133
                to_file.write("conflicts:\n")
 
134
            for conflict in conflicts:
 
135
                if short:
 
136
                    prefix = 'C  '
 
137
                else:
 
138
                    prefix = ' '
 
139
                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)
 
143
        finally:
 
144
            old.unlock()
 
145
            new.unlock()
70
146
    finally:
71
 
        branch.unlock()
72
 
        
 
147
        wt.unlock()
 
148
 
 
149
 
 
150
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
151
    """Get an iterator which will return the revisions in merge sorted order.
 
152
 
 
153
    This will build up a list of all nodes, such that only nodes in the list
 
154
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
155
    order.
 
156
 
 
157
    :param revision_ids: A set of revision_ids
 
158
    :param parent_map: The parent information for each node. Revisions which
 
159
        are considered ghosts should not be present in the map.
 
160
    :return: iterator from MergeSorter.iter_topo_order()
 
161
    """
 
162
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
163
    # of any references pointing outside of this graph.
 
164
    parent_graph = {}
 
165
    for revision_id in revision_ids:
 
166
        if revision_id not in parent_map: # ghost
 
167
            parent_graph[revision_id] = []
 
168
        else:
 
169
            # Only include parents which are in this sub-graph
 
170
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
171
                                            if p in revision_ids]
 
172
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
173
    return sorter.iter_topo_order()
 
174
 
 
175
 
 
176
def show_pending_merges(new, to_file, short=False):
 
177
    """Write out a display of pending merges in a working tree."""
 
178
    parents = new.get_parent_ids()
 
179
    if len(parents) < 2:
 
180
        return
 
181
 
 
182
    # we need one extra space for terminals that wrap on last char
 
183
    term_width = osutils.terminal_width() - 1
 
184
    if short:
 
185
        first_prefix = 'P   '
 
186
        sub_prefix = 'P.   '
 
187
    else:
 
188
        first_prefix = '  '
 
189
        sub_prefix = '    '
 
190
 
 
191
    pending = parents[1:]
 
192
    branch = new.branch
 
193
    last_revision = parents[0]
 
194
    if not short:
 
195
        to_file.write('pending merges:\n')
 
196
    graph = branch.repository.get_graph()
 
197
    other_revisions = [last_revision]
 
198
    log_formatter = log.LineLogFormatter(to_file)
 
199
    for merge in pending:
 
200
        try:
 
201
            rev = branch.repository.get_revisions([merge])[0]
 
202
        except errors.NoSuchRevision:
 
203
            # If we are missing a revision, just print out the revision id
 
204
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
205
            other_revisions.append(merge)
 
206
            continue
 
207
 
 
208
        # 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')
 
212
        # Find all of the revisions in the merge source, which are not in the
 
213
        # last committed revision.
 
214
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
215
        other_revisions.append(merge)
 
216
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
217
 
 
218
        # Get a handle to all of the revisions we will need
 
219
        try:
 
220
            revisions = dict((rev.revision_id, rev) for rev in
 
221
                             branch.repository.get_revisions(merge_extra))
 
222
        except errors.NoSuchRevision:
 
223
            # One of the sub nodes is a ghost, check each one
 
224
            revisions = {}
 
225
            for revision_id in merge_extra:
 
226
                try:
 
227
                    rev = branch.repository.get_revisions([revision_id])[0]
 
228
                except errors.NoSuchRevision:
 
229
                    revisions[revision_id] = None
 
230
                else:
 
231
                    revisions[revision_id] = rev
 
232
 
 
233
        # Display the revisions brought in by this merge.
 
234
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
235
                            branch.repository.get_parent_map(merge_extra))
 
236
        # Skip the first node
 
237
        num, first, depth, eom = rev_id_iterator.next()
 
238
        if first != merge:
 
239
            raise AssertionError('Somehow we misunderstood how'
 
240
                ' iter_topo_order works %s != %s' % (first, merge))
 
241
        for num, sub_merge, depth, eom in rev_id_iterator:
 
242
            rev = revisions[sub_merge]
 
243
            if rev is None:
 
244
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
245
                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')