~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-21 22:29:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 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.diff import _raise_if_nonexistent
20
 
import bzrlib.errors as errors
21
 
from bzrlib.log import line_log
22
 
from bzrlib.osutils import is_inside_any
23
 
from bzrlib.symbol_versioning import (deprecated_function,
24
 
        zero_eight,
25
 
        )
26
 
 
27
 
# TODO: when showing single-line logs, truncate to the width of the terminal
28
 
# if known, but only if really going to the terminal (not into a file)
29
 
 
30
 
 
31
 
@deprecated_function(zero_eight)
32
 
def show_status(branch, show_unchanged=None,
33
 
                specific_files=None,
34
 
                show_ids=False,
35
 
                to_file=None,
36
 
                show_pending=True,
37
 
                revision=None):
38
 
    """Display summary of changes.
39
 
 
40
 
    Please use show_tree_status instead.
41
 
 
42
 
    By default this compares the working tree to a previous revision. 
43
 
    If the revision argument is given, summarizes changes between the 
44
 
    working tree and another, or between two revisions.
45
 
 
46
 
    The result is written out as Unicode and to_file should be able 
47
 
    to encode that.
48
 
 
49
 
    show_unchanged
50
 
        If set, includes unchanged files.
51
 
 
52
 
    specific_files
53
 
        If set, only show the status of files in this list.
54
 
 
55
 
    show_ids
56
 
        If set, includes each file's id.
57
 
 
58
 
    to_file
59
 
        If set, write to this file (default stdout.)
60
 
 
61
 
    show_pending
62
 
        If set, write pending merges.
63
 
 
64
 
    revision
65
 
        If None the compare latest revision with working tree
66
 
        If one revision show compared it with working tree.
67
 
        If two revisions show status between first and second.
68
 
    """
69
 
    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 
70
 
                     specific_files, show_ids, to_file, show_pending, revision)
71
 
 
72
 
 
73
 
def show_tree_status(wt, show_unchanged=None,
74
 
                     specific_files=None,
75
 
                     show_ids=False,
76
 
                     to_file=None,
77
 
                     show_pending=True,
78
 
                     revision=None):
79
 
    """Display summary of changes.
80
 
 
81
 
    By default this compares the working tree to a previous revision. 
82
 
    If the revision argument is given, summarizes changes between the 
83
 
    working tree and another, or between two revisions.
84
 
 
85
 
    The result is written out as Unicode and to_file should be able 
86
 
    to encode that.
87
 
 
88
 
    If showing the status of a working tree, extra information is included
89
 
    about unknown files, conflicts, and pending merges.
90
 
 
91
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
92
 
        files.
93
 
    :param specific_files: If set, a list of filenames whose status should be
94
 
        shown.  It is an error to give a filename that is not in the working 
95
 
        tree, or in the working inventory or in the basis inventory.
96
 
    :param show_ids: If set, includes each file's id.
97
 
    :param to_file: If set, write to this file (default stdout.)
98
 
    :param show_pending: If set, write pending merges.
99
 
    :param revision: If None the compare latest revision with working tree
100
 
        If not None it must be a RevisionSpec list.
101
 
        If one revision show compared it with working tree.
102
 
        If two revisions show status between first and second.
103
 
    """
104
 
    if show_unchanged is not None:
105
 
        warn("show_status_trees with show_unchanged has been deprecated "
106
 
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
107
 
 
108
 
    if to_file is None:
109
 
        to_file = sys.stdout
110
 
    
111
 
    wt.lock_read()
112
 
    try:
113
 
        new_is_working_tree = True
114
 
        if revision is None:
115
 
            new = wt
116
 
            old = new.basis_tree()
117
 
        elif len(revision) > 0:
118
 
            try:
119
 
                rev_id = revision[0].in_history(wt.branch).rev_id
120
 
                old = wt.branch.repository.revision_tree(rev_id)
121
 
            except errors.NoSuchRevision, e:
122
 
                raise errors.BzrCommandError(str(e))
123
 
            if (len(revision) > 1) and (revision[1].spec is not None):
124
 
                try:
125
 
                    rev_id = revision[1].in_history(wt.branch).rev_id
126
 
                    new = wt.branch.repository.revision_tree(rev_id)
127
 
                    new_is_working_tree = False
128
 
                except errors.NoSuchRevision, e:
129
 
                    raise errors.BzrCommandError(str(e))
130
 
            else:
131
 
                new = wt
132
 
        _raise_if_nonexistent(specific_files, old, new)
133
 
        delta = new.changes_from(old, want_unchanged=show_unchanged,
134
 
                              specific_files=specific_files)
135
 
        delta.show(to_file,
136
 
                   show_ids=show_ids,
137
 
                   show_unchanged=show_unchanged)
138
 
 
139
 
        list_paths('unknown', new.unknowns(), specific_files, to_file)
140
 
        conflict_title = False
141
 
        # show the new conflicts only for now. XXX: get them from the delta.
142
 
        for conflict in new.conflicts():
143
 
            if conflict_title is False:
144
 
                print >> to_file, "conflicts:"
145
 
                conflict_title = True
146
 
            print >> to_file, "  %s" % conflict
147
 
        if new_is_working_tree and show_pending:
148
 
            show_pending_merges(new, to_file)
149
 
    finally:
150
 
        wt.unlock()
151
 
 
152
 
def show_pending_merges(new, to_file):
153
 
    """Write out a display of pending merges in a working tree."""
154
 
    parents = new.get_parent_ids()
155
 
    if len(parents) < 2:
156
 
        return
157
 
    pending = parents[1:]
158
 
    branch = new.branch
159
 
    last_revision = parents[0]
160
 
    print >>to_file, 'pending merges:'
161
 
    if last_revision is not None:
162
 
        try:
163
 
            ignore = set(branch.repository.get_ancestry(last_revision))
164
 
        except errors.NoSuchRevision:
165
 
            # the last revision is a ghost : assume everything is new 
166
 
            # except for it
167
 
            ignore = set([None, last_revision])
168
 
    else:
169
 
        ignore = set([None])
170
 
    # TODO: this could be improved using merge_sorted - we'd get the same 
171
 
    # output rather than one level of indent.
172
 
    for merge in pending:
173
 
        ignore.add(merge)
174
 
        try:
175
 
            from bzrlib.osutils import terminal_width
176
 
            width = terminal_width()
177
 
            m_revision = branch.repository.get_revision(merge)
178
 
            print >> to_file, ' ', line_log(m_revision, width - 3)
179
 
            inner_merges = branch.repository.get_ancestry(merge)
180
 
            assert inner_merges[0] is None
181
 
            inner_merges.pop(0)
182
 
            inner_merges.reverse()
183
 
            for mmerge in inner_merges:
184
 
                if mmerge in ignore:
185
 
                    continue
186
 
                mm_revision = branch.repository.get_revision(mmerge)
187
 
                print >> to_file, '   ', line_log(mm_revision, width - 5)
188
 
                ignore.add(mmerge)
189
 
        except errors.NoSuchRevision:
190
 
            print >> to_file, ' ', merge
191
 
        
192
 
def list_paths(header, paths, specific_files, to_file):
193
 
    done_header = False
194
 
    for path in paths:
195
 
        if specific_files and not is_inside_any(specific_files, path):
196
 
            continue
197
 
        if not done_header:
198
 
            print >>to_file, '%s:' % header
199
 
            done_header = True
200
 
        print >>to_file, ' ', path