/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/patiencediff.py

Optimize common case where unique_lcs returns a set of lines all in a row

Show diffs side-by-side

added added

removed removed

Lines of Context:
13
13
#
14
14
# You should have received a copy of the GNU General Public License
15
15
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
18
 
19
19
from bisect import bisect
 
20
from copy import copy
20
21
import difflib
 
22
import os
 
23
import sys
 
24
import time
21
25
 
22
26
from bzrlib.trace import mutter
23
27
 
25
29
__all__ = ['PatienceSequenceMatcher', 'unified_diff', 'unified_diff_files']
26
30
 
27
31
 
28
 
def unique_lcs_py(a, b):
 
32
def unique_lcs(a, b):
29
33
    """Find the longest common subset for unique lines.
30
34
 
31
35
    :param a: An indexable object (such as string or list of strings)
40
44
    http://en.wikipedia.org/wiki/Patience_sorting
41
45
    """
42
46
    # set index[line in a] = position of line in a unless
43
 
    # a is a duplicate, in which case it's set to None
 
47
    # unless a is a duplicate, in which case it's set to None
44
48
    index = {}
45
49
    for i in xrange(len(a)):
46
50
        line = a[i]
49
53
        else:
50
54
            index[line]= i
51
55
    # make btoa[i] = position of line i in a, unless
52
 
    # that line doesn't occur exactly once in both,
 
56
    # that line doesn't occur exactly once in both, 
53
57
    # in which case it's set to None
54
58
    btoa = [None] * len(b)
55
59
    index2 = {}
79
83
            k = len(stacks)
80
84
        # as an optimization, check if the next line comes right after
81
85
        # the previous line, because usually it does
