87
100
for v in self.renamed:
88
101
if v[2] == file_id:
103
for v in self.kind_changed:
93
def show(self, to_file, show_ids=False, show_unchanged=False):
94
"""output this delta in status-like form to to_file."""
97
path, fid, kind = item[:3]
99
if kind == 'directory':
101
elif kind == 'symlink':
104
if len(item) == 5 and item[4]:
108
print >>to_file, ' %-30s %s' % (path, fid)
110
print >>to_file, ' ', path
113
print >>to_file, 'removed:'
114
show_list(self.removed)
117
print >>to_file, 'added:'
118
show_list(self.added)
123
print >>to_file, 'renamed:'
124
for (oldpath, newpath, fid, kind,
125
text_modified, meta_modified) in self.renamed:
126
if text_modified or meta_modified:
127
extra_modified.append((newpath, fid, kind,
128
text_modified, meta_modified))
132
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
134
print >>to_file, ' %s => %s' % (oldpath, newpath)
136
if self.modified or extra_modified:
137
print >>to_file, 'modified:'
138
show_list(self.modified)
139
show_list(extra_modified)
141
if show_unchanged and self.unchanged:
142
print >>to_file, 'unchanged:'
143
show_list(self.unchanged)
146
def compare_trees(old_tree, new_tree, want_unchanged=False,
147
specific_files=None, extra_trees=None,
148
require_versioned=False):
149
"""Describe changes from one tree to another.
151
Returns a TreeDelta with details of added, modified, renamed, and
154
The root entry is specifically exempt.
156
This only considers versioned files.
159
If true, also list files unchanged from one version to
163
If supplied, only check for changes to specified names or
164
files within them. When mapping filenames to ids, all matches in all
165
trees (including optional extra_trees) are used, and all children of
166
matched directories are included.
169
If non-None, a list of more trees to use for looking up file_ids from
173
If true, an all files are required to be versioned, and
174
PathsNotVersionedError will be thrown if they are not.
176
# NB: show_status depends on being able to pass in non-versioned files and
177
# report them as unknown
182
trees = (new_tree, old_tree)
183
if extra_trees is not None:
184
trees = trees + tuple(extra_trees)
185
specific_file_ids = tree.find_ids_across_trees(specific_files,
186
trees, require_versioned=require_versioned)
187
if specific_files and not specific_file_ids:
188
# All files are unversioned, so just return an empty delta
189
# _compare_trees would think we want a complete delta
191
return _compare_trees(old_tree, new_tree, want_unchanged,
199
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids):
201
from osutils import is_inside_any
203
old_inv = old_tree.inventory
204
new_inv = new_tree.inventory
108
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
111
output = StringIO.StringIO()
112
report_delta(output, self, short_status, show_ids, show_unchanged)
113
return output.getvalue()
116
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
117
include_root, extra_trees=None,
118
require_versioned=False, want_unversioned=False):
119
"""Worker function that implements Tree.changes_from."""
205
120
delta = TreeDelta()
206
mutter('start compare_trees')
208
# TODO: Rather than iterating over the whole tree and then filtering, we
209
# could diff just the specified files (if any) and their subtrees.
211
old_files = old_tree.list_files()
212
new_files = new_tree.list_files()
223
except StopIteration:
224
return None, None, None, None, None
225
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
226
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
229
def check_matching(old_path, old_entry, new_path, new_entry):
230
"""We have matched up 2 file_ids, check for changes."""
231
assert old_entry.kind == new_entry.kind
233
if old_entry.kind == 'root_directory':
236
if specific_file_ids:
237
if (old_entry.file_id not in specific_file_ids and
238
new_entry.file_id not in specific_file_ids):
241
# temporary hack until all entries are populated before clients
243
old_entry._read_tree_state(old_path, old_tree)
244
new_entry._read_tree_state(new_path, new_tree)
245
text_modified, meta_modified = new_entry.detect_changes(old_entry)
247
# If the name changes, or the parent_id changes, we have a rename
248
# (if we move a parent, that doesn't count as a rename for the file)
249
if (old_entry.name != new_entry.name
250
or old_entry.parent_id != new_entry.parent_id):
251
delta.renamed.append((old_path,
253
old_entry.file_id, old_entry.kind,
254
text_modified, meta_modified))
255
elif text_modified or meta_modified:
256
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
257
text_modified, meta_modified))
259
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
262
def handle_old(path, entry):
263
"""old entry without a new entry match
265
Check to see if a matching new entry was already seen as an
266
added file, and switch the pair into being a rename.
267
Otherwise just mark the old entry being removed.
269
if entry.file_id in added:
270
# Actually this is a rename, we found a new file_id earlier
271
# at a different location, so it is no-longer added
272
x_new_path, x_new_entry = added.pop(entry.file_id)
273
check_matching(path, entry, x_new_path, x_new_entry)
275
# We have an old_file_id which doesn't line up with a new_file_id
276
# So this file looks to be removed
277
assert entry.file_id not in removed
278
removed[entry.file_id] = path, entry
280
def handle_new(path, entry):
281
"""new entry without an old entry match
283
Check to see if a matching old entry was already seen as a
284
removal, and change the pair into a rename.
285
Otherwise just mark the new entry as an added file.
287
if entry.file_id in removed:
288
# We saw this file_id earlier at an old different location
289
# it is no longer removed, just renamed
290
x_old_path, x_old_entry = removed.pop(entry.file_id)
291
check_matching(x_old_path, x_old_entry, path, entry)
293
# We have a new file which does not match an old file
295
assert entry.file_id not in added
296
added[entry.file_id] = path, entry
298
while old_path or new_path:
299
# list_files() returns files in alphabetical path sorted order
300
if old_path == new_path:
301
if old_file_id == new_file_id:
302
# This is the common case, the files are in the same place
303
# check if there were any content changes
305
if old_file_id is None:
306
# We have 2 unversioned files, no deltas possible???
309
check_matching(old_path, old_entry, new_path, new_entry)
121
# mutter('start compare_trees')
123
for (file_id, path, content_change, versioned, parent_id, name, kind,
124
executable) in new_tree.iter_changes(old_tree, want_unchanged,
125
specific_files, extra_trees=extra_trees,
126
require_versioned=require_versioned,
127
want_unversioned=want_unversioned):
128
if versioned == (False, False):
129
delta.unversioned.append((path[1], None, kind[1]))
131
if not include_root and (None, None) == parent_id:
133
fully_present = tuple((versioned[x] and kind[x] is not None) for
135
if fully_present[0] != fully_present[1]:
136
if fully_present[1] is True:
137
delta.added.append((path[1], file_id, kind[1]))
311
# The ids don't match, so we have to handle them both
313
if old_file_id is not None:
314
handle_old(old_path, old_entry)
316
if new_file_id is not None:
317
handle_new(new_path, new_entry)
319
# The two entries were at the same path, so increment both sides
320
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
321
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
322
elif new_path is None or (old_path is not None and old_path < new_path):
323
# Assume we don't match, only process old_path
324
if old_file_id is not None:
325
handle_old(old_path, old_entry)
326
# old_path came first, so increment it, trying to match up
327
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
328
elif new_path is not None:
329
# new_path came first, so increment it, trying to match up
330
if new_file_id is not None:
331
handle_new(new_path, new_entry)
332
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
334
# Now we have a set of added and removed files, mark them all
335
for old_path, old_entry in removed.itervalues():
336
if specific_file_ids:
337
if not old_entry.file_id in specific_file_ids:
339
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
340
for new_path, new_entry in added.itervalues():
341
if specific_file_ids:
342
if not new_entry.file_id in specific_file_ids:
344
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
139
delta.removed.append((path[0], file_id, kind[0]))
140
elif fully_present[0] is False:
141
delta.missing.append((path[1], file_id, kind[1]))
142
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
143
# If the name changes, or the parent_id changes, we have a rename
144
# (if we move a parent, that doesn't count as a rename for the
146
delta.renamed.append((path[0],
151
(executable[0] != executable[1])))
152
elif kind[0] != kind[1]:
153
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
154
elif content_change or executable[0] != executable[1]:
155
delta.modified.append((path[1], file_id, kind[1],
157
(executable[0] != executable[1])))
159
delta.unchanged.append((path[1], file_id, kind[1]))
346
161
delta.removed.sort()
347
162
delta.added.sort()
348
163
delta.renamed.sort()
349
165
# TODO: jam 20060529 These lists shouldn't need to be sorted
350
166
# since we added them in alphabetical order.
351
167
delta.modified.sort()
352
168
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')
198
def output(fmt, *args):
199
output_file.write((fmt % args) + '\n')
201
if self.output is None:
202
from bzrlib import trace
203
self.output = trace.note
204
self.suppress_root_add = suppress_root_add
205
self.modified_map = {'kind changed': 'K',
212
self.versioned_map = {'added': '+', # versioned target
213
'unchanged': ' ', # versioned in both
214
'removed': '-', # versioned in source
215
'unversioned': '?', # versioned in neither
217
self.unversioned_filter = unversioned_filter
219
self.kind_marker = osutils.kind_marker
221
self.kind_marker = lambda kind: ''
222
if view_info is None:
223
self.view_name = None
226
self.view_name = view_info[0]
227
self.view_files = view_info[1]
228
self.output("Operating on whole tree but only reporting on "
229
"'%s' view." % (self.view_name,))
231
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
233
"""Report one change to a file
235
:param file_id: The file_id of the 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 modified: may be 'created', 'deleted', 'kind changed',
241
'modified' or 'unchanged'.
242
:param exe_change: True if the execute bit has changed
243
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
244
None indicates no file present.
248
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
250
if self.view_files and not osutils.is_inside_any(self.view_files,
253
if versioned == 'unversioned':
254
# skip ignored unversioned files if needed.
255
if self.unversioned_filter is not None:
256
if self.unversioned_filter(paths[1]):
258
# dont show a content change in the output.
259
modified = 'unchanged'
260
# we show both paths in the following situations:
261
# the file versioning is unchanged AND
262
# ( the path is different OR
263
# the kind is different)
264
if (versioned == 'unchanged' and
265
(renamed or modified == 'kind changed')):
267
# on a rename, we show old and new
268
old_path, path = paths
270
# if it's not renamed, we're showing both for kind changes
271
# so only show the new path
272
old_path, path = paths[1], paths[1]
273
# if the file is not missing in the source, we show its kind
274
# when we show two paths.
275
if kind[0] is not None:
276
old_path += self.kind_marker(kind[0])
278
elif versioned == 'removed':
279
# not present in target
288
rename = self.versioned_map[versioned]
289
# we show the old kind on the new path when the content is deleted.
290
if modified == 'deleted':
291
path += self.kind_marker(kind[0])
292
# otherwise we always show the current kind when there is one
293
elif kind[1] is not None:
294
path += self.kind_marker(kind[1])
299
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
302
def report_changes(change_iterator, reporter):
303
"""Report the changes from a change iterator.
305
This is essentially a translation from low-level to medium-level changes.
306
Further processing may be required to produce a human-readable output.
307
Unfortunately, some tree-changing operations are very complex
308
:change_iterator: an iterator or sequence of changes in the format
309
generated by Tree.iter_changes
310
:param reporter: The _ChangeReporter that will report the changes.
312
versioned_change_map = {
313
(True, True) : 'unchanged',
314
(True, False) : 'removed',
315
(False, True) : 'added',
316
(False, False): 'unversioned',
318
for (file_id, path, content_change, versioned, parent_id, name, kind,
319
executable) in change_iterator:
321
# files are "renamed" if they are moved or if name changes, as long
323
if None not in name and None not in parent_id and\
324
(name[0] != name[1] or parent_id[0] != parent_id[1]):
328
if kind[0] != kind[1]:
331
elif kind[1] is None:
334
modified = "kind changed"
337
modified = "modified"
338
elif kind[0] is None:
341
modified = "unchanged"
342
if kind[1] == "file":
343
exe_change = (executable[0] != executable[1])
344
versioned_change = versioned_change_map[versioned]
345
reporter.report(file_id, path, versioned_change, renamed, modified,
348
def report_delta(to_file, delta, short_status=False, show_ids=False,
349
show_unchanged=False, indent='', filter=None, classify=True):
350
"""Output this delta in status-like form to to_file.
352
:param to_file: A file-like object where the output is displayed.
354
:param delta: A TreeDelta containing the changes to be displayed
356
:param short_status: Single-line status if True.
358
:param show_ids: Output the file ids if True.
360
:param show_unchanged: Output the unchanged files if True.
362
:param indent: Added at the beginning of all output lines (for merged
365
:param filter: A callable receiving a path and a file id and
366
returning True if the path should be displayed.
368
:param classify: Add special symbols to indicate file kind.
371
def decorate_path(path, kind, meta_modified=None):
374
if kind == 'directory':
376
elif kind == 'symlink':
382
def show_more_renamed(item):
383
(oldpath, file_id, kind,
384
text_modified, meta_modified, newpath) = item
385
dec_new_path = decorate_path(newpath, kind, meta_modified)
386
to_file.write(' => %s' % dec_new_path)
387
if text_modified or meta_modified:
388
extra_modified.append((newpath, file_id, kind,
389
text_modified, meta_modified))
391
def show_more_kind_changed(item):
392
(path, file_id, old_kind, new_kind) = item
393
to_file.write(' (%s => %s)' % (old_kind, new_kind))
395
def show_path(path, file_id, kind, meta_modified,
396
default_format, with_file_id_format):
397
dec_path = decorate_path(path, kind, meta_modified)
399
to_file.write(with_file_id_format % dec_path)
401
to_file.write(default_format % dec_path)
403
def show_list(files, long_status_name, short_status_letter,
404
default_format='%s', with_file_id_format='%-30s',
409
prefix = short_status_letter
412
prefix = indent + prefix + ' '
415
path, file_id, kind = item[:3]
416
if (filter is not None and not filter(path, file_id)):
418
if not header_shown and not short_status:
419
to_file.write(indent + long_status_name + ':\n')
423
meta_modified = item[4]
425
to_file.write(prefix)
426
show_path(path, file_id, kind, meta_modified,
427
default_format, with_file_id_format)
428
if show_more is not None:
431
to_file.write(' %s' % file_id)
434
show_list(delta.removed, 'removed', 'D')
435
show_list(delta.added, 'added', 'A')
436
show_list(delta.missing, 'missing', '!')
438
# Reorder delta.renamed tuples so that all lists share the same
439
# order for their 3 first fields and that they also begin like
440
# the delta.modified tuples
441
renamed = [(p, i, k, tm, mm, np)
442
for p, np, i, k, tm, mm in delta.renamed]
443
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
444
show_more=show_more_renamed)
445
show_list(delta.kind_changed, 'kind changed', 'K',
446
with_file_id_format='%s',
447
show_more=show_more_kind_changed)
448
show_list(delta.modified + extra_modified, 'modified', 'M')
450
show_list(delta.unchanged, 'unchanged', 'S')
452
show_list(delta.unversioned, 'unknown', ' ')
added
removed
bzrlib/delta.py
