54
47
The lists are normally sorted when the delta is created.
57
49
def __init__(self):
62
self.kind_changed = []
64
54
self.unchanged = []
68
56
def __eq__(self, other):
69
57
if not isinstance(other, TreeDelta):
71
59
return self.added == other.added \
72
and self.removed == other.removed \
73
and self.renamed == other.renamed \
74
and self.copied == other.copied \
75
and self.modified == other.modified \
76
and self.unchanged == other.unchanged \
77
and self.kind_changed == other.kind_changed \
78
and self.unversioned == other.unversioned
60
and self.removed == other.removed \
61
and self.renamed == other.renamed \
62
and self.modified == other.modified \
63
and self.unchanged == other.unchanged
80
65
def __ne__(self, other):
81
66
return not (self == other)
83
68
def __repr__(self):
84
return "TreeDelta(added=%r, removed=%r, renamed=%r," \
85
" copied=%r, kind_changed=%r, modified=%r, unchanged=%r," \
86
" unversioned=%r)" % (
87
self.added, self.removed, self.renamed, self.copied,
88
self.kind_changed, self.modified, self.unchanged,
69
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
70
" unchanged=%r)" % (self.added, self.removed, self.renamed,
71
self.modified, self.unchanged)
91
73
def has_changed(self):
92
74
return bool(self.modified
99
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
102
report_delta(output, self, short_status, show_ids, show_unchanged)
103
return output.getvalue()
106
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
107
include_root, extra_trees=None,
108
require_versioned=False, want_unversioned=False):
109
"""Worker function that implements Tree.changes_from."""
79
def touches_file_id(self, file_id):
80
"""Return True if file_id is modified by this delta."""
81
for l in self.added, self.removed, self.modified:
85
for v in self.renamed:
91
def show(self, to_file, show_ids=False, show_unchanged=False):
94
path, fid, kind = item[:3]
96
if kind == 'directory':
98
elif kind == 'symlink':
101
if len(item) == 5 and item[4]:
105
print >>to_file, ' %-30s %s' % (path, fid)
107
print >>to_file, ' ', path
110
print >>to_file, 'removed:'
111
show_list(self.removed)
114
print >>to_file, 'added:'
115
show_list(self.added)
120
print >>to_file, 'renamed:'
121
for (oldpath, newpath, fid, kind,
122
text_modified, meta_modified) in self.renamed:
123
if text_modified or meta_modified:
124
extra_modified.append((newpath, fid, kind,
125
text_modified, meta_modified))
129
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
131
print >>to_file, ' %s => %s' % (oldpath, newpath)
133
if self.modified or extra_modified:
134
print >>to_file, 'modified:'
135
show_list(self.modified)
136
show_list(extra_modified)
138
if show_unchanged and self.unchanged:
139
print >>to_file, 'unchanged:'
140
show_list(self.unchanged)
144
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
145
"""Describe changes from one tree to another.
147
Returns a TreeDelta with details of added, modified, renamed, and
150
The root entry is specifically exempt.
152
This only considers versioned files.
155
If true, also list files unchanged from one version to
159
If true, only check for changes to specified names or
160
files within them. Any unversioned files given have no effect
161
(but this might change in the future).
163
# NB: show_status depends on being able to pass in non-versioned files and
164
# report them as unknown
169
return _compare_trees(old_tree, new_tree, want_unchanged,
177
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files):
179
from osutils import is_inside_any
181
old_inv = old_tree.inventory
182
new_inv = new_tree.inventory
110
183
delta = TreeDelta()
111
# mutter('start compare_trees')
113
for change in new_tree.iter_changes(
114
old_tree, want_unchanged, specific_files, extra_trees=extra_trees,
115
require_versioned=require_versioned,
116
want_unversioned=want_unversioned):
117
if change.versioned == (False, False):
118
delta.unversioned.append(change)
120
if not include_root and (None, None) == change.parent_id:
122
fully_present = tuple(
123
(change.versioned[x] and change.kind[x] is not None)
125
if fully_present[0] != fully_present[1]:
126
if fully_present[1] is True:
127
delta.added.append(change)
129
if change.kind[0] == 'symlink' and not new_tree.supports_symlinks():
131
'Ignoring "%s" as symlinks '
132
'are not supported on this filesystem.' % (change.path[0],))
134
delta.removed.append(change)
135
elif fully_present[0] is False:
136
delta.missing.append(change)
137
elif change.name[0] != change.name[1] or change.parent_id[0] != change.parent_id[1]:
138
# If the name changes, or the parent_id changes, we have a rename or copy
139
# (if we move a parent, that doesn't count as a rename for the
142
delta.copied.append(change)
144
delta.renamed.append(change)
145
elif change.kind[0] != change.kind[1]:
146
delta.kind_changed.append(change)
147
elif change.changed_content or change.executable[0] != change.executable[1]:
148
delta.modified.append(change)
150
delta.unchanged.append(change)
152
def change_key(change):
153
if change.path[0] is None:
154
path = change.path[1]
156
path = change.path[0]
157
return (path, change.file_id)
159
delta.removed.sort(key=change_key)
160
delta.added.sort(key=change_key)
161
delta.renamed.sort(key=change_key)
162
delta.copied.sort(key=change_key)
163
delta.missing.sort(key=change_key)
164
# TODO: jam 20060529 These lists shouldn't need to be sorted
165
# since we added them in alphabetical order.
166
delta.modified.sort(key=change_key)
167
delta.unchanged.sort(key=change_key)
168
delta.unversioned.sort(key=change_key)
184
mutter('start compare_trees')
186
# TODO: Rather than iterating over the whole tree and then filtering, we
187
# could diff just the specified files (if any) and their subtrees.
188
# Perhaps should take a list of file-ids instead? Need to indicate any
189
# ids or names which were not found in the trees.
191
for file_id in old_tree:
192
if file_id in new_tree:
193
old_ie = old_inv[file_id]
194
new_ie = new_inv[file_id]
197
assert kind == new_ie.kind
199
assert kind in InventoryEntry.known_kinds, \
200
'invalid file kind %r' % kind
202
if kind == 'root_directory':
206
if (not is_inside_any(specific_files, old_inv.id2path(file_id))
207
and not is_inside_any(specific_files, new_inv.id2path(file_id))):
210
# temporary hack until all entries are populated before clients
212
old_path = old_inv.id2path(file_id)
213
new_path = new_inv.id2path(file_id)
214
old_ie._read_tree_state(old_path, old_tree)
215
new_ie._read_tree_state(new_path, new_tree)
216
text_modified, meta_modified = new_ie.detect_changes(old_ie)
218
# TODO: Can possibly avoid calculating path strings if the
219
# two files are unchanged and their names and parents are
220
# the same and the parents are unchanged all the way up.
221
# May not be worthwhile.
223
if (old_ie.name != new_ie.name
224
or old_ie.parent_id != new_ie.parent_id):
225
delta.renamed.append((old_path,
228
text_modified, meta_modified))
229
elif text_modified or meta_modified:
230
delta.modified.append((new_path, file_id, kind,
231
text_modified, meta_modified))
233
delta.unchanged.append((new_path, file_id, kind))
235
kind = old_inv.get_file_kind(file_id)
236
if kind == 'root_directory':
238
old_path = old_inv.id2path(file_id)
240
if not is_inside_any(specific_files, old_path):
242
delta.removed.append((old_path, file_id, kind))
244
mutter('start looking for new files')
245
for file_id in new_inv:
246
if file_id in old_inv or file_id not in new_tree:
248
kind = new_inv.get_file_kind(file_id)
249
if kind == 'root_directory':
251
new_path = new_inv.id2path(file_id)
253
if not is_inside_any(specific_files, new_path):
255
delta.added.append((new_path, file_id, kind))
260
delta.modified.sort()
261
delta.unchanged.sort()
173
class _ChangeReporter(object):
174
"""Report changes between two trees"""
176
def __init__(self, output=None, suppress_root_add=True,
177
output_file=None, unversioned_filter=None, view_info=None,
181
:param output: a function with the signature of trace.note, i.e.
182
accepts a format and parameters.
183
:param supress_root_add: If true, adding the root will be ignored
184
(i.e. when a tree has just been initted)
185
:param output_file: If supplied, a file-like object to write to.
186
Only one of output and output_file may be supplied.
187
:param unversioned_filter: A filter function to be called on
188
unversioned files. This should return True to ignore a path.
189
By default, no filtering takes place.
190
:param view_info: A tuple of view_name,view_files if only
191
items inside a view are to be reported on, or None for
193
:param classify: Add special symbols to indicate file kind.
195
if output_file is not None:
196
if output is not None:
197
raise BzrError('Cannot specify both output and output_file')
199
def output(fmt, *args):
200
output_file.write((fmt % args) + '\n')
202
if self.output is None:
204
self.output = trace.note
205
self.suppress_root_add = suppress_root_add
206
self.modified_map = {'kind changed': 'K',
213
self.versioned_map = {'added': '+', # versioned target
214
'unchanged': ' ', # versioned in both
215
'removed': '-', # versioned in source
216
'unversioned': '?', # versioned in neither
218
self.unversioned_filter = unversioned_filter
220
self.kind_marker = osutils.kind_marker
222
self.kind_marker = lambda kind: ''
223
if view_info is None:
224
self.view_name = None
227
self.view_name = view_info[0]
228
self.view_files = view_info[1]
229
self.output("Operating on whole tree but only reporting on "
230
"'%s' view." % (self.view_name,))
232
def report(self, paths, versioned, renamed, copied, modified, exe_change,
234
"""Report one change to a file
236
:param path: The old and new paths as generated by Tree.iter_changes.
237
:param versioned: may be 'added', 'removed', 'unchanged', or
239
:param renamed: may be True or False
240
:param copied: may be True or False
241
:param modified: may be 'created', 'deleted', 'kind changed',
242
'modified' or 'unchanged'.
243
:param exe_change: True if the execute bit has changed
244
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
245
None indicates no file present.
249
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
251
if self.view_files and not osutils.is_inside_any(self.view_files,
254
if versioned == 'unversioned':
255
# skip ignored unversioned files if needed.
256
if self.unversioned_filter is not None:
257
if self.unversioned_filter(paths[1]):
259
# dont show a content change in the output.
260
modified = 'unchanged'
261
# we show both paths in the following situations:
262
# the file versioning is unchanged AND
263
# ( the path is different OR
264
# the kind is different)
265
if (versioned == 'unchanged' and
266
(renamed or copied or modified == 'kind changed')):
267
if renamed or copied:
268
# on a rename or copy, we show old and new
269
old_path, path = paths
271
# if it's not renamed or copied, we're showing both for kind
272
# changes so only show the new path
273
old_path, path = paths[1], paths[1]
274
# if the file is not missing in the source, we show its kind
275
# when we show two paths.
276
if kind[0] is not None:
277
old_path += self.kind_marker(kind[0])
279
elif versioned == 'removed':
280
# not present in target
291
rename = self.versioned_map[versioned]
292
# we show the old kind on the new path when the content is deleted.
293
if modified == 'deleted':
294
path += self.kind_marker(kind[0])
295
# otherwise we always show the current kind when there is one
296
elif kind[1] is not None:
297
path += self.kind_marker(kind[1])
302
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
306
def report_changes(change_iterator, reporter):
307
"""Report the changes from a change iterator.
309
This is essentially a translation from low-level to medium-level changes.
310
Further processing may be required to produce a human-readable output.
311
Unfortunately, some tree-changing operations are very complex
312
:change_iterator: an iterator or sequence of changes in the format
313
generated by Tree.iter_changes
314
:param reporter: The _ChangeReporter that will report the changes.
316
versioned_change_map = {
317
(True, True): 'unchanged',
318
(True, False): 'removed',
319
(False, True): 'added',
320
(False, False): 'unversioned',
323
def path_key(change):
324
if change.path[0] is not None:
325
path = change.path[0]
327
path = change.path[1]
328
return osutils.splitpath(path)
329
for change in sorted(change_iterator, key=path_key):
331
# files are "renamed" if they are moved or if name changes, as long
333
if None not in change.name and None not in change.parent_id and\
334
(change.name[0] != change.name[1] or change.parent_id[0] != change.parent_id[1]):
344
if change.kind[0] != change.kind[1]:
345
if change.kind[0] is None:
347
elif change.kind[1] is None:
350
modified = "kind changed"
352
if change.changed_content:
353
modified = "modified"
354
elif change.kind[0] is None:
357
modified = "unchanged"
358
if change.kind[1] == "file":
359
exe_change = (change.executable[0] != change.executable[1])
360
versioned_change = versioned_change_map[change.versioned]
361
reporter.report(change.path, versioned_change, renamed, copied, modified,
362
exe_change, change.kind)
365
def report_delta(to_file, delta, short_status=False, show_ids=False,
366
show_unchanged=False, indent='', predicate=None, classify=True):
367
"""Output this delta in status-like form to to_file.
369
:param to_file: A file-like object where the output is displayed.
371
:param delta: A TreeDelta containing the changes to be displayed
373
:param short_status: Single-line status if True.
375
:param show_ids: Output the file ids if True.
377
:param show_unchanged: Output the unchanged files if True.
379
:param indent: Added at the beginning of all output lines (for merged
382
:param predicate: A callable receiving a path returning True if the path
385
:param classify: Add special symbols to indicate file kind.
388
def decorate_path(path, kind, meta_modified=None):
391
if kind == 'directory':
393
elif kind == 'symlink':
399
def show_more_renamed(item):
400
dec_new_path = decorate_path(item.path[1], item.kind[1], item.meta_modified())
401
to_file.write(' => %s' % dec_new_path)
402
if item.changed_content or item.meta_modified():
403
extra_modified.append(TreeChange(
404
item.file_id, (item.path[1], item.path[1]),
405
item.changed_content,
407
(item.parent_id[1], item.parent_id[1]),
408
(item.name[1], item.name[1]),
409
(item.kind[1], item.kind[1]),
412
def show_more_kind_changed(item):
413
to_file.write(' (%s => %s)' % (item.kind[0], item.kind[1]))
415
def show_path(path, kind, meta_modified,
416
default_format, with_file_id_format):
417
dec_path = decorate_path(path, kind, meta_modified)
419
to_file.write(with_file_id_format % dec_path)
421
to_file.write(default_format % dec_path)
423
def show_list(files, long_status_name, short_status_letter,
424
default_format='%s', with_file_id_format='%-30s',
429
prefix = short_status_letter
432
prefix = indent + prefix + ' '
435
if item.path[0] is None:
441
if predicate is not None and not predicate(path):
443
if not header_shown and not short_status:
444
to_file.write(indent + long_status_name + ':\n')
446
to_file.write(prefix)
447
show_path(path, kind, item.meta_modified(),
448
default_format, with_file_id_format)
449
if show_more is not None:
451
if show_ids and getattr(item, 'file_id', None):
452
to_file.write(' %s' % item.file_id.decode('utf-8'))
455
show_list(delta.removed, 'removed', 'D')
456
show_list(delta.added, 'added', 'A')
457
show_list(delta.missing, 'missing', '!')
459
show_list(delta.renamed, 'renamed', 'R', with_file_id_format='%s',
460
show_more=show_more_renamed)
461
show_list(delta.copied, 'copied', 'C', with_file_id_format='%s',
462
show_more=show_more_renamed)
463
show_list(delta.kind_changed, 'kind changed', 'K',
464
with_file_id_format='%s',
465
show_more=show_more_kind_changed)
466
show_list(delta.modified + extra_modified, 'modified', 'M')
468
show_list(delta.unchanged, 'unchanged', 'S')
470
show_list(delta.unversioned, 'unknown', ' ')