87
102
for v in self.renamed:
88
103
if v[2] == file_id:
105
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
return _compare_trees(old_tree, new_tree, want_unchanged,
195
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids):
197
from osutils import is_inside_any
199
old_inv = old_tree.inventory
200
new_inv = new_tree.inventory
110
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
113
output = StringIO.StringIO()
114
report_delta(output, self, short_status, show_ids, show_unchanged)
115
return output.getvalue()
118
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
119
include_root, extra_trees=None,
120
require_versioned=False, want_unversioned=False):
121
"""Worker function that implements Tree.changes_from."""
201
122
delta = TreeDelta()
202
mutter('start compare_trees')
204
# TODO: Rather than iterating over the whole tree and then filtering, we
205
# could diff just the specified files (if any) and their subtrees.
207
old_files = old_tree.list_files()
208
new_files = new_tree.list_files()
219
except StopIteration:
220
return None, None, None, None, None
221
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
222
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
225
def check_matching(old_path, old_entry, new_path, new_entry):
226
"""We have matched up 2 file_ids, check for changes."""
227
assert old_entry.kind == new_entry.kind
229
if old_entry.kind == 'root_directory':
232
if specific_file_ids:
233
if (old_file_id not in specific_file_ids and
234
new_file_id not in specific_file_ids):
237
# temporary hack until all entries are populated before clients
239
old_entry._read_tree_state(old_path, old_tree)
240
new_entry._read_tree_state(new_path, new_tree)
241
text_modified, meta_modified = new_entry.detect_changes(old_entry)
243
# If the name changes, or the parent_id changes, we have a rename
244
# (if we move a parent, that doesn't count as a rename for the file)
245
if (old_entry.name != new_entry.name
246
or old_entry.parent_id != new_entry.parent_id):
247
delta.renamed.append((old_path,
249
old_entry.file_id, old_entry.kind,
250
text_modified, meta_modified))
251
elif text_modified or meta_modified:
252
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
253
text_modified, meta_modified))
255
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
258
def handle_old(path, entry):
259
"""old entry without a new entry match
261
Check to see if a matching new entry was already seen as an
262
added file, and switch the pair into being a rename.
263
Otherwise just mark the old entry being removed.
265
if entry.file_id in added:
266
# Actually this is a rename, we found a new file_id earlier
267
# at a different location, so it is no-longer added
268
x_new_path, x_new_entry = added.pop(entry.file_id)
269
check_matching(path, entry, x_new_path, x_new_entry)
271
# We have an old_file_id which doesn't line up with a new_file_id
272
# So this file looks to be removed
273
assert entry.file_id not in removed
274
removed[entry.file_id] = path, entry
276
def handle_new(path, entry):
277
"""new entry without an old entry match
279
Check to see if a matching old entry was already seen as a
280
removal, and change the pair into a rename.
281
Otherwise just mark the new entry as an added file.
283
if entry.file_id in removed:
284
# We saw this file_id earlier at an old different location
285
# it is no longer removed, just renamed
286
x_old_path, x_old_entry = removed.pop(entry.file_id)
287
check_matching(x_old_path, x_old_entry, path, entry)
289
# We have a new file which does not match an old file
291
assert entry.file_id not in added
292
added[entry.file_id] = path, entry
294
while old_path or new_path:
295
# list_files() returns files in alphabetical path sorted order
296
if old_path == new_path:
297
if old_file_id == new_file_id:
298
# This is the common case, the files are in the same place
299
# check if there were any content changes
301
if old_file_id is None:
302
# We have 2 unversioned files, no deltas possible???
305
check_matching(old_path, old_entry, new_path, new_entry)
123
# mutter('start compare_trees')
125
for (file_id, path, content_change, versioned, parent_id, name, kind,
126
executable) in new_tree.iter_changes(old_tree, want_unchanged,
127
specific_files, extra_trees=extra_trees,
128
require_versioned=require_versioned,
129
want_unversioned=want_unversioned):
130
if versioned == (False, False):
131
delta.unversioned.append((path[1], None, kind[1]))
133
if not include_root and (None, None) == parent_id:
135
fully_present = tuple((versioned[x] and kind[x] is not None) for
137
if fully_present[0] != fully_present[1]:
138
if fully_present[1] is True:
139
delta.added.append((path[1], file_id, kind[1]))
307
# The ids don't match, so we have to handle them both
309
if old_file_id is not None:
310
handle_old(old_path, old_entry)
312
if new_file_id is not None:
313
handle_new(new_path, new_entry)
315
# The two entries were at the same path, so increment both sides
316
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
317
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
318
elif new_path is None or (old_path is not None and old_path < new_path):
319
# Assume we don't match, only process old_path
320
if old_file_id is not None:
321
handle_old(old_path, old_entry)
322
# old_path came first, so increment it, trying to match up
323
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
324
elif new_path is not None:
325
# new_path came first, so increment it, trying to match up
326
if new_file_id is not None:
327
handle_new(new_path, new_entry)
328
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
330
# Now we have a set of added and removed files, mark them all
331
for old_path, old_entry in removed.itervalues():
332
if specific_file_ids:
333
if not old_entry.file_id in specific_file_ids:
335
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
336
for new_path, new_entry in added.itervalues():
337
if specific_file_ids:
338
if not new_entry.file_id in specific_file_ids:
340
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
141
delta.removed.append((path[0], file_id, kind[0]))
142
elif fully_present[0] is False:
143
delta.missing.append((path[1], file_id, kind[1]))
144
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
145
# If the name changes, or the parent_id changes, we have a rename
146
# (if we move a parent, that doesn't count as a rename for the
148
delta.renamed.append((path[0],
153
(executable[0] != executable[1])))
154
elif kind[0] != kind[1]:
155
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
156
elif content_change or executable[0] != executable[1]:
157
delta.modified.append((path[1], file_id, kind[1],
159
(executable[0] != executable[1])))
161
delta.unchanged.append((path[1], file_id, kind[1]))
342
163
delta.removed.sort()
343
164
delta.added.sort()
344
165
delta.renamed.sort()
345
167
# TODO: jam 20060529 These lists shouldn't need to be sorted
346
168
# since we added them in alphabetical order.
347
169
delta.modified.sort()
348
170
delta.unchanged.sort()
175
class _ChangeReporter(object):
176
"""Report changes between two trees"""
178
def __init__(self, output=None, suppress_root_add=True,
179
output_file=None, unversioned_filter=None, view_info=None,
183
:param output: a function with the signature of trace.note, i.e.
184
accepts a format and parameters.
185
:param supress_root_add: If true, adding the root will be ignored
186
(i.e. when a tree has just been initted)
187
:param output_file: If supplied, a file-like object to write to.
188
Only one of output and output_file may be supplied.
189
:param unversioned_filter: A filter function to be called on
190
unversioned files. This should return True to ignore a path.
191
By default, no filtering takes place.
192
:param view_info: A tuple of view_name,view_files if only
193
items inside a view are to be reported on, or None for
195
:param classify: Add special symbols to indicate file kind.
197
if output_file is not None:
198
if output is not None:
199
raise BzrError('Cannot specify both output and output_file')
200
def output(fmt, *args):
201
output_file.write((fmt % args) + '\n')
203
if self.output is None:
204
from bzrlib import trace
205
self.output = trace.note
206
self.suppress_root_add = suppress_root_add
207
self.modified_map = {'kind changed': 'K',
214
self.versioned_map = {'added': '+', # versioned target
215
'unchanged': ' ', # versioned in both
216
'removed': '-', # versioned in source
217
'unversioned': '?', # versioned in neither
219
self.unversioned_filter = unversioned_filter
221
self.kind_marker = osutils.kind_marker
223
self.kind_marker = lambda kind: ''
224
if view_info is None:
225
self.view_name = None
228
self.view_name = view_info[0]
229
self.view_files = view_info[1]
230
self.output("Operating on whole tree but only reporting on "
231
"'%s' view." % (self.view_name,))
233
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
235
"""Report one change to a file
237
:param file_id: The file_id of the file
238
:param path: The old and new paths as generated by Tree.iter_changes.
239
:param versioned: may be 'added', 'removed', 'unchanged', or
241
:param renamed: may be True or False
242
:param modified: may be 'created', 'deleted', 'kind changed',
243
'modified' or 'unchanged'.
244
:param exe_change: True if the execute bit has changed
245
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
246
None indicates no file present.
250
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
252
if self.view_files and not osutils.is_inside_any(self.view_files,
255
if versioned == 'unversioned':
256
# skip ignored unversioned files if needed.
257
if self.unversioned_filter is not None:
258
if self.unversioned_filter(paths[1]):
260
# dont show a content change in the output.
261
modified = 'unchanged'
262
# we show both paths in the following situations:
263
# the file versioning is unchanged AND
264
# ( the path is different OR
265
# the kind is different)
266
if (versioned == 'unchanged' and
267
(renamed or modified == 'kind changed')):
269
# on a rename, we show old and new
270
old_path, path = paths
272
# if it's not renamed, we're showing both for kind changes
273
# so only show the new path
274
old_path, path = paths[1], paths[1]
275
# if the file is not missing in the source, we show its kind
276
# when we show two paths.
277
if kind[0] is not None:
278
old_path += self.kind_marker(kind[0])
280
elif versioned == 'removed':
281
# not present in target
290
rename = self.versioned_map[versioned]
291
# we show the old kind on the new path when the content is deleted.
292
if modified == 'deleted':
293
path += self.kind_marker(kind[0])
294
# otherwise we always show the current kind when there is one
295
elif kind[1] is not None:
296
path += self.kind_marker(kind[1])
301
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
304
def report_changes(change_iterator, reporter):
305
"""Report the changes from a change iterator.
307
This is essentially a translation from low-level to medium-level changes.
308
Further processing may be required to produce a human-readable output.
309
Unfortunately, some tree-changing operations are very complex
310
:change_iterator: an iterator or sequence of changes in the format
311
generated by Tree.iter_changes
312
:param reporter: The _ChangeReporter that will report the changes.
314
versioned_change_map = {
315
(True, True) : 'unchanged',
316
(True, False) : 'removed',
317
(False, True) : 'added',
318
(False, False): 'unversioned',
320
for (file_id, path, content_change, versioned, parent_id, name, kind,
321
executable) in change_iterator:
323
# files are "renamed" if they are moved or if name changes, as long
325
if None not in name and None not in parent_id and\
326
(name[0] != name[1] or parent_id[0] != parent_id[1]):
330
if kind[0] != kind[1]:
333
elif kind[1] is None:
336
modified = "kind changed"
339
modified = "modified"
340
elif kind[0] is None:
343
modified = "unchanged"
344
if kind[1] == "file":
345
exe_change = (executable[0] != executable[1])
346
versioned_change = versioned_change_map[versioned]
347
reporter.report(file_id, path, versioned_change, renamed, modified,
350
def report_delta(to_file, delta, short_status=False, show_ids=False,
351
show_unchanged=False, indent='', filter=None, classify=True):
352
"""Output this delta in status-like form to to_file.
354
:param to_file: A file-like object where the output is displayed.
356
:param delta: A TreeDelta containing the changes to be displayed
358
:param short_status: Single-line status if True.
360
:param show_ids: Output the file ids if True.
362
:param show_unchanged: Output the unchanged files if True.
364
:param indent: Added at the beginning of all output lines (for merged
367
:param filter: A callable receiving a path and a file id and
368
returning True if the path should be displayed.
370
:param classify: Add special symbols to indicate file kind.
373
def decorate_path(path, kind, meta_modified=None):
376
if kind == 'directory':
378
elif kind == 'symlink':
384
def show_more_renamed(item):
385
(oldpath, file_id, kind,
386
text_modified, meta_modified, newpath) = item
387
dec_new_path = decorate_path(newpath, kind, meta_modified)
388
to_file.write(' => %s' % dec_new_path)
389
if text_modified or meta_modified:
390
extra_modified.append((newpath, file_id, kind,
391
text_modified, meta_modified))
393
def show_more_kind_changed(item):
394
(path, file_id, old_kind, new_kind) = item
395
to_file.write(' (%s => %s)' % (old_kind, new_kind))
397
def show_path(path, file_id, kind, meta_modified,
398
default_format, with_file_id_format):
399
dec_path = decorate_path(path, kind, meta_modified)
401
to_file.write(with_file_id_format % dec_path)
403
to_file.write(default_format % dec_path)
405
def show_list(files, long_status_name, short_status_letter,
406
default_format='%s', with_file_id_format='%-30s',
411
prefix = short_status_letter
414
prefix = indent + prefix + ' '
417
path, file_id, kind = item[:3]
418
if (filter is not None and not filter(path, file_id)):
420
if not header_shown and not short_status:
421
to_file.write(indent + long_status_name + ':\n')
425
meta_modified = item[4]
427
to_file.write(prefix)
428
show_path(path, file_id, kind, meta_modified,
429
default_format, with_file_id_format)
430
if show_more is not None:
433
to_file.write(' %s' % file_id)
436
show_list(delta.removed, 'removed', 'D')
437
show_list(delta.added, 'added', 'A')
438
show_list(delta.missing, 'missing', '!')
440
# Reorder delta.renamed tuples so that all lists share the same
441
# order for their 3 first fields and that they also begin like
442
# the delta.modified tuples
443
renamed = [(p, i, k, tm, mm, np)
444
for p, np, i, k, tm, mm in delta.renamed]
445
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
446
show_more=show_more_renamed)
447
show_list(delta.kind_changed, 'kind changed', 'K',
448
with_file_id_format='%s',
449
show_more=show_more_kind_changed)
450
show_list(delta.modified + extra_modified, 'modified', 'M')
452
show_list(delta.unchanged, 'unchanged', 'S')
454
show_list(delta.unversioned, 'unknown', ' ')
added
removed
bzrlib/delta.py
