← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

Add source index to the index iteration API to allow mapping back to the origin of retrieved data.

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,
 
17
import sys
 
18
 
 
19
from bzrlib import (
 
20
    delta as _mod_delta,
 
21
    tree,
 
22
    )
 
23
from bzrlib.diff import _raise_if_nonexistent
 
24
import bzrlib.errors as errors
 
25
from bzrlib.log import line_log
 
26
from bzrlib.osutils import is_inside_any
 
27
from bzrlib.symbol_versioning import (deprecated_function,
 
28
        zero_eight,
 
29
        )
 
30
from bzrlib.trace import warning
 
31
 
 
32
# TODO: when showing single-line logs, truncate to the width of the terminal
 
33
# if known, but only if really going to the terminal (not into a file)
 
34
 
 
35
 
 
36
@deprecated_function(zero_eight)
 
37
def show_status(branch, show_unchanged=None,
20
38
                specific_files=None,
21
39
                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.
 
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.
27
56
 
28
57
    specific_files
29
58
        If set, only show the status of files in this list.
30
59
 
 
60
    show_ids
 
61
        If set, includes each file's id.
 
62
 
31
63
    to_file
32
64
        If set, write to this file (default stdout.)
33
 
    """
34
 
    import sys
35
 
    from bzrlib.diff import compare_trees
36
 
 
37
 
    if to_file == None:
 
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
def show_tree_status(wt, show_unchanged=None,
 
79
                     specific_files=None,
 
80
                     show_ids=False,
 
81
                     to_file=None,
 
82
                     show_pending=True,
 
83
                     revision=None,
 
84
                     short=False,
 
85
                     versioned=False):
 
86
    """Display summary of changes.
 
87
 
 
88
    By default this compares the working tree to a previous revision. 
 
89
    If the revision argument is given, summarizes changes between the 
 
90
    working tree and another, or between two revisions.
 
91
 
 
92
    The result is written out as Unicode and to_file should be able 
 
93
    to encode that.
 
94
 
 
95
    If showing the status of a working tree, extra information is included
 
96
    about unknown files, conflicts, and pending merges.
 
97
 
 
98
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
99
        files.
 
100
    :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 
 
102
        tree, or in the working inventory or in the basis inventory.
 
103
    :param show_ids: If set, includes each file's id.
 
104
    :param to_file: If set, write to this file (default stdout.)
 
105
    :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.
 
110
    :param short: If True, gives short SVN-style status lines.
 
111
    :param versioned: If True, only shows versioned files.
 
112
    """
 
113
    if show_unchanged is not None:
 
114
        warn("show_status_trees with show_unchanged has been deprecated "
 
115
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
 
116
 
 
117
    if to_file is None:
38
118
        to_file = sys.stdout
39
119
    
40
 
    branch.lock_read()
 
120
    wt.lock_read()
41
121
    try:
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:
 
122
        new_is_working_tree = True
 
123
        if revision is None:
 
124
            if wt.last_revision() != wt.branch.last_revision():
 
125
                warning("working tree is out of date, run 'bzr update'")
 
126
            new = wt
 
127
            old = new.basis_tree()
 
128
        elif len(revision) > 0:
 
129
            try:
 
130
                rev_id = revision[0].in_history(wt.branch).rev_id
 
131
                old = wt.branch.repository.revision_tree(rev_id)
 
132
            except errors.NoSuchRevision, e:
 
133
                raise errors.BzrCommandError(str(e))
 
134
            if (len(revision) > 1) and (revision[1].spec is not None):
 
135
                try:
 
136
                    rev_id = revision[1].in_history(wt.branch).rev_id
 
137
                    new = wt.branch.repository.revision_tree(rev_id)
 
138
                    new_is_working_tree = False
 
139
                except errors.NoSuchRevision, e:
 
140
                    raise errors.BzrCommandError(str(e))
 
141
            else:
 
142
                new = wt
 
143
        old.lock_read()
 
144
        new.lock_read()
 
145
        try:
 
146
            _raise_if_nonexistent(specific_files, old, new)
 
147
            want_unversioned = not versioned
 
148
            if short:
 
149
                changes = new._iter_changes(old, show_unchanged, specific_files,
 
150
                    require_versioned=False, want_unversioned=want_unversioned)
 
151
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
152
                    unversioned_filter=new.is_ignored)
 
153
                _mod_delta.report_changes(changes, reporter)
 
154
            else:
 
155
                delta = new.changes_from(old, want_unchanged=show_unchanged,
 
156
                                      specific_files=specific_files,
 
157
                                      want_unversioned=want_unversioned)
 
158
                # filter out unknown files. We may want a tree method for
 
159
                # this
 
160
                delta.unversioned = [unversioned for unversioned in
 
161
                    delta.unversioned if not new.is_ignored(unversioned[0])]
 
162
                delta.show(to_file,
 
163
                           show_ids=show_ids,
 
164
                           show_unchanged=show_unchanged,
 
165
                           short_status=False)
 
166
            # show the new conflicts only for now. XXX: get them from the
 
167
            # delta.
 
168
            conflicts = new.conflicts()
 
169
            if specific_files is not None:
 
170
                conflicts = conflicts.select_conflicts(new, specific_files,
 
171
                    ignore_misses=True, recurse=True)[1]
 
172
            if len(conflicts) > 0 and not short:
 
173
                print >> to_file, "conflicts:"
 
174
            for conflict in conflicts:
 
175
                if short:
 
176
                    prefix = 'C  '
 
177
                else:
 
178
                    prefix = ' '
 
179
                print >> to_file, "%s %s" % (prefix, conflict)
 
180
            if new_is_working_tree and show_pending:
 
181
                show_pending_merges(new, to_file, short)
 
182
        finally:
 
183
            old.unlock()
 
184
            new.unlock()
 
185
    finally:
 
186
        wt.unlock()
 
187
 
 
188
def show_pending_merges(new, to_file, short=False):
 
189
    """Write out a display of pending merges in a working tree."""
 
190
    parents = new.get_parent_ids()
 
191
    if len(parents) < 2:
 
192
        return
 
193
    pending = parents[1:]
 
194
    branch = new.branch
 
195
    last_revision = parents[0]
 
196
    if not short:
 
197
        print >>to_file, 'pending merges:'
 
198
    if last_revision is not None:
 
199
        try:
 
200
            ignore = set(branch.repository.get_ancestry(last_revision,
 
201
                                                        topo_sorted=False))
 
202
        except errors.NoSuchRevision:
 
203
            # the last revision is a ghost : assume everything is new 
 
204
            # except for it
 
205
            ignore = set([None, last_revision])
 
206
    else:
 
207
        ignore = set([None])
 
208
    # TODO: this could be improved using merge_sorted - we'd get the same 
 
209
    # output rather than one level of indent.
 
210
    for merge in pending:
 
211
        ignore.add(merge)
 
212
        try:
 
213
            from bzrlib.osutils import terminal_width
 
214
            width = terminal_width()
 
215
            m_revision = branch.repository.get_revision(merge)
 
216
            if short:
 
217
                prefix = 'P  '
 
218
            else:
 
219
                prefix = ' '
 
220
            print >> to_file, prefix, line_log(m_revision, width - 4)
 
221
            inner_merges = branch.repository.get_ancestry(merge)
 
222
            assert inner_merges[0] is None
 
223
            inner_merges.pop(0)
 
224
            inner_merges.reverse()
 
225
            for mmerge in inner_merges:
 
226
                if mmerge in ignore:
60
227
                    continue
61
 
            if not done_header:
62
 
                print >>to_file, 'unknown:'
63
 
                done_header = True
64
 
            print >>to_file, ' ', path
65
 
    finally:
66
 
        branch.unlock()
67
 
        
 
228
                mm_revision = branch.repository.get_revision(mmerge)
 
229
                if short:
 
230
                    prefix = 'P.  '
 
231
                else:
 
232
                    prefix = '   '
 
233
                print >> to_file, prefix, line_log(mm_revision, width - 5)
 
234
                ignore.add(mmerge)
 
235
        except errors.NoSuchRevision:
 
236
            if short:
 
237
                prefix = 'P  '
 
238
            else:
 
239
                prefix = ' '
 
240
            print >> to_file, prefix, merge