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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
19
from bzrlib import (
20
20
delta as _mod_delta,
25
25
revision as _mod_revision,
27
from bzrlib.diff import _raise_if_nonexistent
27
28
import bzrlib.errors as errors
28
from bzrlib.trace import mutter, warning
29
from bzrlib.osutils import is_inside_any
30
from bzrlib.symbol_versioning import (deprecated_function,
32
from bzrlib.trace import warning
30
34
# TODO: when showing single-line logs, truncate to the width of the terminal
31
35
# 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, classify=True):
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.
62
:param classify: Add special symbols to indicate file kind.
66
changes = new.iter_changes(old, want_unchanged, specific_files,
67
require_versioned=False, want_unversioned=want_unversioned)
68
_mod_delta.report_changes(changes, show_short_reporter)
71
delta = new.changes_from(old, want_unchanged=want_unchanged,
72
specific_files=specific_files,
73
want_unversioned=want_unversioned)
74
# filter out unknown files. We may want a tree method for
76
delta.unversioned = [unversioned for unversioned in
77
delta.unversioned if not new.is_ignored(unversioned[0])]
78
show_long_callback(to_file, delta,
80
show_unchanged=want_unchanged,
84
38
def show_tree_status(wt, show_unchanged=None,
85
39
specific_files=None,
94
show_long_callback=_mod_delta.report_delta):
95
46
"""Display summary of changes.
97
By default this compares the working tree to a previous revision.
98
If the revision argument is given, summarizes changes between the
48
By default this compares the working tree to a previous revision.
49
If the revision argument is given, summarizes changes between the
99
50
working tree and another, or between two revisions.
101
The result is written out as Unicode and to_file should be able
52
The result is written out as Unicode and to_file should be able
104
55
If showing the status of a working tree, extra information is included
105
56
about unknown files, conflicts, and pending merges.
107
:param show_unchanged: Deprecated parameter. If set, includes unchanged
58
:param show_unchanged: Deprecated parameter. If set, includes unchanged
109
60
:param specific_files: If set, a list of filenames whose status should be
110
shown. It is an error to give a filename that is not in the working
61
shown. It is an error to give a filename that is not in the working
111
62
tree, or in the working inventory or in the basis inventory.
112
63
:param show_ids: If set, includes each file's id.
113
64
:param to_file: If set, write to this file (default stdout.)
158
for hook in hooks['pre_status']:
159
hook(StatusHookParams(old, new, to_file, versioned,
160
show_ids, short, verbose))
162
specific_files, nonexistents \
163
= _filter_nonexistent(specific_files, old, new)
106
_raise_if_nonexistent(specific_files, old, new)
164
107
want_unversioned = not versioned
166
# Reporter used for short outputs
167
reporter = _mod_delta._ChangeReporter(output_file=to_file,
168
unversioned_filter=new.is_ignored, classify=classify)
169
report_changes(to_file, old, new, specific_files,
170
reporter, show_long_callback,
171
short=short, want_unchanged=show_unchanged,
172
want_unversioned=want_unversioned, show_ids=show_ids,
175
# show the ignored files among specific files (i.e. show the files
176
# identified from input that we choose to ignore).
177
if specific_files is not None:
178
# Ignored files is sorted because specific_files is already sorted
179
ignored_files = [specific for specific in
180
specific_files if new.is_ignored(specific)]
181
if len(ignored_files) > 0 and not short:
182
to_file.write("ignored:\n")
186
for ignored_file in ignored_files:
187
to_file.write("%s %s\n" % (prefix, ignored_file))
109
changes = new.iter_changes(old, show_unchanged, specific_files,
110
require_versioned=False, want_unversioned=want_unversioned)
111
reporter = _mod_delta._ChangeReporter(output_file=to_file,
112
unversioned_filter=new.is_ignored)
113
_mod_delta.report_changes(changes, reporter)
115
delta = new.changes_from(old, want_unchanged=show_unchanged,
116
specific_files=specific_files,
117
want_unversioned=want_unversioned)
118
# filter out unknown files. We may want a tree method for
120
delta.unversioned = [unversioned for unversioned in
121
delta.unversioned if not new.is_ignored(unversioned[0])]
124
show_unchanged=show_unchanged,
189
126
# show the new conflicts only for now. XXX: get them from the
191
128
conflicts = new.conflicts()
202
to_file.write("%s %s\n" % (prefix, unicode(conflict)))
203
# Show files that were requested but don't exist (and are
204
# not versioned). We don't involve delta in this; these
205
# paths are really the province of just the status
206
# command, since they have more to do with how it was
207
# invoked than with the tree it's operating on.
208
if nonexistents and not short:
209
to_file.write("nonexistent:\n")
210
for nonexistent in nonexistents:
211
# We could calculate prefix outside the loop but, given
212
# how rarely this ought to happen, it's OK and arguably
213
# slightly faster to do it here (ala conflicts above)
218
to_file.write("%s %s\n" % (prefix, nonexistent))
139
to_file.write("%s %s\n" % (prefix, conflict))
219
140
if (new_is_working_tree and show_pending):
220
show_pending_merges(new, to_file, short, verbose=verbose)
222
raise errors.PathsDoNotExist(nonexistents)
223
for hook in hooks['post_status']:
224
hook(StatusHookParams(old, new, to_file, versioned,
225
show_ids, short, verbose))
141
show_pending_merges(new, to_file, short)
342
243
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
344
show_log_message(revisions[sub_merge], sub_prefix)
347
def _filter_nonexistent(orig_paths, old_tree, new_tree):
348
"""Convert orig_paths to two sorted lists and return them.
350
The first is orig_paths paths minus the items in the second list,
351
and the second list is paths that are not in either inventory or
352
tree (they don't qualify if they exist in the tree's inventory, or
353
if they exist in the tree but are not versioned.)
355
If either of the two lists is empty, return it as an empty list.
357
This can be used by operations such as bzr status that can accept
358
unknown or ignored files.
360
mutter("check paths: %r", orig_paths)
362
return orig_paths, []
363
s = old_tree.filter_unversioned_files(orig_paths)
364
s = new_tree.filter_unversioned_files(s)
365
nonexistent = [path for path in s if not new_tree.has_filename(path)]
366
remaining = [path for path in orig_paths if not path in nonexistent]
367
# Sorting the 'remaining' list doesn't have much effect in
368
# practice, since the various status output sections will sort
369
# their groups individually. But for consistency of this
370
# function's API, it's better to sort both than just 'nonexistent'.
371
return sorted(remaining), sorted(nonexistent)
374
class StatusHooks(_mod_hooks.Hooks):
375
"""A dictionary mapping hook name to a list of callables for status hooks.
377
e.g. ['post_status'] Is the list of items to be called when the
378
status command has finished printing the status.
382
"""Create the default hooks.
384
These are all empty initially, because by default nothing should get
387
_mod_hooks.Hooks.__init__(self, "bzrlib.status", "hooks")
388
self.add_hook('post_status',
389
"Called with argument StatusHookParams after Bazaar has "
390
"displayed the status. StatusHookParams has the attributes "
391
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
392
"verbose). The last four arguments correspond to the command "
393
"line options specified by the user for the status command. "
394
"to_file is the output stream for writing.",
396
self.add_hook('pre_status',
397
"Called with argument StatusHookParams before Bazaar "
398
"displays the status. StatusHookParams has the attributes "
399
"(old_tree, new_tree, to_file, versioned, show_ids, short, "
400
"verbose). The last four arguments correspond to the command "
401
"line options specified by the user for the status command. "
402
"to_file is the output stream for writing.",
406
class StatusHookParams(object):
407
"""Object holding parameters passed to post_status hooks.
409
:ivar old_tree: Start tree (basis tree) for comparison.
410
:ivar new_tree: Working tree.
411
:ivar to_file: If set, write to this file.
412
:ivar versioned: Show only versioned files.
413
:ivar show_ids: Show internal object ids.
414
:ivar short: Use short status indicators.
415
:ivar verbose: Verbose flag.
418
def __init__(self, old_tree, new_tree, to_file, versioned, show_ids,
420
"""Create a group of post_status hook parameters.
422
:param old_tree: Start tree (basis tree) for comparison.
423
:param new_tree: Working tree.
424
:param to_file: If set, write to this file.
425
:param versioned: Show only versioned files.
426
:param show_ids: Show internal object ids.
427
:param short: Use short status indicators.
428
:param verbose: Verbose flag.
430
self.old_tree = old_tree
431
self.new_tree = new_tree
432
self.to_file = to_file
433
self.versioned = versioned
434
self.show_ids = show_ids
436
self.verbose = verbose
438
def __eq__(self, other):
439
return self.__dict__ == other.__dict__
442
return "<%s(%s, %s, %s, %s, %s, %s, %s)>" % (self.__class__.__name__,
443
self.old_tree, self.new_tree, self.to_file, self.versioned,
444
self.show_ids, self.short, self.verbose)
447
def _show_shelve_summary(params):
448
"""post_status hook to display a summary of shelves.
450
:param params: StatusHookParams.
452
get_shelf_manager = getattr(params.new_tree, 'get_shelf_manager', None)
453
if get_shelf_manager is None:
455
manager = get_shelf_manager()
456
shelves = manager.active_shelves()
458
singular = '%d shelf exists. '
459
plural = '%d shelves exist. '
460
if len(shelves) == 1:
464
params.to_file.write(fmt % len(shelves))
465
params.to_file.write('See "bzr shelve --list" for details.\n')
468
hooks = StatusHooks()
471
hooks.install_named_hook('post_status', _show_shelve_summary,
245
log_message = log_formatter.log_string(None,
246
revisions[sub_merge],
247
term_width - len(sub_prefix))
248
to_file.write(sub_prefix + log_message + '\n')
added
removed
bzrlib/status.py
