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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
21
from bzrlib import (
20
22
delta as _mod_delta,
25
27
revision as _mod_revision,
27
29
import bzrlib.errors as errors
28
from bzrlib.osutils import is_inside_any
29
from bzrlib.symbol_versioning import (deprecated_function,
31
30
from bzrlib.trace import mutter, warning
33
32
# TODO: when showing single-line logs, truncate to the width of the terminal
34
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,
37
86
def show_tree_status(wt, show_unchanged=None,
38
87
specific_files=None,
96
show_long_callback=_mod_delta.report_delta):
45
97
"""Display summary of changes.
47
By default this compares the working tree to a previous revision.
48
If the revision argument is given, summarizes changes between the
99
By default this compares the working tree to a previous revision.
100
If the revision argument is given, summarizes changes between the
49
101
working tree and another, or between two revisions.
51
The result is written out as Unicode and to_file should be able
103
The result is written out as Unicode and to_file should be able
54
106
If showing the status of a working tree, extra information is included
55
107
about unknown files, conflicts, and pending merges.
57
:param show_unchanged: Deprecated parameter. If set, includes unchanged
109
:param show_unchanged: Deprecated parameter. If set, includes unchanged
59
111
:param specific_files: If set, a list of filenames whose status should be
60
shown. It is an error to give a filename that is not in the working
112
shown. It is an error to give a filename that is not in the working
61
113
tree, or in the working inventory or in the basis inventory.
62
114
:param show_ids: If set, includes each file's id.
63
115
:param to_file: If set, write to this file (default stdout.)
103
_raise_if_nonexistent(specific_files, old, new)
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)
104
166
want_unversioned = not versioned
106
changes = new.iter_changes(old, show_unchanged, specific_files,
107
require_versioned=False, want_unversioned=want_unversioned)
108
reporter = _mod_delta._ChangeReporter(output_file=to_file,
109
unversioned_filter=new.is_ignored)
110
_mod_delta.report_changes(changes, reporter)
112
delta = new.changes_from(old, want_unchanged=show_unchanged,
113
specific_files=specific_files,
114
want_unversioned=want_unversioned)
115
# filter out unknown files. We may want a tree method for
117
delta.unversioned = [unversioned for unversioned in
118
delta.unversioned if not new.is_ignored(unversioned[0])]
121
show_unchanged=show_unchanged,
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))
123
191
# show the new conflicts only for now. XXX: get them from the
125
193
conflicts = new.conflicts()
136
to_file.write("%s %s\n" % (prefix, conflict))
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))
137
221
if (new_is_working_tree and show_pending):
138
show_pending_merges(new, to_file, short)
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))
240
344
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
242
log_message = log_formatter.log_string(None,
243
revisions[sub_merge],
244
term_width - len(sub_prefix))
245
to_file.write(sub_prefix + log_message + '\n')
248
def _raise_if_nonexistent(paths, old_tree, new_tree):
249
"""Complain if paths are not in either inventory or tree.
251
It's OK with the files exist in either tree's inventory, or
252
if they exist in the tree but are not versioned.
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.
254
359
This can be used by operations such as bzr status that can accept
255
360
unknown or ignored files.
257
mutter("check paths: %r", paths)
260
s = old_tree.filter_unversioned_files(paths)
362
mutter("check paths: %r", orig_paths)
364
return orig_paths, []
365
s = old_tree.filter_unversioned_files(orig_paths)
261
366
s = new_tree.filter_unversioned_files(s)
262
s = [path for path in s if not new_tree.has_filename(path)]
264
raise errors.PathsDoNotExist(sorted(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
