/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: Martin Pool
  • Date: 2009-01-23 22:39:31 UTC
  • mto: This revision was merged to the branch mainline in revision 3959.
  • Revision ID: mbp@sourcefrog.net-20090123223931-kb1la553lxibnbpd
Rephrase api docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/status.py
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
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.
 
74
    """
 
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)
 
78
 
 
79
    if to_file is None:
 
80
        to_file = sys.stdout
 
81
    
 
82
    wt.lock_read()
 
83
    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
            _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
                show_pending_merges(new, to_file, short, verbose=verbose)
 
142
        finally:
 
143
            old.unlock()
 
144
            new.unlock()
 
145
    finally:
 
146
        wt.unlock()
 
147
 
 
148
 
 
149
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
150
    """Get an iterator which will return the revisions in merge sorted order.
 
151
 
 
152
    This will build up a list of all nodes, such that only nodes in the list
 
153
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
154
    order.
 
155
 
 
156
    :param revision_ids: A set of revision_ids
 
157
    :param parent_map: The parent information for each node. Revisions which
 
158
        are considered ghosts should not be present in the map.
 
159
    :return: iterator from MergeSorter.iter_topo_order()
 
160
    """
 
161
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
162
    # of any references pointing outside of this graph.
 
163
    parent_graph = {}
 
164
    for revision_id in revision_ids:
 
165
        if revision_id not in parent_map: # ghost
 
166
            parent_graph[revision_id] = []
 
167
        else:
 
168
            # Only include parents which are in this sub-graph
 
169
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
170
                                            if p in revision_ids]
 
171
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
172
    return sorter.iter_topo_order()
 
173
 
 
174
 
 
175
def show_pending_merges(new, to_file, short=False, verbose=False):
 
176
    """Write out a display of pending merges in a working tree."""
 
177
    parents = new.get_parent_ids()
 
178
    if len(parents) < 2:
 
179
        return
 
180
 
 
181
    # we need one extra space for terminals that wrap on last char
 
182
    term_width = osutils.terminal_width() - 1
 
183
    if short:
 
184
        first_prefix = 'P   '
 
185
        sub_prefix = 'P.   '
 
186
    else:
 
187
        first_prefix = '  '
 
188
        sub_prefix = '    '
 
189
 
 
190
    pending = parents[1:]
 
191
    branch = new.branch
 
192
    last_revision = parents[0]
 
193
    if not short:
 
194
        if verbose:
 
195
            to_file.write('pending merges:\n')
 
196
        else:
 
197
            to_file.write('pending merge tips: (use -v to see all merge revisions)\n')
 
198
    graph = branch.repository.get_graph()
 
199
    other_revisions = [last_revision]
 
200
    log_formatter = log.LineLogFormatter(to_file)
 
201
    for merge in pending:
 
202
        try:
 
203
            rev = branch.repository.get_revisions([merge])[0]
 
204
        except errors.NoSuchRevision:
 
205
            # If we are missing a revision, just print out the revision id
 
206
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
207
            other_revisions.append(merge)
 
208
            continue
 
209
 
 
210
        # Log the merge, as it gets a slightly different formatting
 
211
        log_message = log_formatter.log_string(None, rev,
 
212
                        term_width - len(first_prefix))
 
213
        to_file.write(first_prefix + log_message + '\n')
 
214
        if not verbose:
 
215
            continue
 
216
 
 
217
        # Find all of the revisions in the merge source, which are not in the
 
218
        # last committed revision.
 
219
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
220
        other_revisions.append(merge)
 
221
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
222
 
 
223
        # Get a handle to all of the revisions we will need
 
224
        try:
 
225
            revisions = dict((rev.revision_id, rev) for rev in
 
226
                             branch.repository.get_revisions(merge_extra))
 
227
        except errors.NoSuchRevision:
 
228
            # One of the sub nodes is a ghost, check each one
 
229
            revisions = {}
 
230
            for revision_id in merge_extra:
 
231
                try:
 
232
                    rev = branch.repository.get_revisions([revision_id])[0]
 
233
                except errors.NoSuchRevision:
 
234
                    revisions[revision_id] = None
 
235
                else:
 
236
                    revisions[revision_id] = rev
 
237
 
 
238
        # Display the revisions brought in by this merge.
 
239
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
240
                            branch.repository.get_parent_map(merge_extra))
 
241
        # Skip the first node
 
242
        num, first, depth, eom = rev_id_iterator.next()
 
243
        if first != merge:
 
244
            raise AssertionError('Somehow we misunderstood how'
 
245
                ' iter_topo_order works %s != %s' % (first, merge))
 
246
        for num, sub_merge, depth, eom in rev_id_iterator:
 
247
            rev = revisions[sub_merge]
 
248
            if rev is None:
 
249
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
250
                continue
 
251
            log_message = log_formatter.log_string(None,
 
252
                            revisions[sub_merge],
 
253
                            term_width - len(sub_prefix))
 
254
            to_file.write(sub_prefix + log_message + '\n')
 
255
 
 
256
 
 
257
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
258
    """Complain if paths are not in either inventory or tree.
 
259
 
 
260
    It's OK with the files exist in either tree's inventory, or 
 
261
    if they exist in the tree but are not versioned.
 
262
    
 
263
    This can be used by operations such as bzr status that can accept
 
264
    unknown or ignored files.
 
265
    """
 
266
    mutter("check paths: %r", paths)
 
267
    if not paths:
 
268
        return
 
269
    s = old_tree.filter_unversioned_files(paths)
 
270
    s = new_tree.filter_unversioned_files(s)
 
271
    s = [path for path in s if not new_tree.has_filename(path)]
 
272
    if s:
 
273
        raise errors.PathsDoNotExist(sorted(s))
 
274
 
 
275