82
 
        elif stacks and stacks[k] < apos and (k == len(stacks) - 1 or
 
86
        elif stacks and stacks[k] < apos and (k == len(stacks) - 1 or 
83
87
                                              stacks[k+1] > apos):
84
88
            k += 1
85
89
        else:
103
107
    return result
104
108
 
105
109
 
106
 
def recurse_matches_py(a, b, alo, blo, ahi, bhi, answer, maxrecursion):
 
110
def recurse_matches(a, b, ahi, bhi, answer, maxrecursion):
107
111
    """Find all of the matching text in the lines of a and b.
108
112
 
109
113
    :param a: A sequence
110
114
    :param b: Another sequence
111
 
    :param alo: The start location of a to check, typically 0
112
 
    :param ahi: The start location of b to check, typically 0
113
115
    :param ahi: The maximum length of a to check, typically len(a)
114
116
    :param bhi: The maximum length of b to check, typically len(b)
115
117
    :param answer: The return array. Will be filled with tuples
125
127
        # this will never happen normally, this check is to prevent DOS attacks
126
128
        return
127
129
    oldlength = len(answer)
 
130
    if len(answer) == 0:
 
131
        alo, blo = 0, 0
 
132
    else:
 
133
        alo, blo = answer[-1]
 
134
        alo += 1
 
135
        blo += 1
128
136
    if alo == ahi or blo == bhi:
129
137
        return
130
 
    last_a_pos = alo-1
131
 
    last_b_pos = blo-1
132
 
    for apos, bpos in unique_lcs_py(a[alo:ahi], b[blo:bhi]):
 
138
    last_a_pos = -1
 
139
    last_b_pos = -1
 
140
    for apos, bpos in unique_lcs(a[alo:ahi], b[blo:bhi]):
133
141
        # recurse between lines which are unique in each file and match
134
142
        apos += alo
135
143
        bpos += blo
136
144
        # Most of the time, you will have a sequence of similar entries
137
145
        if last_a_pos+1 != apos or last_b_pos+1 != bpos:
138
 
            recurse_matches_py(a, b, last_a_pos+1, last_b_pos+1,
139
 
                apos, bpos, answer, maxrecursion - 1)
 
146
            recurse_matches(a, b, apos, bpos, answer, maxrecursion - 1)
140
147
        last_a_pos = apos
141
148
        last_b_pos = bpos
142
149
        answer.append((apos, bpos))
143
150
    if len(answer) > oldlength:
144
151
        # find matches between the last match and the end
145
 
        recurse_matches_py(a, b, last_a_pos+1, last_b_pos+1,
146
 
                           ahi, bhi, answer, maxrecursion - 1)
 
152
        recurse_matches(a, b, ahi, bhi, answer, maxrecursion - 1)
147
153
    elif a[alo] == b[blo]:
148
154
        # find matching lines at the very beginning
149
155
        while alo < ahi and blo < bhi and a[alo] == b[blo]:
150
156
            answer.append((alo, blo))
151
157
            alo += 1
152
158
            blo += 1
153
 
        recurse_matches_py(a, b, alo, blo,
154
 
                           ahi, bhi, answer, maxrecursion - 1)
 
159
        recurse_matches(a, b, ahi, bhi, answer, maxrecursion - 1)
155
160
    elif a[ahi - 1] == b[bhi - 1]:
156
161
        # find matching lines at the very end
157
162
        nahi = ahi - 1
159
164
        while nahi > alo and nbhi > blo and a[nahi - 1] == b[nbhi - 1]:
160
165
            nahi -= 1
161
166
            nbhi -= 1
162
 
        recurse_matches_py(a, b, last_a_pos+1, last_b_pos+1,
163
 
                           nahi, nbhi, answer, maxrecursion - 1)
 
167
        recurse_matches(a, b, nahi, nbhi, answer, maxrecursion - 1)
164
168
        for i in xrange(ahi - nahi):
165
169
            answer.append((nahi + i, nbhi + i))
166
170
 
167
171
 
168
 
def _collapse_sequences(matches):
169
 
    """Find sequences of lines.
170
 
 
171
 
    Given a sequence of [(line_in_a, line_in_b),]
172
 
    find regions where they both increment at the same time
173
 
    """
174
 
    answer = []
175
 
    start_a = start_b = None
176
 
    length = 0
177
 
    for i_a, i_b in matches:
178
 
        if (start_a is not None
179
 
            and (i_a == start_a + length)
180
 
            and (i_b == start_b + length)):
181
 
            length += 1
182
 
        else:
183
 
            if start_a is not None:
184
 
                answer.append((start_a, start_b, length))
185
 
            start_a = i_a
186
 
            start_b = i_b
187
 
            length = 1
188
 
 
189
 
    if length != 0:
190
 
        answer.append((start_a, start_b, length))
191
 
 
192
 
    return answer
193
 
 
194
 
 
195
 
def _check_consistency(answer):
196
 
    # For consistency sake, make sure all matches are only increasing
197
 
    next_a = -1
198
 
    next_b = -1
199
 
    for (a, b, match_len) in answer:
200
 
        if a < next_a:
201
 
            raise ValueError('Non increasing matches for a')
202
 
        if b < next_b:
203
 
            raise ValueError('Non increasing matches for b')
204
 
        next_a = a + match_len
205
 
        next_b = b + match_len
206
 
 
207
 
 
208
 
class PatienceSequenceMatcher_py(difflib.SequenceMatcher):
 
172
class PatienceSequenceMatcher(difflib.SequenceMatcher):
209
173
    """Compare a pair of sequences using longest common subset."""
210
174
 
211
 
    _do_check_consistency = True
212
 
 
213
175
    def __init__(self, isjunk=None, a='', b=''):
214
176
        if isjunk is not None:
215
177
            raise NotImplementedError('Currently we do not support'
216
178
                                      ' isjunk for sequence matching')
217
179
        difflib.SequenceMatcher.__init__(self, isjunk, a, b)
218
180
 
 
181
    def _check_with_diff(self, alo, ahi, blo, bhi, answer):
 
182
        """Use the original diff algorithm on an unmatched section.
 
183
 
 
184
        This will check to make sure the range is worth checking,
 
185
        before doing any work.
 
186
 
 
187
        :param alo: The last line that actually matched
 
188
        :param ahi: The next line that actually matches
 
189
        :param blo: Same as alo, only for the 'b' set
 
190
        :param bhi: Same as ahi
 
191
        :param answer: An array which will have the new ranges appended to it
 
192
        :return: None
 
193
        """
 
194
        # WORKAROUND
 
195
        # recurse_matches has an implementation design
 
196
        # which does not match non-unique lines in the
 
197
        # if they do not touch matching unique lines
 
198
        # so we rerun the regular diff algorithm
 
199
        # if find a large enough chunk.
 
200
 
 
201
        # recurse_matches already looked at the direct
 
202
        # neighbors, so we only need to run if there is
 
203
        # enough space to do so
 
204
        if ahi - alo > 2 and bhi - blo > 2:
 
205
            a = self.a[alo+1:ahi-1]
 
206
            b = self.b[blo+1:bhi-1]
 
207
            m = difflib.SequenceMatcher(None, a, b)
 
208
            new_blocks = m.get_matching_blocks()
 
209
            # difflib always adds a final match
 
210
            new_blocks.pop()
 
211
            for blk in new_blocks:
 
212
                answer.append((blk[0]+alo+1,
 
213
                               blk[1]+blo+1,
 
214
                               blk[2]))
 
215
 
219
216
    def get_matching_blocks(self):
220
217
        """Return list of triples describing matching subsequences.
221
218
 
230
227
        >>> s.get_matching_blocks()
231
228
        [(0, 0, 2), (3, 2, 2), (5, 4, 0)]
232
229
        """
233
 
        # jam 20060525 This is the python 2.4.1 difflib get_matching_blocks
 
230
        # jam 20060525 This is the python 2.4.1 difflib get_matching_blocks 
234
231
        # implementation which uses __helper. 2.4.3 got rid of helper for
235
232
        # doing it inline with a queue.
236
233
        # We should consider doing the same for recurse_matches
237
234
 
238
235
        if self.matching_blocks is not None:
239
236
            return self.matching_blocks
 
237
        self.matching_blocks = []
 
238
        la, lb = len(self.a), len(self.b)
 
239
        self._find_matching_blocks(0, la, 0, lb, self.matching_blocks)
 
240
        self.matching_blocks.append( (la, lb, 0) )
 
241
        return self.matching_blocks
240
242
 
 
243
    def _find_matching_blocks(self, alo, ahi, blo, bhi, answer):
241
244
        matches = []
242
 
        recurse_matches_py(self.a, self.b, 0, 0,
243
 
                           len(self.a), len(self.b), matches, 10)
 
245
        a = self.a[alo:ahi]
 
246
        b = self.b[blo:bhi]
 
247
        recurse_matches(a, b, len(a), len(b), matches, 10)
244
248
        # Matches now has individual line pairs of
245
249
        # line A matches line B, at the given offsets
246
 
        self.matching_blocks = _collapse_sequences(matches)
247
 
        self.matching_blocks.append( (len(self.a), len(self.b), 0) )
248
 
        if PatienceSequenceMatcher_py._do_check_consistency:
249
 
            if __debug__:
250
 
                _check_consistency(self.matching_blocks)
251
 
 
252
 
        return self.matching_blocks
 
250
 
 
251
        start_a = start_b = None
 
252
        length = 0
 
253
        for i_a, i_b in matches:
 
254
            if (start_a is not None
 
255
                and (i_a == start_a + length) 
 
256
                and (i_b == start_b + length)):
 
257
                length += 1
 
258
            else:
 
259
                # New block
 
260
                if start_a is None:
 
261
                    # We need to check from 0,0 until the current match
 
262
                    self._check_with_diff(alo-1, i_a+alo, blo-1, i_b+blo, 
 
263
                                          answer)
 
264
                else:
 
265
                    answer.append((start_a+alo, start_b+blo, length))
 
266
                    self._check_with_diff(start_a+alo+length, i_a+alo,
 
267
                                          start_b+blo+length, i_b+blo,
 
268
                                          answer)
 
269
 
 
270
                start_a = i_a
 
271
                start_b = i_b
 
272
                length = 1
 
273
 
 
274
        if length != 0:
 
275
            answer.append((start_a+alo, start_b+blo, length))
 
276
            self._check_with_diff(start_a+alo+length, ahi+1,
 
277
                                  start_b+blo+length, bhi+1,
 
278
                                  answer)
 
279
        if not matches:
 
280
            # Nothing matched, so we need to send the complete text
 
281
            self._check_with_diff(alo-1, ahi+1, blo-1, bhi+1, answer)
 
282
 
 
283
        # For consistency sake, make sure all matches are only increasing
 
284
        if __debug__:
 
285
            next_a = -1
 
286
            next_b = -1
 
287
            for a,b,match_len in answer:
 
288
                assert a >= next_a, 'Non increasing matches for a'
 
289
                assert b >= next_b, 'Not increasing matches for b'
 
290
                next_a = a + match_len
 
291
                next_b = b + match_len
 
292
 
 
293
 
 
294
# This is a version of unified_diff which only adds a factory parameter
 
295
# so that you can override the default SequenceMatcher
 
296
# this has been submitted as a patch to python
 
297
def unified_diff(a, b, fromfile='', tofile='', fromfiledate='',
 
298
                 tofiledate='', n=3, lineterm='\n',
 
299
                 sequencematcher=None):
 
300
    r"""
 
301
    Compare two sequences of lines; generate the delta as a unified diff.
 
302
 
 
303
    Unified diffs are a compact way of showing line changes and a few
 
304
    lines of context.  The number of context lines is set by 'n' which
 
305
    defaults to three.
 
306
 
 
307
    By default, the diff control lines (those with ---, +++, or @@) are
 
308
    created with a trailing newline.  This is helpful so that inputs
 
309
    created from file.readlines() result in diffs that are suitable for
 
310
    file.writelines() since both the inputs and outputs have trailing
 
311
    newlines.
 
312
 
 
313
    For inputs that do not have trailing newlines, set the lineterm
 
314
    argument to "" so that the output will be uniformly newline free.
 
315
 
 
316
    The unidiff format normally has a header for filenames and modification
 
317
    times.  Any or all of these may be specified using strings for
 
318
    'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.  The modification
 
319
    times are normally expressed in the format returned by time.ctime().
 
320
 
 
321
    Example:
 
322
 
 
323
    >>> for line in unified_diff('one two three four'.split(),
 
324
    ...             'zero one tree four'.split(), 'Original', 'Current',
 
325
    ...             'Sat Jan 26 23:30:50 1991', 'Fri Jun 06 10:20:52 2003',
 
326
    ...             lineterm=''):
 
327
    ...     print line
 
328
    --- Original Sat Jan 26 23:30:50 1991
 
329
    +++ Current Fri Jun 06 10:20:52 2003
 
330
    @@ -1,4 +1,4 @@
 
331
    +zero
 
332
     one
 
333
    -two
 
334
    -three
 
335
    +tree
 
336
     four
 
337
    """
 
338
    if sequencematcher is None:
 
339
        sequencematcher = difflib.SequenceMatcher
 
340
 
 
341
    started = False
 
342
    for group in sequencematcher(None,a,b).get_grouped_opcodes(n):
 
343
        if not started:
 
344
            yield '--- %s %s%s' % (fromfile, fromfiledate, lineterm)
 
345
            yield '+++ %s %s%s' % (tofile, tofiledate, lineterm)
 
346
            started = True
 
347
        i1, i2, j1, j2 = group[0][1], group[-1][2], group[0][3], group[-1][4]
 
348
        yield "@@ -%d,%d +%d,%d @@%s" % (i1+1, i2-i1, j1+1, j2-j1, lineterm)
 
349
        for tag, i1, i2, j1, j2 in group:
 
350
            if tag == 'equal':
 
351
                for line in a[i1:i2]:
 
352
                    yield ' ' + line
 
353
                continue
 
354
            if tag == 'replace' or tag == 'delete':
 
355
                for line in a[i1:i2]:
 
356
                    yield '-' + line
 
357
            if tag == 'replace' or tag == 'insert':
 
358
                for line in b[j1:j2]:
 
359
                    yield '+' + line
 
360
 
 
361
 
 
362
def unified_diff_files(a, b, sequencematcher=None):
 
363
    """Generate the diff for two files.
 
364
    """
 
365
    # Should this actually be an error?
 
366
    if a == b:
 
367
        return []
 
368
    if a == '-':
 
369
        file_a = sys.stdin
 
370
        time_a = time.time()
 
371
    else:
 
372
        file_a = open(a, 'rb')
 
373
        time_a = os.stat(a).st_mtime
 
374
 
 
375
    if b == '-':
 
376
        file_b = sys.stdin
 
377
        time_b = time.time()
 
378
    else:
 
379
        file_b = open(b, 'rb')
 
380
        time_b = os.stat(b).st_mtime
 
381
 
 
382
    # TODO: Include fromfiledate and tofiledate
 
383
    return unified_diff(file_a.readlines(), file_b.readlines(),
 
384
                        fromfile=a, tofile=b,
 
385
                        sequencematcher=sequencematcher)
 
386
 
 
387
 
 
388
def main(args):
 
389
    import optparse
 
390
    p = optparse.OptionParser(usage='%prog [options] file_a file_b'
 
391
                                    '\nFiles can be "-" to read from stdin')
 
392
    p.add_option('--patience', dest='matcher', action='store_const', const='patience',
 
393
                 default='patience', help='Use the patience difference algorithm')
 
394
    p.add_option('--difflib', dest='matcher', action='store_const', const='difflib',
 
395
                 default='patience', help='Use python\'s difflib algorithm')
 
396
 
 
397
    algorithms = {'patience':PatienceSequenceMatcher, 'difflib':difflib.SequenceMatcher}
 
398
 
 
399
    (opts, args) = p.parse_args(args)
 
400
    matcher = algorithms[opts.matcher]
 
401
 
 
402
    if len(args) != 2:
 
403
        print 'You must supply 2 filenames to diff'
 
404
        return -1
 
405
 
 
406
    for line in unified_diff_files(args[0], args[1], sequencematcher=matcher):
 
407
        sys.stdout.write(line)
 
408
    
 
409
if __name__ == '__main__':
 
410
    sys.exit(main(sys.argv[1:]))