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 = [change for change in delta.unversioned
80
if not new.is_ignored(change.path[1])]
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
132
new_is_working_tree = True
134
if wt.last_revision() != wt.branch.last_revision():
135
warning("working tree is out of date, run 'brz update'")
137
old = new.basis_tree()
138
elif len(revision) > 0:
140
old = revision[0].as_tree(wt.branch)
141
except errors.NoSuchRevision as 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 as e:
148
raise errors.BzrCommandError(str(e))
151
with old.lock_read(), new.lock_read():
152
for hook in hooks['pre_status']:
153
hook(StatusHookParams(
154
old, new, to_file, versioned, show_ids, short, verbose,
155
specific_files=specific_files))
157
specific_files, nonexistents \
158
= _filter_nonexistent(specific_files, old, new)
159
want_unversioned = not versioned
161
# Reporter used for short outputs
162
reporter = _mod_delta._ChangeReporter(
163
output_file=to_file, unversioned_filter=new.is_ignored,
165
report_changes(to_file, old, new, specific_files,
166
reporter, show_long_callback,
167
short=short, want_unversioned=want_unversioned,
168
show_ids=show_ids, classify=classify)
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(
189
new, specific_files, 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, conflict.describe()))
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(
220
old, new, to_file, versioned, show_ids, short, verbose,
221
specific_files=specific_files))
224
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
225
"""Get an iterator which will return the revisions in merge sorted order.
227
This will build up a list of all nodes, such that only nodes in the list
228
are referenced. It then uses MergeSorter to return them in 'merge-sorted'
231
:param revision_ids: A set of revision_ids
232
:param parent_map: The parent information for each node. Revisions which
233
are considered ghosts should not be present in the map.
234
:return: iterator from MergeSorter.iter_topo_order()
236
# MergeSorter requires that all nodes be present in the graph, so get rid
237
# of any references pointing outside of this graph.
239
for revision_id in revision_ids:
240
if revision_id not in parent_map: # ghost
241
parent_graph[revision_id] = []
243
# Only include parents which are in this sub-graph
244
parent_graph[revision_id] = [p for p in parent_map[revision_id]
245
if p in revision_ids]
246
sorter = tsort.MergeSorter(parent_graph, tip_revision)
247
return sorter.iter_topo_order()
250
def show_pending_merges(new, to_file, short=False, verbose=False):
251
"""Write out a display of pending merges in a working tree."""
252
parents = new.get_parent_ids()
256
term_width = osutils.terminal_width()
257
if term_width is not None:
258
# we need one extra space for terminals that wrap on last char
259
term_width = term_width - 1
267
def show_log_message(rev, prefix):
268
if term_width is None:
271
width = term_width - len(prefix)
272
log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
273
to_file.write(log_message + '\n')
275
pending = parents[1:]
277
last_revision = parents[0]
280
to_file.write('pending merges:\n')
282
to_file.write('pending merge tips:'
283
' (use -v to see all merge revisions)\n')
284
graph = branch.repository.get_graph()
285
other_revisions = [last_revision]
286
log_formatter = log.LineLogFormatter(to_file)
287
for merge in pending:
289
rev = branch.repository.get_revision(merge)
290
except errors.NoSuchRevision:
291
# If we are missing a revision, just print out the revision id
292
to_file.write(first_prefix + '(ghost) ' +
293
merge.decode('utf-8') + '\n')
294
other_revisions.append(merge)
297
# Log the merge, as it gets a slightly different formatting
298
show_log_message(rev, first_prefix)
302
# Find all of the revisions in the merge source, which are not in the
303
# last committed revision.
304
merge_extra = graph.find_unique_ancestors(merge, other_revisions)
305
other_revisions.append(merge)
306
merge_extra.discard(_mod_revision.NULL_REVISION)
308
# Get a handle to all of the revisions we will need
309
revisions = dict(branch.repository.iter_revisions(merge_extra))
311
# Display the revisions brought in by this merge.
312
rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
313
branch.repository.get_parent_map(merge_extra))
314
# Skip the first node
315
num, first, depth, eom = next(rev_id_iterator)
317
raise AssertionError('Somehow we misunderstood how'
318
' iter_topo_order works %s != %s' % (first, merge))
319
for num, sub_merge, depth, eom in rev_id_iterator:
320
rev = revisions[sub_merge]
322
to_file.write(sub_prefix + '(ghost) ' +
323
sub_merge.decode('utf-8') + '\n')
325
show_log_message(revisions[sub_merge], sub_prefix)
328
def _filter_nonexistent(orig_paths, old_tree, new_tree):
329
"""Convert orig_paths to two sorted lists and return them.
331
The first is orig_paths paths minus the items in the second list,
332
and the second list is paths that are not in either inventory or
333
tree (they don't qualify if they exist in the tree's inventory, or
334
if they exist in the tree but are not versioned.)
336
If either of the two lists is empty, return it as an empty list.
338
This can be used by operations such as brz status that can accept
339
unknown or ignored files.
341
mutter("check paths: %r", orig_paths)
343
return orig_paths, []
344
s = old_tree.filter_unversioned_files(orig_paths)
345
s = new_tree.filter_unversioned_files(s)
346
nonexistent = [path for path in s if not new_tree.has_filename(path)]
347
remaining = [path for path in orig_paths if path not in nonexistent]
348
# Sorting the 'remaining' list doesn't have much effect in
349
# practice, since the various status output sections will sort
350
# their groups individually. But for consistency of this
351
# function's API, it's better to sort both than just 'nonexistent'.
352
return sorted(remaining), sorted(nonexistent)
355
class StatusHooks(_mod_hooks.Hooks):
356
"""A dictionary mapping hook name to a list of callables for status hooks.
358
e.g. ['post_status'] Is the list of items to be called when the
359
status command has finished printing the status.
363
"""Create the default hooks.
365
These are all empty initially, because by default nothing should get
368
_mod_hooks.Hooks.__init__(self, "breezy.status", "hooks")
371
"Called with argument StatusHookParams after Bazaar has "
372
"displayed the status. StatusHookParams has the attributes "
373
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
374
"verbose). The last four arguments correspond to the command "
375
"line options specified by the user for the status command. "
376
"to_file is the output stream for writing.",
380
"Called with argument StatusHookParams before Bazaar "
381
"displays 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.",
389
class StatusHookParams(object):
390
"""Object holding parameters passed to post_status hooks.
392
:ivar old_tree: Start tree (basis tree) for comparison.
393
:ivar new_tree: Working tree.
394
:ivar to_file: If set, write to this file.
395
:ivar versioned: Show only versioned files.
396
:ivar show_ids: Show internal object ids.
397
:ivar short: Use short status indicators.
398
:ivar verbose: Verbose flag.
401
def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
402
short, verbose, specific_files=None):
403
"""Create a group of post_status hook parameters.
405
:param old_tree: Start tree (basis tree) for comparison.
406
:param new_tree: Working tree.
407
:param to_file: If set, write to this file.
408
:param versioned: Show only versioned files.
409
:param show_ids: Show internal object ids.
410
:param short: Use short status indicators.
411
:param verbose: Verbose flag.
412
:param specific_files: If set, a list of filenames whose status should be
413
shown. It is an error to give a filename that is not in the
414
working tree, or in the working inventory or in the basis inventory.
416
self.old_tree = old_tree
417
self.new_tree = new_tree
418
self.to_file = to_file
419
self.versioned = versioned
420
self.show_ids = show_ids
422
self.verbose = verbose
423
self.specific_files = specific_files
425
def __eq__(self, other):
426
return self.__dict__ == other.__dict__
429
return "<%s(%s, %s, %s, %s, %s, %s, %s, %s)>" % (
430
self.__class__.__name__, self.old_tree, self.new_tree,
431
self.to_file, self.versioned, self.show_ids, self.short,
432
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
