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,
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 specific_files: If set, a list of filenames whose status should be
111
shown. It is an error to give a filename that is not in the working
112
tree, or in the working inventory or in the basis inventory.
113
:param show_ids: If set, includes each file's id.
114
:param to_file: If set, write to this file (default stdout.)
115
:param show_pending: If set, write pending merges.
116
:param revision: If None, compare latest revision with working tree
117
If not None, it must be a RevisionSpec list.
118
If one revision, compare with working tree.
119
If two revisions, show status between first and second.
120
:param short: If True, gives short SVN-style status lines.
121
:param verbose: If True, show all merged revisions, not just
123
:param versioned: If True, only shows versioned files.
124
:param classify: Add special symbols to indicate file kind.
125
:param show_long_callback: A callback: message = show_long_callback(to_file, delta,
126
show_ids, show_unchanged, indent, filter), only used with the long output
133
new_is_working_tree = True
135
if wt.last_revision() != wt.branch.last_revision():
136
warning("working tree is out of date, run 'brz update'")
138
old = new.basis_tree()
139
elif len(revision) > 0:
141
old = revision[0].as_tree(wt.branch)
142
except errors.NoSuchRevision as e:
143
raise errors.BzrCommandError(str(e))
144
if (len(revision) > 1) and (revision[1].spec is not None):
146
new = revision[1].as_tree(wt.branch)
147
new_is_working_tree = False
148
except errors.NoSuchRevision as e:
149
raise errors.BzrCommandError(str(e))
155
for hook in hooks['pre_status']:
156
hook(StatusHookParams(old, new, to_file, versioned,
157
show_ids, short, verbose, specific_files=specific_files))
159
specific_files, nonexistents \
160
= _filter_nonexistent(specific_files, old, new)
161
want_unversioned = not versioned
163
# Reporter used for short outputs
164
reporter = _mod_delta._ChangeReporter(output_file=to_file,
165
unversioned_filter=new.is_ignored, classify=classify)
166
report_changes(to_file, old, new, specific_files,
167
reporter, show_long_callback,
168
short=short, want_unversioned=want_unversioned,
169
show_ids=show_ids, classify=classify)
171
# show the ignored files among specific files (i.e. show the files
172
# identified from input that we choose to ignore).
173
if specific_files is not None:
174
# Ignored files is sorted because specific_files is already sorted
175
ignored_files = [specific for specific in
176
specific_files if new.is_ignored(specific)]
177
if len(ignored_files) > 0 and not short:
178
to_file.write("ignored:\n")
182
for ignored_file in ignored_files:
183
to_file.write("%s %s\n" % (prefix, ignored_file))
185
# show the new conflicts only for now. XXX: get them from the
187
conflicts = new.conflicts()
188
if specific_files is not None:
189
conflicts = conflicts.select_conflicts(new, specific_files,
190
ignore_misses=True, recurse=True)[1]
191
if len(conflicts) > 0 and not short:
192
to_file.write("conflicts:\n")
193
for conflict in conflicts:
198
to_file.write("%s %s\n" % (prefix, unicode(conflict)))
199
# Show files that were requested but don't exist (and are
200
# not versioned). We don't involve delta in this; these
201
# paths are really the province of just the status
202
# command, since they have more to do with how it was
203
# invoked than with the tree it's operating on.
204
if nonexistents and not short:
205
to_file.write("nonexistent:\n")
206
for nonexistent in nonexistents:
207
# We could calculate prefix outside the loop but, given
208
# how rarely this ought to happen, it's OK and arguably
209
# slightly faster to do it here (ala conflicts above)
214
to_file.write("%s %s\n" % (prefix, nonexistent))
215
if (new_is_working_tree and show_pending):
216
show_pending_merges(new, to_file, short, verbose=verbose)
218
raise errors.PathsDoNotExist(nonexistents)
219
for hook in hooks['post_status']:
220
hook(StatusHookParams(old, new, to_file, versioned,
221
show_ids, short, verbose, specific_files=specific_files))
229
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
230
"""Get an iterator which will return the revisions in merge sorted order.
232
This will build up a list of all nodes, such that only nodes in the list
233
are referenced. It then uses MergeSorter to return them in 'merge-sorted'
236
:param revision_ids: A set of revision_ids
237
:param parent_map: The parent information for each node. Revisions which
238
are considered ghosts should not be present in the map.
239
:return: iterator from MergeSorter.iter_topo_order()
241
# MergeSorter requires that all nodes be present in the graph, so get rid
242
# of any references pointing outside of this graph.
244
for revision_id in revision_ids:
245
if revision_id not in parent_map: # ghost
246
parent_graph[revision_id] = []
248
# Only include parents which are in this sub-graph
249
parent_graph[revision_id] = [p for p in parent_map[revision_id]
250
if p in revision_ids]
251
sorter = tsort.MergeSorter(parent_graph, tip_revision)
252
return sorter.iter_topo_order()
255
def show_pending_merges(new, to_file, short=False, verbose=False):
256
"""Write out a display of pending merges in a working tree."""
257
parents = new.get_parent_ids()
261
term_width = osutils.terminal_width()
262
if term_width is not None:
263
# we need one extra space for terminals that wrap on last char
264
term_width = term_width - 1
272
def show_log_message(rev, prefix):
273
if term_width is None:
276
width = term_width - len(prefix)
277
log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
278
to_file.write(log_message + '\n')
280
pending = parents[1:]
282
last_revision = parents[0]
285
to_file.write('pending merges:\n')
287
to_file.write('pending merge tips:'
288
' (use -v to see all merge revisions)\n')
289
graph = branch.repository.get_graph()
290
other_revisions = [last_revision]
291
log_formatter = log.LineLogFormatter(to_file)
292
for merge in pending:
294
rev = branch.repository.get_revision(merge)
295
except errors.NoSuchRevision:
296
# If we are missing a revision, just print out the revision id
297
to_file.write(first_prefix + '(ghost) ' + merge + '\n')
298
other_revisions.append(merge)
301
# Log the merge, as it gets a slightly different formatting
302
show_log_message(rev, first_prefix)
306
# Find all of the revisions in the merge source, which are not in the
307
# last committed revision.
308
merge_extra = graph.find_unique_ancestors(merge, other_revisions)
309
other_revisions.append(merge)
310
merge_extra.discard(_mod_revision.NULL_REVISION)
312
# Get a handle to all of the revisions we will need
313
revisions = dict(branch.repository.iter_revisions(merge_extra))
315
# Display the revisions brought in by this merge.
316
rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
317
branch.repository.get_parent_map(merge_extra))
318
# Skip the first node
319
num, first, depth, eom = next(rev_id_iterator)
321
raise AssertionError('Somehow we misunderstood how'
322
' iter_topo_order works %s != %s' % (first, merge))
323
for num, sub_merge, depth, eom in rev_id_iterator:
324
rev = revisions[sub_merge]
326
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
328
show_log_message(revisions[sub_merge], sub_prefix)
331
def _filter_nonexistent(orig_paths, old_tree, new_tree):
332
"""Convert orig_paths to two sorted lists and return them.
334
The first is orig_paths paths minus the items in the second list,
335
and the second list is paths that are not in either inventory or
336
tree (they don't qualify if they exist in the tree's inventory, or
337
if they exist in the tree but are not versioned.)
339
If either of the two lists is empty, return it as an empty list.
341
This can be used by operations such as brz status that can accept
342
unknown or ignored files.
344
mutter("check paths: %r", orig_paths)
346
return orig_paths, []
347
s = old_tree.filter_unversioned_files(orig_paths)
348
s = new_tree.filter_unversioned_files(s)
349
nonexistent = [path for path in s if not new_tree.has_filename(path)]
350
remaining = [path for path in orig_paths if not path in nonexistent]
351
# Sorting the 'remaining' list doesn't have much effect in
352
# practice, since the various status output sections will sort
353
# their groups individually. But for consistency of this
354
# function's API, it's better to sort both than just 'nonexistent'.
355
return sorted(remaining), sorted(nonexistent)
358
class StatusHooks(_mod_hooks.Hooks):
359
"""A dictionary mapping hook name to a list of callables for status hooks.
361
e.g. ['post_status'] Is the list of items to be called when the
362
status command has finished printing the status.
366
"""Create the default hooks.
368
These are all empty initially, because by default nothing should get
371
_mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
372
self.add_hook('post_status',
373
"Called with argument StatusHookParams after Bazaar has "
374
"displayed the status. StatusHookParams has the attributes "
375
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
376
"verbose). The last four arguments correspond to the command "
377
"line options specified by the user for the status command. "
378
"to_file is the output stream for writing.",
380
self.add_hook('pre_status',
381
"Called with argument StatusHookParams before Bazaar "
382
"displays the status. StatusHookParams has the attributes "
383
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
384
"verbose). The last four arguments correspond to the command "
385
"line options specified by the user for the status command. "
386
"to_file is the output stream for writing.",
390
class StatusHookParams(object):
391
"""Object holding parameters passed to post_status hooks.
393
:ivar old_tree: Start tree (basis tree) for comparison.
394
:ivar new_tree: Working tree.
395
:ivar to_file: If set, write to this file.
396
:ivar versioned: Show only versioned files.
397
:ivar show_ids: Show internal object ids.
398
:ivar short: Use short status indicators.
399
:ivar verbose: Verbose flag.
402
def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
403
short, verbose, specific_files=None):
404
"""Create a group of post_status hook parameters.
406
:param old_tree: Start tree (basis tree) for comparison.
407
:param new_tree: Working tree.
408
:param to_file: If set, write to this file.
409
:param versioned: Show only versioned files.
410
:param show_ids: Show internal object ids.
411
:param short: Use short status indicators.
412
:param verbose: Verbose flag.
413
:param specific_files: If set, a list of filenames whose status should be
414
shown. It is an error to give a filename that is not in the working
415
tree, or in the working inventory or in the basis inventory.
417
self.old_tree = old_tree
418
self.new_tree = new_tree
419
self.to_file = to_file
420
self.versioned = versioned
421
self.show_ids = show_ids
423
self.verbose = verbose
424
self.specific_files = specific_files
426
def __eq__(self, other):
427
return self.__dict__ == other.__dict__
430
return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
431
self.old_tree, self.new_tree, self.to_file, self.versioned,
432
self.show_ids, self.short, self.verbose, self.specific_files)
435
def _show_shelve_summary(params):
436
"""post_status hook to display a summary of shelves.
438
:param params: StatusHookParams.
440
# Don't show shelves if status of specific files is being shown, only if
441
# no file arguments have been passed
442
if params.specific_files:
444
get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
445
if get_shelf_manager is None:
448
manager = get_shelf_manager()
449
except ShelvingUnsupported:
450
mutter('shelving not supported by tree, not displaying shelves.')
452
shelves = manager.active_shelves()
454
singular = '%d shelf exists. '
455
plural = '%d shelves exist. '
456
if len(shelves) == 1:
460
params.to_file.write(fmt % len(shelves))
461
params.to_file.write('See "brz shelve --list" for details.\n')
464
hooks = StatusHooks()
467
hooks.install_named_hook('post_status', _show_shelve_summary,
added
removed
breezy/status.py
