« 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
- contrib
- contrib/bash
- contrib/zsh
- patches
- 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
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
23
import difflib
24
25
# FIXME: difflib is wrong if there is no trailing newline.
26
# The syntax used by patch seems to be "\ No newline at
27
# end of file" following the last diff line from that
28
# file. This is not trivial to insert into the
29
# unified_diff output and it might be better to just fix
30
# or replace that function.
31
32
# In the meantime we at least make sure the patch isn't
33
# mangled.
34
35
36
# Special workaround for Python2.3, where difflib fails if
37
# both sequences are empty.
38
if not oldlines and not newlines:
39
return
40
41
nonl = False
42
43
if oldlines and (oldlines[-1][-1] != '\n'):
44
oldlines[-1] += '\n'
45
nonl = True
46
if newlines and (newlines[-1][-1] != '\n'):
47
newlines[-1] += '\n'
48
nonl = True
49
50
ud = difflib.unified_diff(oldlines, newlines,
51
fromfile=old_label, tofile=new_label)
52
53
# work-around for difflib being too smart for its own good
54
# if /dev/null is "1,0", patch won't recognize it as /dev/null
55
if not oldlines:
56
ud = list(ud)
57
ud[2] = ud[2].replace('-1,0', '-0,0')
58
elif not newlines:
59
ud = list(ud)
60
ud[2] = ud[2].replace('+1,0', '+0,0')
61
62
to_file.writelines(ud)
63
if nonl:
64
print >>to_file, "\\ No newline at end of file"
65
print >>to_file
66
67
68
69
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
71
diff_opts):
72
"""Display a diff by calling out to the external diff program."""
73
import sys
74
75
if to_file != sys.stdout:
76
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
77
to_file)
78
79
# make sure our own output is properly ordered before the diff
80
to_file.flush()
81
82
from tempfile import NamedTemporaryFile
83
import os
84
85
oldtmpf = NamedTemporaryFile()
86
newtmpf = NamedTemporaryFile()
87
88
try:
89
# TODO: perhaps a special case for comparing to or from the empty
90
# sequence; can just use /dev/null on Unix
91
92
# TODO: if either of the files being compared already exists as a
93
# regular named file (e.g. in the working directory) then we can
94
# compare directly to that, rather than copying it.
95
96
oldtmpf.writelines(oldlines)
97
newtmpf.writelines(newlines)
98
99
oldtmpf.flush()
100
newtmpf.flush()
101
102
if not diff_opts:
103
diff_opts = []
104
diffcmd = ['diff',
105
'--label', old_label,
106
oldtmpf.name,
107
'--label', new_label,
108
newtmpf.name]
109
110
# diff only allows one style to be specified; they don't override.
111
# note that some of these take optargs, and the optargs can be
112
# directly appended to the options.
113
# this is only an approximate parser; it doesn't properly understand
114
# the grammar.
115
for s in ['-c', '-u', '-C', '-U',
116
'-e', '--ed',
117
'-q', '--brief',
118
'--normal',
119
'-n', '--rcs',
120
'-y', '--side-by-side',
121
'-D', '--ifdef']:
122
for j in diff_opts:
123
if j.startswith(s):
124
break
125
else:
126
continue
127
break
128
else:
129
diffcmd.append('-u')
130
131
if diff_opts:
132
diffcmd.extend(diff_opts)
133
134
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
135
136
if rc != 0 and rc != 1:
137
# returns 1 if files differ; that's OK
138
if rc < 0:
139
msg = 'signal %d' % (-rc)
140
else:
141
msg = 'exit code %d' % rc
142
143
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
144
finally:
145
oldtmpf.close() # and delete
146
newtmpf.close()
147
148
149
150
def show_diff(b, revision, specific_files, external_diff_options=None):
151
import sys
152
153
if revision == None:
154
old_tree = b.basis_tree()
155
else:
156
old_tree = b.revision_tree(b.lookup_revision(revision))
157
158
new_tree = b.working_tree()
159
160
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
161
external_diff_options)
162
163
164
165
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
166
external_diff_options=None):
167
"""Show in text form the changes from one tree to another.
168
169
to_files
170
If set, include only changes to these files.
171
172
external_diff_options
173
If set, use an external GNU diff and pass these options.
174
"""
175
176
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
177
old_label = ''
178
new_label = ''
179
180
DEVNULL = '/dev/null'
181
# Windows users, don't panic about this filename -- it is a
182
# special signal to GNU patch that the file should be created or
183
# deleted respectively.
184
185
# TODO: Generation of pseudo-diffs for added/deleted files could
186
# be usefully made into a much faster special case.
187
188
if external_diff_options:
189
assert isinstance(external_diff_options, basestring)
190
opts = external_diff_options.split()
191
def diff_file(olab, olines, nlab, nlines, to_file):
192
external_diff(olab, olines, nlab, nlines, to_file, opts)
193
else:
194
diff_file = internal_diff
195
196
197
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
198
specific_files=specific_files)
199
200
for path, file_id, kind in delta.removed:
201
print '*** removed %s %r' % (kind, path)
202
if kind == 'file':
203
diff_file(old_label + path,
204
old_tree.get_file(file_id).readlines(),
205
DEVNULL,
206
[],
207
to_file)
208
209
for path, file_id, kind in delta.added:
210
print '*** added %s %r' % (kind, path)
211
if kind == 'file':
212
diff_file(DEVNULL,
213
[],
214
new_label + path,
215
new_tree.get_file(file_id).readlines(),
216
to_file)
217
218
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
219
print '*** renamed %s %r => %r' % (kind, old_path, new_path)
220
if text_modified:
221
diff_file(old_label + old_path,
222
old_tree.get_file(file_id).readlines(),
223
new_label + new_path,
224
new_tree.get_file(file_id).readlines(),
225
to_file)
226
227
for path, file_id, kind in delta.modified:
228
print '*** modified %s %r' % (kind, path)
229
if kind == 'file':
230
diff_file(old_label + path,
231
old_tree.get_file(file_id).readlines(),
232
new_label + path,
233
new_tree.get_file(file_id).readlines(),
234
to_file)
235
236
237
238
class TreeDelta(object):
239
"""Describes changes from one tree to another.
240
241
Contains four lists:
242
243
added
244
(path, id, kind)
245
removed
246
(path, id, kind)
247
renamed
248
(oldpath, newpath, id, kind, text_modified)
249
modified
250
(path, id, kind)
251
unchanged
252
(path, id, kind)
253
254
Each id is listed only once.
255
256
Files that are both modified and renamed are listed only in
257
renamed, with the text_modified flag true.
258
259
The lists are normally sorted when the delta is created.
260
"""
261
def __init__(self):
262
self.added = []
263
self.removed = []
264
self.renamed = []
265
self.modified = []
266
self.unchanged = []
267
268
269
def touches_file_id(self, file_id):
270
"""Return True if file_id is modified by this delta."""
271
for l in self.added, self.removed, self.modified:
272
for v in l:
273
if v[1] == file_id:
274
return True
275
for v in self.renamed:
276
if v[2] == file_id:
277
return True
278
return False
279
280
281
def show(self, to_file, show_ids=False, show_unchanged=False):
282
def show_list(files):
283
for path, fid, kind in files:
284
if kind == 'directory':
285
path += '/'
286
elif kind == 'symlink':
287
path += '@'
288
289
if show_ids:
290
print >>to_file, ' %-30s %s' % (path, fid)
291
else:
292
print >>to_file, ' ', path
293
294
if self.removed:
295
print >>to_file, 'removed:'
296
show_list(self.removed)
297
298
if self.added:
299
print >>to_file, 'added:'
300
show_list(self.added)
301
302
if self.renamed:
303
print >>to_file, 'renamed:'
304
for oldpath, newpath, fid, kind, text_modified in self.renamed:
305
if show_ids:
306
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
307
else:
308
print >>to_file, ' %s => %s' % (oldpath, newpath)
309
310
if self.modified:
311
print >>to_file, 'modified:'
312
show_list(self.modified)
313
314
if show_unchanged and self.unchanged:
315
print >>to_file, 'unchanged:'
316
show_list(self.unchanged)
317
318
319
320
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
321
"""Describe changes from one tree to another.
322
323
Returns a TreeDelta with details of added, modified, renamed, and
324
deleted entries.
325
326
The root entry is specifically exempt.
327
328
This only considers versioned files.
329
330
want_unchanged
331
If true, also list files unchanged from one version to
332
the next.
333
334
specific_files
335
If true, only check for changes to specified names or
336
files within them.
337
"""
338
339
from osutils import is_inside_any
340
341
old_inv = old_tree.inventory
342
new_inv = new_tree.inventory
343
delta = TreeDelta()
344
mutter('start compare_trees')
345
346
# TODO: match for specific files can be rather smarter by finding
347
# the IDs of those files up front and then considering only that.
348
349
for file_id in old_tree:
350
if file_id in new_tree:
351
kind = old_inv.get_file_kind(file_id)
352
assert kind == new_inv.get_file_kind(file_id)
353
354
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
355
'invalid file kind %r' % kind
356
357
if kind == 'root_directory':
358
continue
359
360
old_path = old_inv.id2path(file_id)
361
new_path = new_inv.id2path(file_id)
362
363
if specific_files:
364
if (not is_inside_any(specific_files, old_path)
365
and not is_inside_any(specific_files, new_path)):
366
continue
367
368
if kind == 'file':
369
old_sha1 = old_tree.get_file_sha1(file_id)
370
new_sha1 = new_tree.get_file_sha1(file_id)
371
text_modified = (old_sha1 != new_sha1)
372
else:
373
## mutter("no text to check for %r %r" % (file_id, kind))
374
text_modified = False
375
376
# TODO: Can possibly avoid calculating path strings if the
377
# two files are unchanged and their names and parents are
378
# the same and the parents are unchanged all the way up.
379
# May not be worthwhile.
380
381
if old_path != new_path:
382
delta.renamed.append((old_path, new_path, file_id, kind,
383
text_modified))
384
elif text_modified:
385
delta.modified.append((new_path, file_id, kind))
386
elif want_unchanged:
387
delta.unchanged.append((new_path, file_id, kind))
388
else:
389
kind = old_inv.get_file_kind(file_id)
390
old_path = old_inv.id2path(file_id)
391
if specific_files:
392
if not is_inside_any(specific_files, old_path):
393
continue
394
delta.removed.append((old_path, file_id, kind))
395
396
mutter('start looking for new files')
397
for file_id in new_inv:
398
if file_id in old_inv:
399
continue
400
new_path = new_inv.id2path(file_id)
401
if specific_files:
402
if not is_inside_any(specific_files, new_path):
403
continue
404
kind = new_inv.get_file_kind(file_id)
405
delta.added.append((new_path, file_id, kind))
406
407
delta.removed.sort()
408
delta.added.sort()
409
delta.renamed.sort()
410
delta.modified.sort()
411
delta.unchanged.sort()
412
413
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