« back to all changes in this revision
Viewing changes to bzrlib/diff.py
- browse files at revision 254
- compare with another revision
- download diff
- download tarball
- view history from revision 254
- Committer: Martin Pool
- Date: 2005-04-15 01:31:21 UTC
- Revision ID: mbp@sourcefrog.net-20050415013121-b18f1be12a735066
- Doc cleanups from Magnus Therning
- files added:
- bzrlib/tests.py
- files removed:
- TODO
- bzrlib/selftest
- contrib
- contrib/bash
- contrib/zsh
- effbot
- effbot/org
- patches
- plugins
- plugins/changeset
- plugins/rsync
- files modified:
- .bzrignore
added
removed
bzrlib/diff.py
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
18
from sets import Set
19
18
20
from trace import mutter
19
from errors import BzrError
20
21
22
# TODO: Rather than building a changeset object, we should probably
23
# invoke callbacks on an object. That object can either accumulate a
24
# list, write them out directly, etc etc.
25
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
import difflib
28
29
# FIXME: difflib is wrong if there is no trailing newline.
30
# The syntax used by patch seems to be "\ No newline at
31
# end of file" following the last diff line from that
32
# file. This is not trivial to insert into the
33
# unified_diff output and it might be better to just fix
34
# or replace that function.
35
36
# In the meantime we at least make sure the patch isn't
37
# mangled.
38
39
40
# Special workaround for Python2.3, where difflib fails if
41
# both sequences are empty.
42
if not oldlines and not newlines:
43
return
44
45
nonl = False
46
47
if oldlines and (oldlines[-1][-1] != '\n'):
48
oldlines[-1] += '\n'
49
nonl = True
50
if newlines and (newlines[-1][-1] != '\n'):
51
newlines[-1] += '\n'
52
nonl = True
53
54
ud = difflib.unified_diff(oldlines, newlines,
55
fromfile=old_label, tofile=new_label)
56
57
# work-around for difflib being too smart for its own good
58
# if /dev/null is "1,0", patch won't recognize it as /dev/null
59
if not oldlines:
60
ud = list(ud)
61
ud[2] = ud[2].replace('-1,0', '-0,0')
62
elif not newlines:
63
ud = list(ud)
64
ud[2] = ud[2].replace('+1,0', '+0,0')
65
66
for line in ud:
67
to_file.write(line)
68
if nonl:
69
print >>to_file, "\\ No newline at end of file"
70
print >>to_file
71
72
73
74
75
def external_diff(old_label, oldlines, new_label, newlines, to_file,
76
diff_opts):
77
"""Display a diff by calling out to the external diff program."""
78
import sys
79
80
if to_file != sys.stdout:
81
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
82
to_file)
83
84
# make sure our own output is properly ordered before the diff
85
to_file.flush()
86
87
from tempfile import NamedTemporaryFile
88
import os
89
90
oldtmpf = NamedTemporaryFile()
91
newtmpf = NamedTemporaryFile()
92
93
try:
94
# TODO: perhaps a special case for comparing to or from the empty
95
# sequence; can just use /dev/null on Unix
96
97
# TODO: if either of the files being compared already exists as a
98
# regular named file (e.g. in the working directory) then we can
99
# compare directly to that, rather than copying it.
100
101
oldtmpf.writelines(oldlines)
102
newtmpf.writelines(newlines)
103
104
oldtmpf.flush()
105
newtmpf.flush()
106
107
if not diff_opts:
108
diff_opts = []
109
diffcmd = ['diff',
110
'--label', old_label,
111
oldtmpf.name,
112
'--label', new_label,
113
newtmpf.name]
114
115
# diff only allows one style to be specified; they don't override.
116
# note that some of these take optargs, and the optargs can be
117
# directly appended to the options.
118
# this is only an approximate parser; it doesn't properly understand
119
# the grammar.
120
for s in ['-c', '-u', '-C', '-U',
121
'-e', '--ed',
122
'-q', '--brief',
123
'--normal',
124
'-n', '--rcs',
125
'-y', '--side-by-side',
126
'-D', '--ifdef']:
127
for j in diff_opts:
128
if j.startswith(s):
129
break
130
else:
131
continue
132
break
133
else:
134
diffcmd.append('-u')
135
136
if diff_opts:
137
diffcmd.extend(diff_opts)
138
139
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
140
141
if rc != 0 and rc != 1:
142
# returns 1 if files differ; that's OK
143
if rc < 0:
144
msg = 'signal %d' % (-rc)
145
else:
146
msg = 'exit code %d' % rc
147
148
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
149
finally:
150
oldtmpf.close() # and delete
151
newtmpf.close()
152
153
154
155
def show_diff(b, revision, specific_files, external_diff_options=None):
156
"""Shortcut for showing the diff to the working tree.
157
158
b
159
Branch.
160
161
revision
162
None for each, or otherwise the old revision to compare against.
163
164
The more general form is show_diff_trees(), where the caller
165
supplies any two trees.
166
"""
167
import sys
168
169
if revision == None:
170
old_tree = b.basis_tree()
171
else:
172
old_tree = b.revision_tree(b.lookup_revision(revision))
173
174
new_tree = b.working_tree()
175
176
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
177
external_diff_options)
178
179
180
181
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
182
external_diff_options=None):
183
"""Show in text form the changes from one tree to another.
184
185
to_files
186
If set, include only changes to these files.
187
188
external_diff_options
189
If set, use an external GNU diff and pass these options.
190
"""
191
192
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
193
old_label = ''
194
new_label = ''
195
196
DEVNULL = '/dev/null'
197
# Windows users, don't panic about this filename -- it is a
198
# special signal to GNU patch that the file should be created or
199
# deleted respectively.
200
201
# TODO: Generation of pseudo-diffs for added/deleted files could
202
# be usefully made into a much faster special case.
203
204
if external_diff_options:
205
assert isinstance(external_diff_options, basestring)
206
opts = external_diff_options.split()
207
def diff_file(olab, olines, nlab, nlines, to_file):
208
external_diff(olab, olines, nlab, nlines, to_file, opts)
209
else:
210
diff_file = internal_diff
211
212
213
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
214
specific_files=specific_files)
215
216
for path, file_id, kind in delta.removed:
217
print >>to_file, '*** removed %s %r' % (kind, path)
218
if kind == 'file':
219
diff_file(old_label + path,
220
old_tree.get_file(file_id).readlines(),
221
DEVNULL,
222
[],
223
to_file)
224
225
for path, file_id, kind in delta.added:
226
print >>to_file, '*** added %s %r' % (kind, path)
227
if kind == 'file':
228
diff_file(DEVNULL,
229
[],
230
new_label + path,
231
new_tree.get_file(file_id).readlines(),
232
to_file)
233
234
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
235
print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
236
if text_modified:
237
diff_file(old_label + old_path,
238
old_tree.get_file(file_id).readlines(),
239
new_label + new_path,
240
new_tree.get_file(file_id).readlines(),
241
to_file)
242
243
for path, file_id, kind in delta.modified:
244
print >>to_file, '*** modified %s %r' % (kind, path)
245
if kind == 'file':
246
diff_file(old_label + path,
247
old_tree.get_file(file_id).readlines(),
248
new_label + path,
249
new_tree.get_file(file_id).readlines(),
250
to_file)
251
252
253
254
class TreeDelta(object):
255
"""Describes changes from one tree to another.
256
257
Contains four lists:
258
259
added
260
(path, id, kind)
261
removed
262
(path, id, kind)
263
renamed
264
(oldpath, newpath, id, kind, text_modified)
265
modified
266
(path, id, kind)
267
unchanged
268
(path, id, kind)
269
270
Each id is listed only once.
271
272
Files that are both modified and renamed are listed only in
273
renamed, with the text_modified flag true.
274
275
Files are only considered renamed if their name has changed or
276
their parent directory has changed. Renaming a directory
277
does not count as renaming all its contents.
278
279
The lists are normally sorted when the delta is created.
280
"""
281
def __init__(self):
282
self.added = []
283
self.removed = []
284
self.renamed = []
285
self.modified = []
286
self.unchanged = []
287
288
def __eq__(self, other):
289
if not isinstance(other, TreeDelta):
290
return False
291
return self.added == other.added \
292
and self.removed == other.removed \
293
and self.renamed == other.renamed \
294
and self.modified == other.modified \
295
and self.unchanged == other.unchanged
296
297
def __ne__(self, other):
298
return not (self == other)
299
300
def __repr__(self):
301
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
302
" unchanged=%r)" % (self.added, self.removed, self.renamed,
303
self.modified, self.unchanged)
304
305
def has_changed(self):
306
changes = len(self.added) + len(self.removed) + len(self.renamed)
307
changes += len(self.modified)
308
return (changes != 0)
309
310
def touches_file_id(self, file_id):
311
"""Return True if file_id is modified by this delta."""
312
for l in self.added, self.removed, self.modified:
313
for v in l:
314
if v[1] == file_id:
315
return True
316
for v in self.renamed:
317
if v[2] == file_id:
318
return True
319
return False
320
321
322
def show(self, to_file, show_ids=False, show_unchanged=False):
323
def show_list(files):
324
for path, fid, kind in files:
325
if kind == 'directory':
326
path += '/'
327
elif kind == 'symlink':
328
path += '@'
329
330
if show_ids:
331
print >>to_file, ' %-30s %s' % (path, fid)
332
else:
333
print >>to_file, ' ', path
334
335
if self.removed:
336
print >>to_file, 'removed:'
337
show_list(self.removed)
338
339
if self.added:
340
print >>to_file, 'added:'
341
show_list(self.added)
342
343
if self.renamed:
344
print >>to_file, 'renamed:'
345
for oldpath, newpath, fid, kind, text_modified in self.renamed:
346
if show_ids:
347
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
348
else:
349
print >>to_file, ' %s => %s' % (oldpath, newpath)
350
351
if self.modified:
352
print >>to_file, 'modified:'
353
show_list(self.modified)
354
355
if show_unchanged and self.unchanged:
356
print >>to_file, 'unchanged:'
357
show_list(self.unchanged)
358
359
360
361
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
362
"""Describe changes from one tree to another.
363
364
Returns a TreeDelta with details of added, modified, renamed, and
365
deleted entries.
366
367
The root entry is specifically exempt.
368
369
This only considers versioned files.
370
371
want_unchanged
372
If true, also list files unchanged from one version to
373
the next.
374
375
specific_files
376
If true, only check for changes to specified names or
377
files within them.
378
"""
379
380
from osutils import is_inside_any
381
382
old_inv = old_tree.inventory
383
new_inv = new_tree.inventory
384
delta = TreeDelta()
385
mutter('start compare_trees')
386
387
# TODO: match for specific files can be rather smarter by finding
388
# the IDs of those files up front and then considering only that.
389
390
for file_id in old_tree:
391
if file_id in new_tree:
392
kind = old_inv.get_file_kind(file_id)
393
assert kind == new_inv.get_file_kind(file_id)
394
395
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
396
'invalid file kind %r' % kind
397
398
if kind == 'root_directory':
399
continue
400
401
old_path = old_inv.id2path(file_id)
402
new_path = new_inv.id2path(file_id)
403
404
old_ie = old_inv[file_id]
405
new_ie = new_inv[file_id]
406
407
if specific_files:
408
if (not is_inside_any(specific_files, old_path)
409
and not is_inside_any(specific_files, new_path)):
410
continue
411
412
if kind == 'file':
413
old_sha1 = old_tree.get_file_sha1(file_id)
414
new_sha1 = new_tree.get_file_sha1(file_id)
415
text_modified = (old_sha1 != new_sha1)
416
else:
417
## mutter("no text to check for %r %r" % (file_id, kind))
418
text_modified = False
419
420
# TODO: Can possibly avoid calculating path strings if the
421
# two files are unchanged and their names and parents are
422
# the same and the parents are unchanged all the way up.
423
# May not be worthwhile.
424
425
if (old_ie.name != new_ie.name
426
or old_ie.parent_id != new_ie.parent_id):
427
delta.renamed.append((old_path, new_path, file_id, kind,
428
text_modified))
429
elif text_modified:
430
delta.modified.append((new_path, file_id, kind))
431
elif want_unchanged:
432
delta.unchanged.append((new_path, file_id, kind))
433
else:
434
kind = old_inv.get_file_kind(file_id)
435
old_path = old_inv.id2path(file_id)
436
if specific_files:
437
if not is_inside_any(specific_files, old_path):
438
continue
439
delta.removed.append((old_path, file_id, kind))
440
441
mutter('start looking for new files')
442
for file_id in new_inv:
443
if file_id in old_inv:
444
continue
445
new_path = new_inv.id2path(file_id)
446
if specific_files:
447
if not is_inside_any(specific_files, new_path):
448
continue
449
kind = new_inv.get_file_kind(file_id)
450
delta.added.append((new_path, file_id, kind))
451
452
delta.removed.sort()
453
delta.added.sort()
454
delta.renamed.sort()
455
delta.modified.sort()
456
delta.unchanged.sort()
457
458
return delta
21
22
23
24
25
26
27
def diff_trees(old_tree, new_tree):
28
"""Compute diff between two trees.
29
30
They may be in different branches and may be working or historical
31
trees.
32
33
Yields a sequence of (state, id, old_name, new_name, kind).
34
Each filename and each id is listed only once.
35
"""
36
37
## TODO: Compare files before diffing; only mention those that have changed
38
39
## TODO: Set nice names in the headers, maybe include diffstat
40
41
## TODO: Perhaps make this a generator rather than using
42
## a callback object?
43
44
## TODO: Allow specifying a list of files to compare, rather than
45
## doing the whole tree? (Not urgent.)
46
47
## TODO: Allow diffing any two inventories, not just the
48
## current one against one. We mgiht need to specify two
49
## stores to look for the files if diffing two branches. That
50
## might imply this shouldn't be primarily a Branch method.
51
52
## XXX: This doesn't report on unknown files; that can be done
53
## from a separate method.
54
55
old_it = old_tree.list_files()
56
new_it = new_tree.list_files()
57
58
def next(it):
59
try:
60
return it.next()
61
except StopIteration:
62
return None
63
64
old_item = next(old_it)
65
new_item = next(new_it)
66
67
# We step through the two sorted iterators in parallel, trying to
68
# keep them lined up.
69
70
while (old_item != None) or (new_item != None):
71
# OK, we still have some remaining on both, but they may be
72
# out of step.
73
if old_item != None:
74
old_name, old_class, old_kind, old_id = old_item
75
else:
76
old_name = None
77
78
if new_item != None:
79
new_name, new_class, new_kind, new_id = new_item
80
else:
81
new_name = None
82
83
mutter(" diff pairwise %r" % (old_item,))
84
mutter(" %r" % (new_item,))
85
86
if old_item:
87
# can't handle the old tree being a WorkingTree
88
assert old_class == 'V'
89
90
if new_item and (new_class != 'V'):
91
yield new_class, None, None, new_name, new_kind
92
new_item = next(new_it)
93
elif (not new_item) or (old_item and (old_name < new_name)):
94
mutter(" extra entry in old-tree sequence")
95
if new_tree.has_id(old_id):
96
# will be mentioned as renamed under new name
97
pass
98
else:
99
yield 'D', old_id, old_name, None, old_kind
100
old_item = next(old_it)
101
elif (not old_item) or (new_item and (new_name < old_name)):
102
mutter(" extra entry in new-tree sequence")
103
if old_tree.has_id(new_id):
104
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
105
else:
106
yield 'A', new_id, None, new_name, new_kind
107
new_item = next(new_it)
108
elif old_id != new_id:
109
assert old_name == new_name
110
# both trees have a file of this name, but it is not the
111
# same file. in other words, the old filename has been
112
# overwritten by either a newly-added or a renamed file.
113
# (should we return something about the overwritten file?)
114
if old_tree.has_id(new_id):
115
# renaming, overlying a deleted file
116
yield 'R', new_id, old_tree.id2path(new_id), new_name, new_kind
117
else:
118
yield 'A', new_id, None, new_name, new_kind
119
120
new_item = next(new_it)
121
old_item = next(old_it)
122
else:
123
assert old_id == new_id
124
assert old_id != None
125
assert old_name == new_name
126
assert old_kind == new_kind
127
128
if old_kind == 'directory':
129
yield '.', new_id, old_name, new_name, new_kind
130
elif old_tree.get_file_size(old_id) != new_tree.get_file_size(old_id):
131
mutter(" file size has changed, must be different")
132
yield 'M', new_id, old_name, new_name, new_kind
133
elif old_tree.get_file_sha1(old_id) == new_tree.get_file_sha1(old_id):
134
mutter(" SHA1 indicates they're identical")
135
## assert compare_files(old_tree.get_file(i), new_tree.get_file(i))
136
yield '.', new_id, old_name, new_name, new_kind
137
else:
138
mutter(" quick compare shows different")
139
yield 'M', new_id, old_name, new_name, new_kind
140
141
new_item = next(new_it)
142
old_item = next(old_it)
143
144
Loggerhead is a web-based interface for Breezy
Version: 2.0.1