1
# Copyright (C) 2005-2010 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
27
revision as _mod_revision,
29
from . import errors as errors
30
from .trace import mutter, warning
31
from .workingtree import ShelvingUnsupported
34
# TODO: when showing single-line logs, truncate to the width of the terminal
35
# if known, but only if really going to the terminal (not into a file)
38
def report_changes(to_file, old, new, specific_files,
39
show_short_reporter, show_long_callback,
40
short=False, want_unchanged=False,
41
want_unversioned=False, show_ids=False, classify=True):
42
"""Display summary of changes.
44
This compares two trees with regards to a list of files, and delegates
45
the display to underlying elements.
47
For short output, it creates an iterator on all changes, and lets a given
48
reporter display these changes.
50
For stantard output, it creates a delta of the changes, and forwards it
53
:param to_file: If set, write to this file (default stdout.)
54
:param old: Start tree for the comparison
55
:param end: End tree for the comparison
56
:param specific_files: If set, a list of filenames whose status should be
57
shown. It is an error to give a filename that is not in the working
58
tree, or in the working inventory or in the basis inventory.
59
:param show_short_reporter: Reporter in charge of display for short output
60
:param show_long_callback: Callback in charge of display for normal output
61
:param short: If True, gives short SVN-style status lines.
62
:param want_unchanged: Deprecated parameter. If set, includes unchanged
64
:param show_ids: If set, includes each file's id.
65
:param want_unversioned: If False, only shows versioned files.
66
:param classify: Add special symbols to indicate file kind.
70
changes = new.iter_changes(old, want_unchanged, specific_files,
71
require_versioned=False, want_unversioned=want_unversioned)
72
_mod_delta.report_changes(changes, show_short_reporter)
74
delta = new.changes_from(old, want_unchanged=want_unchanged,
75
specific_files=specific_files,
76
want_unversioned=want_unversioned)
77
# filter out unknown files. We may want a tree method for
79
delta.unversioned = [unversioned for unversioned in
80
delta.unversioned if not new.is_ignored(unversioned[0])]
81
show_long_callback(to_file, delta,
83
show_unchanged=want_unchanged,
87
def show_tree_status(wt, show_unchanged=None,
97
show_long_callback=_mod_delta.report_delta):
98
"""Display summary of changes.
100
By default this compares the working tree to a previous revision.
101
If the revision argument is given, summarizes changes between the
102
working tree and another, or between two revisions.
104
The result is written out as Unicode and to_file should be able
107
If showing the status of a working tree, extra information is included
108
about unknown files, conflicts, and pending merges.
110
:param show_unchanged: Deprecated parameter. If set, includes unchanged
112
:param specific_files: If set, a list of filenames whose status should be
113
shown. It is an error to give a filename that is not in the working
114
tree, or in the working inventory or in the basis inventory.
115
:param show_ids: If set, includes each file's id.
116
:param to_file: If set, write to this file (default stdout.)
117
:param show_pending: If set, write pending merges.
118
:param revision: If None, compare latest revision with working tree
119
If not None, it must be a RevisionSpec list.
120
If one revision, compare with working tree.
121
If two revisions, show status between first and second.
122
:param short: If True, gives short SVN-style status lines.
123
:param verbose: If True, show all merged revisions, not just
125
:param versioned: If True, only shows versioned files.
126
:param classify: Add special symbols to indicate file kind.
127
:param show_long_callback: A callback: message = show_long_callback(to_file, delta,
128
show_ids, show_unchanged, indent, filter), only used with the long output
130
if show_unchanged is not None:
131
warn("show_tree_status with show_unchanged has been deprecated "
132
"since breezy 0.9", DeprecationWarning, stacklevel=2)
139
new_is_working_tree = True
141
if wt.last_revision() != wt.branch.last_revision():
142
warning("working tree is out of date, run 'brz update'")
144
old = new.basis_tree()
145
elif len(revision) > 0:
147
old = revision[0].as_tree(wt.branch)
148
except errors.NoSuchRevision as e:
149
raise errors.BzrCommandError(str(e))
150
if (len(revision) > 1) and (revision[1].spec is not None):
152
new = revision[1].as_tree(wt.branch)
153
new_is_working_tree = False
154
except errors.NoSuchRevision as e:
155
raise errors.BzrCommandError(str(e))
161
for hook in hooks['pre_status']:
162
hook(StatusHookParams(old, new, to_file, versioned,
163
show_ids, short, verbose, specific_files=specific_files))
165
specific_files, nonexistents \
166
= _filter_nonexistent(specific_files, old, new)
167
want_unversioned = not versioned
169
# Reporter used for short outputs
170
reporter = _mod_delta._ChangeReporter(output_file=to_file,
171
unversioned_filter=new.is_ignored, classify=classify)
172
report_changes(to_file, old, new, specific_files,
173
reporter, show_long_callback,
174
short=short, want_unchanged=show_unchanged,
175
want_unversioned=want_unversioned, show_ids=show_ids,
178
# show the ignored files among specific files (i.e. show the files
179
# identified from input that we choose to ignore).
180
if specific_files is not None:
181
# Ignored files is sorted because specific_files is already sorted
182
ignored_files = [specific for specific in
183
specific_files if new.is_ignored(specific)]
184
if len(ignored_files) > 0 and not short:
185
to_file.write("ignored:\n")
189
for ignored_file in ignored_files:
190
to_file.write("%s %s\n" % (prefix, ignored_file))
192
# show the new conflicts only for now. XXX: get them from the
194
conflicts = new.conflicts()
195
if specific_files is not None:
196
conflicts = conflicts.select_conflicts(new, specific_files,
197
ignore_misses=True, recurse=True)[1]
198
if len(conflicts) > 0 and not short:
199
to_file.write("conflicts:\n")
200
for conflict in conflicts:
205
to_file.write("%s %s\n" % (prefix, unicode(conflict)))
206
# Show files that were requested but don't exist (and are
207
# not versioned). We don't involve delta in this; these
208
# paths are really the province of just the status
209
# command, since they have more to do with how it was
210
# invoked than with the tree it's operating on.
211
if nonexistents and not short:
212
to_file.write("nonexistent:\n")
213
for nonexistent in nonexistents:
214
# We could calculate prefix outside the loop but, given
215
# how rarely this ought to happen, it's OK and arguably
216
# slightly faster to do it here (ala conflicts above)
221
to_file.write("%s %s\n" % (prefix, nonexistent))
222
if (new_is_working_tree and show_pending):
223
show_pending_merges(new, to_file, short, verbose=verbose)
225
raise errors.PathsDoNotExist(nonexistents)
226
for hook in hooks['post_status']:
227
hook(StatusHookParams(old, new, to_file, versioned,
228
show_ids, short, verbose, specific_files=specific_files))
236
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
237
"""Get an iterator which will return the revisions in merge sorted order.
239
This will build up a list of all nodes, such that only nodes in the list
240
are referenced. It then uses MergeSorter to return them in 'merge-sorted'
243
:param revision_ids: A set of revision_ids
244
:param parent_map: The parent information for each node. Revisions which
245
are considered ghosts should not be present in the map.
246
:return: iterator from MergeSorter.iter_topo_order()
248
# MergeSorter requires that all nodes be present in the graph, so get rid
249
# of any references pointing outside of this graph.
251
for revision_id in revision_ids:
252
if revision_id not in parent_map: # ghost
253
parent_graph[revision_id] = []
255
# Only include parents which are in this sub-graph
256
parent_graph[revision_id] = [p for p in parent_map[revision_id]
257
if p in revision_ids]
258
sorter = tsort.MergeSorter(parent_graph, tip_revision)
259
return sorter.iter_topo_order()
262
def show_pending_merges(new, to_file, short=False, verbose=False):
263
"""Write out a display of pending merges in a working tree."""
264
parents = new.get_parent_ids()
268
term_width = osutils.terminal_width()
269
if term_width is not None:
270
# we need one extra space for terminals that wrap on last char
271
term_width = term_width - 1
279
def show_log_message(rev, prefix):
280
if term_width is None:
283
width = term_width - len(prefix)
284
log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
285
to_file.write(log_message + '\n')
287
pending = parents[1:]
289
last_revision = parents[0]
292
to_file.write('pending merges:\n')
294
to_file.write('pending merge tips:'
295
' (use -v to see all merge revisions)\n')
296
graph = branch.repository.get_graph()
297
other_revisions = [last_revision]
298
log_formatter = log.LineLogFormatter(to_file)
299
for merge in pending:
301
rev = branch.repository.get_revision(merge)
302
except errors.NoSuchRevision:
303
# If we are missing a revision, just print out the revision id
304
to_file.write(first_prefix + '(ghost) ' + merge + '\n')
305
other_revisions.append(merge)
308
# Log the merge, as it gets a slightly different formatting
309
show_log_message(rev, first_prefix)
313
# Find all of the revisions in the merge source, which are not in the
314
# last committed revision.
315
merge_extra = graph.find_unique_ancestors(merge, other_revisions)
316
other_revisions.append(merge)
317
merge_extra.discard(_mod_revision.NULL_REVISION)
319
# Get a handle to all of the revisions we will need
320
revisions = dict(branch.repository.iter_revisions(merge_extra))
322
# Display the revisions brought in by this merge.
323
rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
324
branch.repository.get_parent_map(merge_extra))
325
# Skip the first node
326
num, first, depth, eom = next(rev_id_iterator)
328
raise AssertionError('Somehow we misunderstood how'
329
' iter_topo_order works %s != %s' % (first, merge))
330
for num, sub_merge, depth, eom in rev_id_iterator:
331
rev = revisions[sub_merge]
333
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
335
show_log_message(revisions[sub_merge], sub_prefix)
338
def _filter_nonexistent(orig_paths, old_tree, new_tree):
339
"""Convert orig_paths to two sorted lists and return them.
341
The first is orig_paths paths minus the items in the second list,
342
and the second list is paths that are not in either inventory or
343
tree (they don't qualify if they exist in the tree's inventory, or
344
if they exist in the tree but are not versioned.)
346
If either of the two lists is empty, return it as an empty list.
348
This can be used by operations such as brz status that can accept
349
unknown or ignored files.
351
mutter("check paths: %r", orig_paths)
353
return orig_paths, []
354
s = old_tree.filter_unversioned_files(orig_paths)
355
s = new_tree.filter_unversioned_files(s)
356
nonexistent = [path for path in s if not new_tree.has_filename(path)]
357
remaining = [path for path in orig_paths if not path in nonexistent]
358
# Sorting the 'remaining' list doesn't have much effect in
359
# practice, since the various status output sections will sort
360
# their groups individually. But for consistency of this
361
# function's API, it's better to sort both than just 'nonexistent'.
362
return sorted(remaining), sorted(nonexistent)
365
class StatusHooks(_mod_hooks.Hooks):
366
"""A dictionary mapping hook name to a list of callables for status hooks.
368
e.g. ['post_status'] Is the list of items to be called when the
369
status command has finished printing the status.
373
"""Create the default hooks.
375
These are all empty initially, because by default nothing should get
378
_mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
379
self.add_hook('post_status',
380
"Called with argument StatusHookParams after Bazaar has "
381
"displayed the status. StatusHookParams has the attributes "
382
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
383
"verbose). The last four arguments correspond to the command "
384
"line options specified by the user for the status command. "
385
"to_file is the output stream for writing.",
387
self.add_hook('pre_status',
388
"Called with argument StatusHookParams before Bazaar "
389
"displays the status. StatusHookParams has the attributes "
390
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
391
"verbose). The last four arguments correspond to the command "
392
"line options specified by the user for the status command. "
393
"to_file is the output stream for writing.",
397
class StatusHookParams(object):
398
"""Object holding parameters passed to post_status hooks.
400
:ivar old_tree: Start tree (basis tree) for comparison.
401
:ivar new_tree: Working tree.
402
:ivar to_file: If set, write to this file.
403
:ivar versioned: Show only versioned files.
404
:ivar show_ids: Show internal object ids.
405
:ivar short: Use short status indicators.
406
:ivar verbose: Verbose flag.
409
def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
410
short, verbose, specific_files=None):
411
"""Create a group of post_status hook parameters.
413
:param old_tree: Start tree (basis tree) for comparison.
414
:param new_tree: Working tree.
415
:param to_file: If set, write to this file.
416
:param versioned: Show only versioned files.
417
:param show_ids: Show internal object ids.
418
:param short: Use short status indicators.
419
:param verbose: Verbose flag.
420
:param specific_files: If set, a list of filenames whose status should be
421
shown. It is an error to give a filename that is not in the working
422
tree, or in the working inventory or in the basis inventory.
424
self.old_tree = old_tree
425
self.new_tree = new_tree
426
self.to_file = to_file
427
self.versioned = versioned
428
self.show_ids = show_ids
430
self.verbose = verbose
431
self.specific_files = specific_files
433
def __eq__(self, other):
434
return self.__dict__ == other.__dict__
437
return "<%s(%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, self.specific_files)
442
def _show_shelve_summary(params):
443
"""post_status hook to display a summary of shelves.
445
:param params: StatusHookParams.
447
# Don't show shelves if status of specific files is being shown, only if
448
# no file arguments have been passed
449
if params.specific_files:
451
get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
452
if get_shelf_manager is None:
455
manager = get_shelf_manager()
456
except ShelvingUnsupported:
457
mutter('shelving not supported by tree, not displaying shelves.')
459
shelves = manager.active_shelves()
461
singular = '%d shelf exists. '
462
plural = '%d shelves exist. '
463
if len(shelves) == 1:
467
params.to_file.write(fmt % len(shelves))
468
params.to_file.write('See "brz shelve --list" for details.\n')
471
hooks = StatusHooks()
474
hooks.install_named_hook('post_status', _show_shelve_summary,
added
removed
breezy/status.py
