1
# Copyright (C) 2005-2010 Canonical Ltd
1
# (C) 2005 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
27
revision as _mod_revision,
29
import bzrlib.errors as errors
30
from bzrlib.trace import mutter, warning
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)
36
def report_changes(to_file, old, new, specific_files,
37
show_short_reporter, show_long_callback,
38
short=False, want_unchanged=False,
39
want_unversioned=False, show_ids=False, classify=True):
40
"""Display summary of changes.
42
This compares two trees with regards to a list of files, and delegates
43
the display to underlying elements.
45
For short output, it creates an iterator on all changes, and lets a given
46
reporter display these changes.
48
For stantard output, it creates a delta of the changes, and forwards it
51
:param to_file: If set, write to this file (default stdout.)
52
:param old: Start tree for the comparison
53
:param end: End tree for the comparison
54
:param specific_files: If set, a list of filenames whose status should be
55
shown. It is an error to give a filename that is not in the working
56
tree, or in the working inventory or in the basis inventory.
57
:param show_short_reporter: Reporter in charge of display for short output
58
:param show_long_callback: Callback in charge of display for normal output
59
:param short: If True, gives short SVN-style status lines.
60
:param want_unchanged: Deprecated parameter. If set, includes unchanged
62
:param show_ids: If set, includes each file's id.
63
:param want_unversioned: If False, only shows versioned files.
64
:param classify: Add special symbols to indicate file kind.
68
changes = new.iter_changes(old, want_unchanged, specific_files,
69
require_versioned=False, want_unversioned=want_unversioned)
70
_mod_delta.report_changes(changes, show_short_reporter)
73
delta = new.changes_from(old, want_unchanged=want_unchanged,
74
specific_files=specific_files,
75
want_unversioned=want_unversioned)
76
# filter out unknown files. We may want a tree method for
78
delta.unversioned = [unversioned for unversioned in
79
delta.unversioned if not new.is_ignored(unversioned[0])]
80
show_long_callback(to_file, delta,
82
show_unchanged=want_unchanged,
86
def show_tree_status(wt, show_unchanged=None,
96
show_long_callback=_mod_delta.report_delta):
97
"""Display summary of changes.
99
By default this compares the working tree to a previous revision.
100
If the revision argument is given, summarizes changes between the
101
working tree and another, or between two revisions.
103
The result is written out as Unicode and to_file should be able
106
If showing the status of a working tree, extra information is included
107
about unknown files, conflicts, and pending merges.
109
:param show_unchanged: Deprecated parameter. If set, includes unchanged
111
:param specific_files: If set, a list of filenames whose status should be
112
shown. It is an error to give a filename that is not in the working
113
tree, or in the working inventory or in the basis inventory.
114
:param show_ids: If set, includes each file's id.
115
:param to_file: If set, write to this file (default stdout.)
116
:param show_pending: If set, write pending merges.
117
:param revision: If None, compare latest revision with working tree
118
If not None, it must be a RevisionSpec list.
119
If one revision, compare with working tree.
120
If two revisions, show status between first and second.
121
:param short: If True, gives short SVN-style status lines.
122
:param verbose: If True, show all merged revisions, not just
124
:param versioned: If True, only shows versioned files.
125
:param classify: Add special symbols to indicate file kind.
126
:param show_long_callback: A callback: message = show_long_callback(to_file, delta,
127
show_ids, show_unchanged, indent, filter), only used with the long output
129
if show_unchanged is not None:
130
warn("show_tree_status with show_unchanged has been deprecated "
131
"since bzrlib 0.9", DeprecationWarning, stacklevel=2)
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
def show_status(branch, show_unchanged=False,
22
"""Display single-line status for non-ignored working files.
25
If true, show unmodified files too.
28
If set, only show the status of files in this list.
31
from bzrlib.diff import compare_trees
138
new_is_working_tree = True
140
if wt.last_revision() != wt.branch.last_revision():
141
warning("working tree is out of date, run 'bzr update'")
143
old = new.basis_tree()
144
elif len(revision) > 0:
146
old = revision[0].as_tree(wt.branch)
147
except errors.NoSuchRevision, e:
148
raise errors.BzrCommandError(str(e))
149
if (len(revision) > 1) and (revision[1].spec is not None):
151
new = revision[1].as_tree(wt.branch)
152
new_is_working_tree = False
153
except errors.NoSuchRevision, e:
154
raise errors.BzrCommandError(str(e))
160
for hook in hooks['pre_status']:
161
hook(StatusHookParams(old, new, to_file, versioned,
162
show_ids, short, verbose, specific_files=specific_files))
164
specific_files, nonexistents \
165
= _filter_nonexistent(specific_files, old, new)
166
want_unversioned = not versioned
168
# Reporter used for short outputs
169
reporter = _mod_delta._ChangeReporter(output_file=to_file,
170
unversioned_filter=new.is_ignored, classify=classify)
171
report_changes(to_file, old, new, specific_files,
172
reporter, show_long_callback,
173
short=short, want_unchanged=show_unchanged,
174
want_unversioned=want_unversioned, show_ids=show_ids,
177
# show the ignored files among specific files (i.e. show the files
178
# identified from input that we choose to ignore).
179
if specific_files is not None:
180
# Ignored files is sorted because specific_files is already sorted
181
ignored_files = [specific for specific in
182
specific_files if new.is_ignored(specific)]
183
if len(ignored_files) > 0 and not short:
184
to_file.write("ignored:\n")
188
for ignored_file in ignored_files:
189
to_file.write("%s %s\n" % (prefix, ignored_file))
191
# show the new conflicts only for now. XXX: get them from the
193
conflicts = new.conflicts()
194
if specific_files is not None:
195
conflicts = conflicts.select_conflicts(new, specific_files,
196
ignore_misses=True, recurse=True)[1]
197
if len(conflicts) > 0 and not short:
198
to_file.write("conflicts:\n")
199
for conflict in conflicts:
204
to_file.write("%s %s\n" % (prefix, unicode(conflict)))
205
# Show files that were requested but don't exist (and are
206
# not versioned). We don't involve delta in this; these
207
# paths are really the province of just the status
208
# command, since they have more to do with how it was
209
# invoked than with the tree it's operating on.
210
if nonexistents and not short:
211
to_file.write("nonexistent:\n")
212
for nonexistent in nonexistents:
213
# We could calculate prefix outside the loop but, given
214
# how rarely this ought to happen, it's OK and arguably
215
# slightly faster to do it here (ala conflicts above)
220
to_file.write("%s %s\n" % (prefix, nonexistent))
221
if (new_is_working_tree and show_pending):
222
show_pending_merges(new, to_file, short, verbose=verbose)
224
raise errors.PathsDoNotExist(nonexistents)
225
for hook in hooks['post_status']:
226
hook(StatusHookParams(old, new, to_file, versioned,
227
show_ids, short, verbose, specific_files=specific_files))
36
old = branch.basis_tree()
37
new = branch.working_tree()
39
delta = compare_trees(old, new, want_unchanged=show_unchanged,
40
specific_files=specific_files)
42
delta.show(sys.stdout, show_ids=show_ids,
43
show_unchanged=show_unchanged)
45
unknowns = new.unknowns()
48
# FIXME: Should also match if the unknown file is within a
49
# specified directory.
51
if path not in specific_files:
235
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
236
"""Get an iterator which will return the revisions in merge sorted order.
238
This will build up a list of all nodes, such that only nodes in the list
239
are referenced. It then uses MergeSorter to return them in 'merge-sorted'
242
:param revision_ids: A set of revision_ids
243
:param parent_map: The parent information for each node. Revisions which
244
are considered ghosts should not be present in the map.
245
:return: iterator from MergeSorter.iter_topo_order()
247
# MergeSorter requires that all nodes be present in the graph, so get rid
248
# of any references pointing outside of this graph.
250
for revision_id in revision_ids:
251
if revision_id not in parent_map: # ghost
252
parent_graph[revision_id] = []
254
# Only include parents which are in this sub-graph
255
parent_graph[revision_id] = [p for p in parent_map[revision_id]
256
if p in revision_ids]
257
sorter = tsort.MergeSorter(parent_graph, tip_revision)
258
return sorter.iter_topo_order()
261
def show_pending_merges(new, to_file, short=False, verbose=False):
262
"""Write out a display of pending merges in a working tree."""
263
parents = new.get_parent_ids()
267
term_width = osutils.terminal_width()
268
if term_width is not None:
269
# we need one extra space for terminals that wrap on last char
270
term_width = term_width - 1
278
def show_log_message(rev, prefix):
279
if term_width is None:
282
width = term_width - len(prefix)
283
log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
284
to_file.write(log_message + '\n')
286
pending = parents[1:]
288
last_revision = parents[0]
291
to_file.write('pending merges:\n')
293
to_file.write('pending merge tips:'
294
' (use -v to see all merge revisions)\n')
295
graph = branch.repository.get_graph()
296
other_revisions = [last_revision]
297
log_formatter = log.LineLogFormatter(to_file)
298
for merge in pending:
300
rev = branch.repository.get_revisions([merge])[0]
301
except errors.NoSuchRevision:
302
# If we are missing a revision, just print out the revision id
303
to_file.write(first_prefix + '(ghost) ' + merge + '\n')
304
other_revisions.append(merge)
307
# Log the merge, as it gets a slightly different formatting
308
show_log_message(rev, first_prefix)
312
# Find all of the revisions in the merge source, which are not in the
313
# last committed revision.
314
merge_extra = graph.find_unique_ancestors(merge, other_revisions)
315
other_revisions.append(merge)
316
merge_extra.discard(_mod_revision.NULL_REVISION)
318
# Get a handle to all of the revisions we will need
320
revisions = dict((rev.revision_id, rev) for rev in
321
branch.repository.get_revisions(merge_extra))
322
except errors.NoSuchRevision:
323
# One of the sub nodes is a ghost, check each one
325
for revision_id in merge_extra:
327
rev = branch.repository.get_revisions([revision_id])[0]
328
except errors.NoSuchRevision:
329
revisions[revision_id] = None
331
revisions[revision_id] = rev
333
# Display the revisions brought in by this merge.
334
rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
335
branch.repository.get_parent_map(merge_extra))
336
# Skip the first node
337
num, first, depth, eom = rev_id_iterator.next()
339
raise AssertionError('Somehow we misunderstood how'
340
' iter_topo_order works %s != %s' % (first, merge))
341
for num, sub_merge, depth, eom in rev_id_iterator:
342
rev = revisions[sub_merge]
344
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
346
show_log_message(revisions[sub_merge], sub_prefix)
349
def _filter_nonexistent(orig_paths, old_tree, new_tree):
350
"""Convert orig_paths to two sorted lists and return them.
352
The first is orig_paths paths minus the items in the second list,
353
and the second list is paths that are not in either inventory or
354
tree (they don't qualify if they exist in the tree's inventory, or
355
if they exist in the tree but are not versioned.)
357
If either of the two lists is empty, return it as an empty list.
359
This can be used by operations such as bzr status that can accept
360
unknown or ignored files.
362
mutter("check paths: %r", orig_paths)
364
return orig_paths, []
365
s = old_tree.filter_unversioned_files(orig_paths)
366
s = new_tree.filter_unversioned_files(s)
367
nonexistent = [path for path in s if not new_tree.has_filename(path)]
368
remaining = [path for path in orig_paths if not path in nonexistent]
369
# Sorting the 'remaining' list doesn't have much effect in
370
# practice, since the various status output sections will sort
371
# their groups individually. But for consistency of this
372
# function's API, it's better to sort both than just 'nonexistent'.
373
return sorted(remaining), sorted(nonexistent)
376
class StatusHooks(_mod_hooks.Hooks):
377
"""A dictionary mapping hook name to a list of callables for status hooks.
379
e.g. ['post_status'] Is the list of items to be called when the
380
status command has finished printing the status.
384
"""Create the default hooks.
386
These are all empty initially, because by default nothing should get
389
_mod_hooks.Hooks.__init__(self, "bzrlib.status", "hooks")
390
self.add_hook('post_status',
391
"Called with argument StatusHookParams after Bazaar has "
392
"displayed the status. StatusHookParams has the attributes "
393
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
394
"verbose). The last four arguments correspond to the command "
395
"line options specified by the user for the status command. "
396
"to_file is the output stream for writing.",
398
self.add_hook('pre_status',
399
"Called with argument StatusHookParams before Bazaar "
400
"displays the status. StatusHookParams has the attributes "
401
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
402
"verbose). The last four arguments correspond to the command "
403
"line options specified by the user for the status command. "
404
"to_file is the output stream for writing.",
408
class StatusHookParams(object):
409
"""Object holding parameters passed to post_status hooks.
411
:ivar old_tree: Start tree (basis tree) for comparison.
412
:ivar new_tree: Working tree.
413
:ivar to_file: If set, write to this file.
414
:ivar versioned: Show only versioned files.
415
:ivar show_ids: Show internal object ids.
416
:ivar short: Use short status indicators.
417
:ivar verbose: Verbose flag.
420
def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
421
short, verbose, specific_files=None):
422
"""Create a group of post_status hook parameters.
424
:param old_tree: Start tree (basis tree) for comparison.
425
:param new_tree: Working tree.
426
:param to_file: If set, write to this file.
427
:param versioned: Show only versioned files.
428
:param show_ids: Show internal object ids.
429
:param short: Use short status indicators.
430
:param verbose: Verbose flag.
431
:param specific_files: If set, a list of filenames whose status should be
432
shown. It is an error to give a filename that is not in the working
433
tree, or in the working inventory or in the basis inventory.
435
self.old_tree = old_tree
436
self.new_tree = new_tree
437
self.to_file = to_file
438
self.versioned = versioned
439
self.show_ids = show_ids
441
self.verbose = verbose
442
self.specific_files = specific_files
444
def __eq__(self, other):
445
return self.__dict__ == other.__dict__
448
return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
449
self.old_tree, self.new_tree, self.to_file, self.versioned,
450
self.show_ids, self.short, self.verbose, self.specific_files)
453
def _show_shelve_summary(params):
454
"""post_status hook to display a summary of shelves.
456
:param params: StatusHookParams.
458
# Don't show shelves if status of specific files is being shown, only if
459
# no file arguments have been passed
460
if params.specific_files:
462
get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
463
if get_shelf_manager is None:
465
manager = get_shelf_manager()
466
shelves = manager.active_shelves()
468
singular = '%d shelf exists. '
469
plural = '%d shelves exist. '
470
if len(shelves) == 1:
474
params.to_file.write(fmt % len(shelves))
475
params.to_file.write('See "bzr shelve --list" for details.\n')
478
hooks = StatusHooks()
481
hooks.install_named_hook('post_status', _show_shelve_summary,
added
removed
bzrlib/status.py
