1
# (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
def show_status(branch, show_unchanged=False,
23
"""Display single-line status for non-ignored working files.
26
If true, show unmodified files too.
29
If set, only show the status of files in this list.
32
If set, write to this file (default stdout.)
35
from bzrlib.diff import compare_trees
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25
revision as _mod_revision,
27
import bzrlib.errors as errors
28
from bzrlib.trace import mutter, warning
30
# TODO: when showing single-line logs, truncate to the width of the terminal
31
# if known, but only if really going to the terminal (not into a file)
34
def report_changes(to_file, old, new, specific_files,
35
show_short_reporter, show_long_callback,
36
short=False, want_unchanged=False,
37
want_unversioned=False, show_ids=False):
38
"""Display summary of changes.
40
This compares two trees with regards to a list of files, and delegates
41
the display to underlying elements.
43
For short output, it creates an iterator on all changes, and lets a given
44
reporter display these changes.
46
For stantard output, it creates a delta of the changes, and forwards it
49
:param to_file: If set, write to this file (default stdout.)
50
:param old: Start tree for the comparison
51
:param end: End tree for the comparison
52
:param specific_files: If set, a list of filenames whose status should be
53
shown. It is an error to give a filename that is not in the working
54
tree, or in the working inventory or in the basis inventory.
55
:param show_short_reporter: Reporter in charge of display for short output
56
:param show_long_callback: Callback in charge of display for normal output
57
:param short: If True, gives short SVN-style status lines.
58
:param want_unchanged: Deprecated parameter. If set, includes unchanged
60
:param show_ids: If set, includes each file's id.
61
:param want_unversioned: If False, only shows versioned files.
65
changes = new.iter_changes(old, want_unchanged, specific_files,
66
require_versioned=False, want_unversioned=want_unversioned)
67
_mod_delta.report_changes(changes, show_short_reporter)
70
delta = new.changes_from(old, want_unchanged=want_unchanged,
71
specific_files=specific_files,
72
want_unversioned=want_unversioned)
73
# filter out unknown files. We may want a tree method for
75
delta.unversioned = [unversioned for unversioned in
76
delta.unversioned if not new.is_ignored(unversioned[0])]
77
show_long_callback(to_file, delta,
79
show_unchanged=want_unchanged)
82
def show_tree_status(wt, show_unchanged=None,
91
show_long_callback=_mod_delta.report_delta):
92
"""Display summary of changes.
94
By default this compares the working tree to a previous revision.
95
If the revision argument is given, summarizes changes between the
96
working tree and another, or between two revisions.
98
The result is written out as Unicode and to_file should be able
101
If showing the status of a working tree, extra information is included
102
about unknown files, conflicts, and pending merges.
104
:param show_unchanged: Deprecated parameter. If set, includes unchanged
106
:param specific_files: If set, a list of filenames whose status should be
107
shown. It is an error to give a filename that is not in the working
108
tree, or in the working inventory or in the basis inventory.
109
:param show_ids: If set, includes each file's id.
110
:param to_file: If set, write to this file (default stdout.)
111
:param show_pending: If set, write pending merges.
112
:param revision: If None, compare latest revision with working tree
113
If not None, it must be a RevisionSpec list.
114
If one revision, compare with working tree.
115
If two revisions, show status between first and second.
116
:param short: If True, gives short SVN-style status lines.
117
:param verbose: If True, show all merged revisions, not just
119
:param versioned: If True, only shows versioned files.
120
:param show_long_callback: A callback: message = show_long_callback(to_file, delta,
121
show_ids, show_unchanged, indent, filter), only used with the long output
123
if show_unchanged is not None:
124
warn("show_tree_status with show_unchanged has been deprecated "
125
"since bzrlib 0.9", DeprecationWarning, stacklevel=2)
38
128
to_file = sys.stdout
43
old = branch.basis_tree()
44
new = branch.working_tree()
46
delta = compare_trees(old, new, want_unchanged=show_unchanged,
47
specific_files=specific_files)
51
show_unchanged=show_unchanged)
53
unknowns = new.unknowns()
56
# FIXME: Should also match if the unknown file is within a
57
# specified directory.
59
if path not in specific_files:
62
print >>to_file, 'unknown:'
64
print >>to_file, ' ', path
132
new_is_working_tree = True
134
if wt.last_revision() != wt.branch.last_revision():
135
warning("working tree is out of date, run 'bzr update'")
137
old = new.basis_tree()
138
elif len(revision) > 0:
140
old = revision[0].as_tree(wt.branch)
141
except errors.NoSuchRevision, e:
142
raise errors.BzrCommandError(str(e))
143
if (len(revision) > 1) and (revision[1].spec is not None):
145
new = revision[1].as_tree(wt.branch)
146
new_is_working_tree = False
147
except errors.NoSuchRevision, e:
148
raise errors.BzrCommandError(str(e))
154
for hook in hooks['pre_status']:
155
hook(StatusHookParams(old, new, to_file, versioned,
156
show_ids, short, verbose))
158
specific_files, nonexistents \
159
= _filter_nonexistent(specific_files, old, new)
160
want_unversioned = not versioned
162
# Reporter used for short outputs
163
reporter = _mod_delta._ChangeReporter(output_file=to_file,
164
unversioned_filter=new.is_ignored)
165
report_changes(to_file, old, new, specific_files,
166
reporter, show_long_callback,
167
short=short, want_unchanged=show_unchanged,
168
want_unversioned=want_unversioned, show_ids=show_ids)
170
# show the ignored files among specific files (i.e. show the files
171
# identified from input that we choose to ignore).
172
if specific_files is not None:
173
# Ignored files is sorted because specific_files is already sorted
174
ignored_files = [specific for specific in
175
specific_files if new.is_ignored(specific)]
176
if len(ignored_files) > 0 and not short:
177
to_file.write("ignored:\n")
181
for ignored_file in ignored_files:
182
to_file.write("%s %s\n" % (prefix, ignored_file))
184
# show the new conflicts only for now. XXX: get them from the
186
conflicts = new.conflicts()
187
if specific_files is not None:
188
conflicts = conflicts.select_conflicts(new, specific_files,
189
ignore_misses=True, recurse=True)[1]
190
if len(conflicts) > 0 and not short:
191
to_file.write("conflicts:\n")
192
for conflict in conflicts:
197
to_file.write("%s %s\n" % (prefix, unicode(conflict)))
198
# Show files that were requested but don't exist (and are
199
# not versioned). We don't involve delta in this; these
200
# paths are really the province of just the status
201
# command, since they have more to do with how it was
202
# invoked than with the tree it's operating on.
203
if nonexistents and not short:
204
to_file.write("nonexistent:\n")
205
for nonexistent in nonexistents:
206
# We could calculate prefix outside the loop but, given
207
# how rarely this ought to happen, it's OK and arguably
208
# slightly faster to do it here (ala conflicts above)
213
to_file.write("%s %s\n" % (prefix, nonexistent))
214
if (new_is_working_tree and show_pending):
215
show_pending_merges(new, to_file, short, verbose=verbose)
217
raise errors.PathsDoNotExist(nonexistents)
218
for hook in hooks['post_status']:
219
hook(StatusHookParams(old, new, to_file, versioned,
220
show_ids, short, verbose))
228
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
229
"""Get an iterator which will return the revisions in merge sorted order.
231
This will build up a list of all nodes, such that only nodes in the list
232
are referenced. It then uses MergeSorter to return them in 'merge-sorted'
235
:param revision_ids: A set of revision_ids
236
:param parent_map: The parent information for each node. Revisions which
237
are considered ghosts should not be present in the map.
238
:return: iterator from MergeSorter.iter_topo_order()
240
# MergeSorter requires that all nodes be present in the graph, so get rid
241
# of any references pointing outside of this graph.
243
for revision_id in revision_ids:
244
if revision_id not in parent_map: # ghost
245
parent_graph[revision_id] = []
247
# Only include parents which are in this sub-graph
248
parent_graph[revision_id] = [p for p in parent_map[revision_id]
249
if p in revision_ids]
250
sorter = tsort.MergeSorter(parent_graph, tip_revision)
251
return sorter.iter_topo_order()
254
def show_pending_merges(new, to_file, short=False, verbose=False):
255
"""Write out a display of pending merges in a working tree."""
256
parents = new.get_parent_ids()
260
term_width = osutils.terminal_width()
261
if term_width is not None:
262
# we need one extra space for terminals that wrap on last char
263
term_width = term_width - 1
271
def show_log_message(rev, prefix):
272
if term_width is None:
275
width = term_width - len(prefix)
276
log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
277
to_file.write(log_message + '\n')
279
pending = parents[1:]
281
last_revision = parents[0]
284
to_file.write('pending merges:\n')
286
to_file.write('pending merge tips:'
287
' (use -v to see all merge revisions)\n')
288
graph = branch.repository.get_graph()
289
other_revisions = [last_revision]
290
log_formatter = log.LineLogFormatter(to_file)
291
for merge in pending:
293
rev = branch.repository.get_revisions([merge])[0]
294
except errors.NoSuchRevision:
295
# If we are missing a revision, just print out the revision id
296
to_file.write(first_prefix + '(ghost) ' + merge + '\n')
297
other_revisions.append(merge)
300
# Log the merge, as it gets a slightly different formatting
301
show_log_message(rev, first_prefix)
305
# Find all of the revisions in the merge source, which are not in the
306
# last committed revision.
307
merge_extra = graph.find_unique_ancestors(merge, other_revisions)
308
other_revisions.append(merge)
309
merge_extra.discard(_mod_revision.NULL_REVISION)
311
# Get a handle to all of the revisions we will need
313
revisions = dict((rev.revision_id, rev) for rev in
314
branch.repository.get_revisions(merge_extra))
315
except errors.NoSuchRevision:
316
# One of the sub nodes is a ghost, check each one
318
for revision_id in merge_extra:
320
rev = branch.repository.get_revisions([revision_id])[0]
321
except errors.NoSuchRevision:
322
revisions[revision_id] = None
324
revisions[revision_id] = rev
326
# Display the revisions brought in by this merge.
327
rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
328
branch.repository.get_parent_map(merge_extra))
329
# Skip the first node
330
num, first, depth, eom = rev_id_iterator.next()
332
raise AssertionError('Somehow we misunderstood how'
333
' iter_topo_order works %s != %s' % (first, merge))
334
for num, sub_merge, depth, eom in rev_id_iterator:
335
rev = revisions[sub_merge]
337
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
339
show_log_message(revisions[sub_merge], sub_prefix)
342
def _filter_nonexistent(orig_paths, old_tree, new_tree):
343
"""Convert orig_paths to two sorted lists and return them.
345
The first is orig_paths paths minus the items in the second list,
346
and the second list is paths that are not in either inventory or
347
tree (they don't qualify if they exist in the tree's inventory, or
348
if they exist in the tree but are not versioned.)
350
If either of the two lists is empty, return it as an empty list.
352
This can be used by operations such as bzr status that can accept
353
unknown or ignored files.
355
mutter("check paths: %r", orig_paths)
357
return orig_paths, []
358
s = old_tree.filter_unversioned_files(orig_paths)
359
s = new_tree.filter_unversioned_files(s)
360
nonexistent = [path for path in s if not new_tree.has_filename(path)]
361
remaining = [path for path in orig_paths if not path in nonexistent]
362
# Sorting the 'remaining' list doesn't have much effect in
363
# practice, since the various status output sections will sort
364
# their groups individually. But for consistency of this
365
# function's API, it's better to sort both than just 'nonexistent'.
366
return sorted(remaining), sorted(nonexistent)
369
class StatusHooks(_mod_hooks.Hooks):
370
"""A dictionary mapping hook name to a list of callables for status hooks.
372
e.g. ['post_status'] Is the list of items to be called when the
373
status command has finished printing the status.
377
"""Create the default hooks.
379
These are all empty initially, because by default nothing should get
382
_mod_hooks.Hooks.__init__(self, "bzrlib.status", "hooks")
383
self.add_hook('post_status',
384
"Called with argument StatusHookParams after Bazaar has "
385
"displayed the status. StatusHookParams has the attributes "
386
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
387
"verbose). The last four arguments correspond to the command "
388
"line options specified by the user for the status command. "
389
"to_file is the output stream for writing.",
391
self.add_hook('pre_status',
392
"Called with argument StatusHookParams before Bazaar "
393
"displays the status. StatusHookParams has the attributes "
394
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
395
"verbose). The last four arguments correspond to the command "
396
"line options specified by the user for the status command. "
397
"to_file is the output stream for writing.",
401
class StatusHookParams(object):
402
"""Object holding parameters passed to post_status hooks.
404
:ivar old_tree: Start tree (basis tree) for comparison.
405
:ivar new_tree: Working tree.
406
:ivar to_file: If set, write to this file.
407
:ivar versioned: Show only versioned files.
408
:ivar show_ids: Show internal object ids.
409
:ivar short: Use short status indicators.
410
:ivar verbose: Verbose flag.
413
def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
415
"""Create a group of post_status hook parameters.
417
:param old_tree: Start tree (basis tree) for comparison.
418
:param new_tree: Working tree.
419
:param to_file: If set, write to this file.
420
:param versioned: Show only versioned files.
421
:param show_ids: Show internal object ids.
422
:param short: Use short status indicators.
423
:param verbose: Verbose flag.
425
self.old_tree = old_tree
426
self.new_tree = new_tree
427
self.to_file = to_file
428
self.versioned = versioned
429
self.show_ids = show_ids
431
self.verbose = verbose
433
def __eq__(self, other):
434
return self.__dict__ == other.__dict__
437
return "<%s(%s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
438
self.old_tree, self.new_tree, self.to_file, self.versioned,
439
self.show_ids, self.short, self.verbose)
442
def _show_shelve_summary(params):
443
"""post_status hook to display a summary of shelves.
445
:param params: StatusHookParams.
447
get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
448
if get_shelf_manager is None:
450
manager = get_shelf_manager()
451
shelves = manager.active_shelves()
453
singular = '%d shelf exists. '
454
plural = '%d shelves exist. '
455
if len(shelves) == 1:
459
params.to_file.write(fmt % len(shelves))
460
params.to_file.write('See "bzr shelve --list" for details.\n')
463
hooks = StatusHooks()
466
hooks.install_named_hook('post_status', _show_shelve_summary,
added
removed
bzrlib/status.py
