cpython-lru_cache-weakref: Lib/difflib.py annotate

annotate Lib/difflib.py @ 49955:878d40468c4e legacy-trunk

Issue #4384: Added logging integration with warnings module using captureWarnings(). This change includes a NullHandler which does nothing; it will be of use to library developers who want to avoid the "No handlers could be found for logger XXX" message which can appear if the library user doesn't configure logging.

author	Vinay Sajip <vinay_sajip@yahoo.co.uk>
date	Wed, 03 Dec 2008 23:22:58 +0000
parents	bc6a3572bc89
children	74c0a78114ae

rev	line source
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	1 #! /usr/bin/env python
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	3 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	4 Module difflib -- helpers for computing deltas between objects.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	5
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	6 Function get_close_matches(word, possibilities, n=3, cutoff=0.6):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	7 Use SequenceMatcher to return list of the best "good enough" matches.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	8
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	9 Function context_diff(a, b):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	10 For two lists of strings, return a delta in context diff format.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	11
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	12 Function ndiff(a, b):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	13 Return a delta: the difference between `a` and `b` (lists of strings).
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	14
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	15 Function restore(delta, which):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	16 Return one of the two sequences that generated an ndiff delta.
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	17
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	18 Function unified_diff(a, b):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	19 For two lists of strings, return a delta in unified diff format.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	20
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	21 Class SequenceMatcher:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	22 A flexible class for comparing pairs of sequences of any type.
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	23
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	24 Class Differ:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	25 For producing human-readable deltas from sequences of lines of text.
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	26
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	27 Class HtmlDiff:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	28 For producing HTML side by side comparison with change highlights.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	29 """
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	30
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	31 __all__ = ['get_close_matches', 'ndiff', 'restore', 'SequenceMatcher',
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	32 'Differ','IS_CHARACTER_JUNK', 'IS_LINE_JUNK', 'context_diff',
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	33 'unified_diff', 'HtmlDiff', 'Match']
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	34
32339 408a40e65247 Apply heapq.nlargest() to find best matches. Raymond Hettinger <python@rcn.com> parents: 31515 diff changeset	35 import heapq
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	36 from collections import namedtuple as _namedtuple
48205 bc6a3572bc89 Use functools.reduce() in difflib instead of __builtin__.reduce() to silence Brett Cannon <bcannon@gmail.com> parents: 47821 diff changeset	37 from functools import reduce
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	38
6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	39 Match = _namedtuple('Match', 'a b size')
32339 408a40e65247 Apply heapq.nlargest() to find best matches. Raymond Hettinger <python@rcn.com> parents: 31515 diff changeset	40
29719 fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	41 def _calculate_ratio(matches, length):
fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	42 if length:
fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	43 return 2.0 * matches / length
fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	44 return 1.0
fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	45
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	46 class SequenceMatcher:
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	47
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	48 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	49 SequenceMatcher is a flexible class for comparing pairs of sequences of
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	50 any type, so long as the sequence elements are hashable. The basic
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	51 algorithm predates, and is a little fancier than, an algorithm
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	52 published in the late 1980's by Ratcliff and Obershelp under the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	53 hyperbolic name "gestalt pattern matching". The basic idea is to find
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	54 the longest contiguous matching subsequence that contains no "junk"
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	55 elements (R-O doesn't address junk). The same idea is then applied
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	56 recursively to the pieces of the sequences to the left and to the right
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	57 of the matching subsequence. This does not yield minimal edit
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	58 sequences, but does tend to yield matches that "look right" to people.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	59
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	60 SequenceMatcher tries to compute a "human-friendly diff" between two
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	61 sequences. Unlike e.g. UNIX(tm) diff, the fundamental notion is the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	62 longest contiguous & junk-free matching subsequence. That's what
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	63 catches peoples' eyes. The Windows(tm) windiff has another interesting
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	64 notion, pairing up elements that appear uniquely in each sequence.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	65 That, and the method here, appear to yield more intuitive difference
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	66 reports than does diff. This method appears to be the least vulnerable
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	67 to synching up on blocks of "junk lines", though (like blank lines in
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	68 ordinary text files, or maybe "<P>" lines in HTML files). That may be
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	69 because this is the only method of the 3 that has a concept of
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	70 "junk" <wink>.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	71
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	72 Example, comparing two strings, and considering blanks to be "junk":
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	73
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	74 >>> s = SequenceMatcher(lambda x: x == " ",
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	75 ... "private Thread currentThread;",
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	76 ... "private volatile Thread currentThread;")
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	77 >>>
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	78
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	79 .ratio() returns a float in [0, 1], measuring the "similarity" of the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	80 sequences. As a rule of thumb, a .ratio() value over 0.6 means the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	81 sequences are close matches:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	82
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	83 >>> print round(s.ratio(), 3)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	84 0.866
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	85 >>>
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	86
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	87 If you're only interested in where the sequences match,
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	88 .get_matching_blocks() is handy:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	89
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	90 >>> for block in s.get_matching_blocks():
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	91 ... print "a[%d] and b[%d] match for %d elements" % block
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	92 a[0] and b[0] match for 8 elements
38811 4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	93 a[8] and b[17] match for 21 elements
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	94 a[29] and b[38] match for 0 elements
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	95
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	96 Note that the last tuple returned by .get_matching_blocks() is always a
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	97 dummy, (len(a), len(b), 0), and this is the only case in which the last
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	98 tuple element (number of elements matched) is 0.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	99
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	100 If you want to know how to change the first sequence into the second,
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	101 use .get_opcodes():
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	102
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	103 >>> for opcode in s.get_opcodes():
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	104 ... print "%6s a[%d:%d] b[%d:%d]" % opcode
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	105 equal a[0:8] b[0:8]
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	106 insert a[8:8] b[8:17]
38811 4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	107 equal a[8:29] b[17:38]
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	108
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	109 See the Differ class for a fancy human-friendly file differencer, which
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	110 uses SequenceMatcher both to compare sequences of lines, and to compare
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	111 sequences of characters within similar (near-matching) lines.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	112
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	113 See also function get_close_matches() in this module, which shows how
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	114 simple code building on SequenceMatcher can be used to do useful work.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	115
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	116 Timing: Basic R-O is cubic time worst case and quadratic time expected
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	117 case. SequenceMatcher is quadratic time for the worst case and has
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	118 expected-case behavior dependent in a complicated way on how many
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	119 elements the sequences have in common; best case time is linear.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	120
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	121 Methods:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	122
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	123 __init__(isjunk=None, a='', b='')
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	124 Construct a SequenceMatcher.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	125
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	126 set_seqs(a, b)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	127 Set the two sequences to be compared.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	128
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	129 set_seq1(a)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	130 Set the first sequence to be compared.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	131
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	132 set_seq2(b)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	133 Set the second sequence to be compared.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	134
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	135 find_longest_match(alo, ahi, blo, bhi)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	136 Find longest matching block in a[alo:ahi] and b[blo:bhi].
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	137
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	138 get_matching_blocks()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	139 Return list of triples describing matching subsequences.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	140
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	141 get_opcodes()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	142 Return list of 5-tuples describing how to turn a into b.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	143
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	144 ratio()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	145 Return a measure of the sequences' similarity (float in [0,1]).
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	146
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	147 quick_ratio()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	148 Return an upper bound on .ratio() relatively quickly.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	149
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	150 real_quick_ratio()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	151 Return an upper bound on ratio() very quickly.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	152 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	153
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	154 def __init__(self, isjunk=None, a='', b=''):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	155 """Construct a SequenceMatcher.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	156
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	157 Optional arg isjunk is None (the default), or a one-argument
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	158 function that takes a sequence element and returns true iff the
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	159 element is junk. None is equivalent to passing "lambda x: 0", i.e.
16695 e14c5f34fa05 Fix a few small typos in the docstrings. Fred Drake <fdrake@acm.org> parents: 16551 diff changeset	160 no elements are considered to be junk. For example, pass
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	161 lambda x: x in " \\t"
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	162 if you're comparing lines as sequences of characters, and don't
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	163 want to synch up on blanks or hard tabs.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	164
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	165 Optional arg a is the first of two sequences to be compared. By
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	166 default, an empty string. The elements of a must be hashable. See
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	167 also .set_seqs() and .set_seq1().
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	168
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	169 Optional arg b is the second of two sequences to be compared. By
16695 e14c5f34fa05 Fix a few small typos in the docstrings. Fred Drake <fdrake@acm.org> parents: 16551 diff changeset	170 default, an empty string. The elements of b must be hashable. See
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	171 also .set_seqs() and .set_seq2().
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	172 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	173
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	174 # Members:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	175 # a
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	176 # first sequence
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	177 # b
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	178 # second sequence; differences are computed as "what do
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	179 # we need to do to 'a' to change it into 'b'?"
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	180 # b2j
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	181 # for x in b, b2j[x] is a list of the indices (into b)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	182 # at which x appears; junk elements do not appear
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	183 # fullbcount
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	184 # for x in b, fullbcount[x] == the number of times x
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	185 # appears in b; only materialized if really needed (used
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	186 # only for computing quick_ratio())
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	187 # matching_blocks
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	188 # a list of (i, j, k) triples, where a[i:i+k] == b[j:j+k];
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	189 # ascending & non-overlapping in i and in j; terminated by
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	190 # a dummy (len(a), len(b), 0) sentinel
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	191 # opcodes
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	192 # a list of (tag, i1, i2, j1, j2) tuples, where tag is
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	193 # one of
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	194 # 'replace' a[i1:i2] should be replaced by b[j1:j2]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	195 # 'delete' a[i1:i2] should be deleted
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	196 # 'insert' b[j1:j2] should be inserted
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	197 # 'equal' a[i1:i2] == b[j1:j2]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	198 # isjunk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	199 # a user-supplied function taking a sequence element and
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	200 # returning true iff the element is "junk" -- this has
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	201 # subtle but helpful effects on the algorithm, which I'll
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	202 # get around to writing up someday <0.9 wink>.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	203 # DON'T USE! Only __chain_b uses this. Use isbjunk.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	204 # isbjunk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	205 # for x in b, isbjunk(x) == isjunk(x) but much faster;
47821 0af6f0300eaf Issue 3189: Py3k DeprecationWarning in difflib Raymond Hettinger <python@rcn.com> parents: 44633 diff changeset	206 # it's really the __contains__ method of a hidden dict.
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	207 # DOES NOT WORK for x in a!
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	208 # isbpopular
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	209 # for x in b, isbpopular(x) is true iff b is reasonably long
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	210 # (at least 200 elements) and x accounts for more than 1% of
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	211 # its elements. DOES NOT WORK for x in a!
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	212
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	213 self.isjunk = isjunk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	214 self.a = self.b = None
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	215 self.set_seqs(a, b)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	216
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	217 def set_seqs(self, a, b):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	218 """Set the two sequences to be compared.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	219
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	220 >>> s = SequenceMatcher()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	221 >>> s.set_seqs("abcd", "bcde")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	222 >>> s.ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	223 0.75
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	224 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	225
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	226 self.set_seq1(a)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	227 self.set_seq2(b)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	228
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	229 def set_seq1(self, a):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	230 """Set the first sequence to be compared.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	231
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	232 The second sequence to be compared is not changed.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	233
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	234 >>> s = SequenceMatcher(None, "abcd", "bcde")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	235 >>> s.ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	236 0.75
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	237 >>> s.set_seq1("bcde")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	238 >>> s.ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	239 1.0
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	240 >>>
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	241
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	242 SequenceMatcher computes and caches detailed information about the
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	243 second sequence, so if you want to compare one sequence S against
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	244 many sequences, use .set_seq2(S) once and call .set_seq1(x)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	245 repeatedly for each of the other sequences.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	246
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	247 See also set_seqs() and set_seq2().
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	248 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	249
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	250 if a is self.a:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	251 return
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	252 self.a = a
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	253 self.matching_blocks = self.opcodes = None
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	254
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	255 def set_seq2(self, b):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	256 """Set the second sequence to be compared.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	257
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	258 The first sequence to be compared is not changed.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	259
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	260 >>> s = SequenceMatcher(None, "abcd", "bcde")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	261 >>> s.ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	262 0.75
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	263 >>> s.set_seq2("abcd")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	264 >>> s.ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	265 1.0
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	266 >>>
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	267
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	268 SequenceMatcher computes and caches detailed information about the
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	269 second sequence, so if you want to compare one sequence S against
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	270 many sequences, use .set_seq2(S) once and call .set_seq1(x)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	271 repeatedly for each of the other sequences.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	272
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	273 See also set_seqs() and set_seq1().
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	274 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	275
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	276 if b is self.b:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	277 return
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	278 self.b = b
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	279 self.matching_blocks = self.opcodes = None
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	280 self.fullbcount = None
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	281 self.__chain_b()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	282
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	283 # For each element x in b, set b2j[x] to a list of the indices in
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	284 # b where x appears; the indices are in increasing order; note that
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	285 # the number of times x appears in b is len(b2j[x]) ...
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	286 # when self.isjunk is defined, junk elements don't show up in this
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	287 # map at all, which stops the central find_longest_match method
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	288 # from starting any matching block at a junk element ...
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	289 # also creates the fast isbjunk function ...
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	290 # b2j also does not contain entries for "popular" elements, meaning
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	291 # elements that account for more than 1% of the total elements, and
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	292 # when the sequence is reasonably large (>= 200 elements); this can
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	293 # be viewed as an adaptive notion of semi-junk, and yields an enormous
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	294 # speedup when, e.g., comparing program files with hundreds of
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	295 # instances of "return NULL;" ...
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	296 # note that this is only called when b changes; so for cross-product
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	297 # kinds of matches, it's best to call set_seq2 once, then set_seq1
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	298 # repeatedly
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	299
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	300 def __chain_b(self):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	301 # Because isjunk is a user-defined (not C) function, and we test
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	302 # for junk a LOT, it's important to minimize the number of calls.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	303 # Before the tricks described here, __chain_b was by far the most
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	304 # time-consuming routine in the whole module! If anyone sees
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	305 # Jim Roskind, thank him again for profile.py -- I never would
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	306 # have guessed that.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	307 # The first trick is to build b2j ignoring the possibility
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	308 # of junk. I.e., we don't call isjunk at all yet. Throwing
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	309 # out the junk later is much cheaper than building b2j "right"
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	310 # from the start.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	311 b = self.b
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	312 n = len(b)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	313 self.b2j = b2j = {}
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	314 populardict = {}
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	315 for i, elt in enumerate(b):
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	316 if elt in b2j:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	317 indices = b2j[elt]
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	318 if n >= 200 and len(indices) * 100 > n:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	319 populardict[elt] = 1
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	320 del indices[:]
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	321 else:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	322 indices.append(i)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	323 else:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	324 b2j[elt] = [i]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	325
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	326 # Purge leftover indices for popular elements.
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	327 for elt in populardict:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	328 del b2j[elt]
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	329
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	330 # Now b2j.keys() contains elements uniquely, and especially when
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	331 # the sequence is a string, that's usually a good deal smaller
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	332 # than len(string). The difference is the number of isjunk calls
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	333 # saved.
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	334 isjunk = self.isjunk
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	335 junkdict = {}
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	336 if isjunk:
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	337 for d in populardict, b2j:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	338 for elt in d.keys():
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	339 if isjunk(elt):
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	340 junkdict[elt] = 1
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	341 del d[elt]
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	342
23620 a1de0bab5475 SF 563203. Replaced 'has_key()' with 'in'. Raymond Hettinger <python@rcn.com> parents: 23300 diff changeset	343 # Now for x in b, isjunk(x) == x in junkdict, but the
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	344 # latter is much faster. Note too that while there may be a
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	345 # lot of junk in the sequence, the number of unique junk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	346 # elements is probably small. So the memory burden of keeping
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	347 # this dict alive is likely trivial compared to the size of b2j.
47821 0af6f0300eaf Issue 3189: Py3k DeprecationWarning in difflib Raymond Hettinger <python@rcn.com> parents: 44633 diff changeset	348 self.isbjunk = junkdict.__contains__
0af6f0300eaf Issue 3189: Py3k DeprecationWarning in difflib Raymond Hettinger <python@rcn.com> parents: 44633 diff changeset	349 self.isbpopular = populardict.__contains__
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	350
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	351 def find_longest_match(self, alo, ahi, blo, bhi):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	352 """Find longest matching block in a[alo:ahi] and b[blo:bhi].
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	353
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	354 If isjunk is not defined:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	355
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	356 Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	357 alo <= i <= i+k <= ahi
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	358 blo <= j <= j+k <= bhi
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	359 and for all (i',j',k') meeting those conditions,
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	360 k >= k'
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	361 i <= i'
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	362 and if i == i', j <= j'
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	363
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	364 In other words, of all maximal matching blocks, return one that
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	365 starts earliest in a, and of all those maximal matching blocks that
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	366 start earliest in a, return the one that starts earliest in b.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	367
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	368 >>> s = SequenceMatcher(None, " abcd", "abcd abcd")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	369 >>> s.find_longest_match(0, 5, 0, 9)
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	370 Match(a=0, b=4, size=5)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	371
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	372 If isjunk is defined, first the longest matching block is
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	373 determined as above, but with the additional restriction that no
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	374 junk element appears in the block. Then that block is extended as
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	375 far as possible by matching (only) junk elements on both sides. So
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	376 the resulting block never matches on junk except as identical junk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	377 happens to be adjacent to an "interesting" match.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	378
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	379 Here's the same example as before, but considering blanks to be
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	380 junk. That prevents " abcd" from matching the " abcd" at the tail
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	381 end of the second sequence directly. Instead only the "abcd" can
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	382 match, and matches the leftmost "abcd" in the second sequence:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	383
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	384 >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	385 >>> s.find_longest_match(0, 5, 0, 9)
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	386 Match(a=1, b=0, size=4)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	387
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	388 If no blocks match, return (alo, blo, 0).
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	389
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	390 >>> s = SequenceMatcher(None, "ab", "c")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	391 >>> s.find_longest_match(0, 2, 0, 1)
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	392 Match(a=0, b=0, size=0)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	393 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	394
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	395 # CAUTION: stripping common prefix or suffix would be incorrect.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	396 # E.g.,
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	397 # ab
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	398 # acab
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	399 # Longest matching block is "ab", but if common prefix is
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	400 # stripped, it's "a" (tied with "b"). UNIX(tm) diff does so
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	401 # strip, so ends up claiming that ab is changed to acab by
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	402 # inserting "ca" in the middle. That's minimal but unintuitive:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	403 # "it's obvious" that someone inserted "ac" at the front.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	404 # Windiff ends up at the same place as diff, but by pairing up
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	405 # the unique 'b's and then matching the first two 'a's.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	406
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	407 a, b, b2j, isbjunk = self.a, self.b, self.b2j, self.isbjunk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	408 besti, bestj, bestsize = alo, blo, 0
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	409 # find longest junk-free match
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	410 # during an iteration of the loop, j2len[j] = length of longest
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	411 # junk-free match ending with a[i-1] and b[j]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	412 j2len = {}
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	413 nothing = []
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	414 for i in xrange(alo, ahi):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	415 # look at all instances of a[i] in b; note that because
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	416 # b2j has no junk keys, the loop is skipped if a[i] is junk
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	417 j2lenget = j2len.get
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	418 newj2len = {}
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	419 for j in b2j.get(a[i], nothing):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	420 # a[i] matches b[j]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	421 if j < blo:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	422 continue
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	423 if j >= bhi:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	424 break
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	425 k = newj2len[j] = j2lenget(j-1, 0) + 1
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	426 if k > bestsize:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	427 besti, bestj, bestsize = i-k+1, j-k+1, k
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	428 j2len = newj2len
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	429
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	430 # Extend the best by non-junk elements on each end. In particular,
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	431 # "popular" non-junk elements aren't in b2j, which greatly speeds
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	432 # the inner loop above, but also means "the best" match so far
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	433 # doesn't contain any junk or popular non-junk elements.
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	434 while besti > alo and bestj > blo and \
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	435 not isbjunk(b[bestj-1]) and \
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	436 a[besti-1] == b[bestj-1]:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	437 besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	438 while besti+bestsize < ahi and bestj+bestsize < bhi and \
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	439 not isbjunk(b[bestj+bestsize]) and \
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	440 a[besti+bestsize] == b[bestj+bestsize]:
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	441 bestsize += 1
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	442
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	443 # Now that we have a wholly interesting match (albeit possibly
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	444 # empty!), we may as well suck up the matching junk on each
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	445 # side of it too. Can't think of a good reason not to, and it
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	446 # saves post-processing the (possibly considerable) expense of
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	447 # figuring out what to do with it. In the case of an empty
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	448 # interesting match, this is clearly the right thing to do,
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	449 # because no other kind of match is possible in the regions.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	450 while besti > alo and bestj > blo and \
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	451 isbjunk(b[bestj-1]) and \
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	452 a[besti-1] == b[bestj-1]:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	453 besti, bestj, bestsize = besti-1, bestj-1, bestsize+1
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	454 while besti+bestsize < ahi and bestj+bestsize < bhi and \
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	455 isbjunk(b[bestj+bestsize]) and \
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	456 a[besti+bestsize] == b[bestj+bestsize]:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	457 bestsize = bestsize + 1
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	458
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	459 return Match(besti, bestj, bestsize)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	460
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	461 def get_matching_blocks(self):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	462 """Return list of triples describing matching subsequences.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	463
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	464 Each triple is of the form (i, j, n), and means that
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	465 a[i:i+n] == b[j:j+n]. The triples are monotonically increasing in
38811 4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	466 i and in j. New in Python 2.5, it's also guaranteed that if
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	467 (i, j, n) and (i', j', n') are adjacent triples in the list, and
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	468 the second is not the last triple in the list, then i+n != i' or
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	469 j+n != j'. IOW, adjacent triples never describe adjacent equal
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	470 blocks.
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	471
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	472 The last triple is a dummy, (len(a), len(b), 0), and is the only
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	473 triple with n==0.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	474
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	475 >>> s = SequenceMatcher(None, "abxcd", "abcd")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	476 >>> s.get_matching_blocks()
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	477 [Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	478 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	479
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	480 if self.matching_blocks is not None:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	481 return self.matching_blocks
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	482 la, lb = len(self.a), len(self.b)
36429 16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	483
38784 9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	484 # This is most naturally expressed as a recursive algorithm, but
9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	485 # at least one user bumped into extreme use cases that exceeded
9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	486 # the recursion limit on their box. So, now we maintain a list
9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	487 # ('queue`) of blocks we still need to look at, and append partial
9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	488 # results to `matching_blocks` in a loop; the matches are sorted
9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	489 # at the end.
36429 16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	490 queue = [(0, la, 0, lb)]
38811 4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	491 matching_blocks = []
36429 16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	492 while queue:
16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	493 alo, ahi, blo, bhi = queue.pop()
38784 9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	494 i, j, k = x = self.find_longest_match(alo, ahi, blo, bhi)
36429 16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	495 # a[alo:i] vs b[blo:j] unknown
16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	496 # a[i:i+k] same as b[j:j+k]
16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	497 # a[i+k:ahi] vs b[j+k:bhi] unknown
38784 9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	498 if k: # if k is 0, there was no matching block
9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	499 matching_blocks.append(x)
36429 16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	500 if alo < i and blo < j:
16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	501 queue.append((alo, i, blo, j))
16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	502 if i+k < ahi and j+k < bhi:
16bfe9386068 Patch #1413711: Certain patterns of differences were making difflib Gustavo Niemeyer <gustavo@niemeyer.net> parents: 35276 diff changeset	503 queue.append((i+k, ahi, j+k, bhi))
38784 9b8507cfbe95 get_matching_blocks(): rewrote code & comments so they match; added Tim Peters <tim.peters@gmail.com> parents: 38704 diff changeset	504 matching_blocks.sort()
38811 4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	505
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	506 # It's possible that we have adjacent equal blocks in the
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	507 # matching_blocks list now. Starting with 2.5, this code was added
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	508 # to collapse them.
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	509 i1 = j1 = k1 = 0
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	510 non_adjacent = []
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	511 for i2, j2, k2 in matching_blocks:
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	512 # Is this block adjacent to i1, j1, k1?
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	513 if i1 + k1 == i2 and j1 + k1 == j2:
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	514 # Yes, so collapse them -- this just increases the length of
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	515 # the first block by the length of the second, and the first
38812 62cf6d58bb53 Repaired typo in new comment. Tim Peters <tim.peters@gmail.com> parents: 38811 diff changeset	516 # block so lengthened remains the block to compare against.
38811 4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	517 k1 += k2
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	518 else:
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	519 # Not adjacent. Remember the first block (k1==0 means it's
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	520 # the dummy we started with), and make the second block the
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	521 # new block to compare against.
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	522 if k1:
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	523 non_adjacent.append((i1, j1, k1))
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	524 i1, j1, k1 = i2, j2, k2
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	525 if k1:
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	526 non_adjacent.append((i1, j1, k1))
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	527
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	528 non_adjacent.append( (la, lb, 0) )
4558916b841f SequenceMatcher.get_matching_blocks(): This now guarantees that Tim Peters <tim.peters@gmail.com> parents: 38784 diff changeset	529 self.matching_blocks = non_adjacent
44633 6b0b5edfb1b7 Improve usability of the SequenceMatcher by returning named tuples describing match ranges. Raymond Hettinger <python@rcn.com> parents: 41078 diff changeset	530 return map(Match._make, self.matching_blocks)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	531
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	532 def get_opcodes(self):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	533 """Return list of 5-tuples describing how to turn a into b.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	534
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	535 Each tuple is of the form (tag, i1, i2, j1, j2). The first tuple
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	536 has i1 == j1 == 0, and remaining tuples have i1 == the i2 from the
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	537 tuple preceding it, and likewise for j1 == the previous j2.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	538
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	539 The tags are strings, with these meanings:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	540
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	541 'replace': a[i1:i2] should be replaced by b[j1:j2]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	542 'delete': a[i1:i2] should be deleted.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	543 Note that j1==j2 in this case.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	544 'insert': b[j1:j2] should be inserted at a[i1:i1].
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	545 Note that i1==i2 in this case.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	546 'equal': a[i1:i2] == b[j1:j2]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	547
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	548 >>> a = "qabxcd"
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	549 >>> b = "abycdf"
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	550 >>> s = SequenceMatcher(None, a, b)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	551 >>> for tag, i1, i2, j1, j2 in s.get_opcodes():
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	552 ... print ("%7s a[%d:%d] (%s) b[%d:%d] (%s)" %
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	553 ... (tag, i1, i2, a[i1:i2], j1, j2, b[j1:j2]))
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	554 delete a[0:1] (q) b[0:0] ()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	555 equal a[1:3] (ab) b[0:2] (ab)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	556 replace a[3:4] (x) b[2:3] (y)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	557 equal a[4:6] (cd) b[3:5] (cd)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	558 insert a[6:6] () b[5:6] (f)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	559 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	560
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	561 if self.opcodes is not None:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	562 return self.opcodes
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	563 i = j = 0
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	564 self.opcodes = answer = []
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	565 for ai, bj, size in self.get_matching_blocks():
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	566 # invariant: we've pumped out correct diffs to change
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	567 # a[:i] into b[:j], and the next matching block is
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	568 # a[ai:ai+size] == b[bj:bj+size]. So we need to pump
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	569 # out a diff to change a[i:ai] into b[j:bj], pump out
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	570 # the matching block, and move (i,j) beyond the match
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	571 tag = ''
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	572 if i < ai and j < bj:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	573 tag = 'replace'
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	574 elif i < ai:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	575 tag = 'delete'
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	576 elif j < bj:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	577 tag = 'insert'
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	578 if tag:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	579 answer.append( (tag, i, ai, j, bj) )
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	580 i, j = ai+size, bj+size
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	581 # the list of matching blocks is terminated by a
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	582 # sentinel with size 0
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	583 if size:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	584 answer.append( ('equal', ai, i, bj, j) )
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	585 return answer
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	586
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	587 def get_grouped_opcodes(self, n=3):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	588 """ Isolate change clusters by eliminating ranges with no changes.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	589
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	590 Return a generator of groups with upto n lines of context.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	591 Each group is in the same format as returned by get_opcodes().
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	592
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	593 >>> from pprint import pprint
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	594 >>> a = map(str, range(1,40))
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	595 >>> b = a[:]
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	596 >>> b[8:8] = ['i'] # Make an insertion
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	597 >>> b[20] += 'x' # Make a replacement
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	598 >>> b[23:28] = [] # Make a deletion
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	599 >>> b[30] += 'y' # Make another replacement
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	600 >>> pprint(list(SequenceMatcher(None,a,b).get_grouped_opcodes()))
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	601 [[('equal', 5, 8, 5, 8), ('insert', 8, 8, 8, 9), ('equal', 8, 11, 9, 12)],
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	602 [('equal', 16, 19, 17, 20),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	603 ('replace', 19, 20, 20, 21),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	604 ('equal', 20, 22, 21, 23),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	605 ('delete', 22, 27, 23, 23),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	606 ('equal', 27, 30, 23, 26)],
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	607 [('equal', 31, 34, 27, 30),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	608 ('replace', 34, 35, 30, 31),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	609 ('equal', 35, 38, 31, 34)]]
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	610 """
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	611
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	612 codes = self.get_opcodes()
32612 5546c7ae24f7 SequenceMatcher(None, [], []).get_grouped_opcodes() now returns a generator Brett Cannon <bcannon@gmail.com> parents: 32357 diff changeset	613 if not codes:
5546c7ae24f7 SequenceMatcher(None, [], []).get_grouped_opcodes() now returns a generator Brett Cannon <bcannon@gmail.com> parents: 32357 diff changeset	614 codes = [("equal", 0, 1, 0, 1)]
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	615 # Fixup leading and trailing groups if they show no changes.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	616 if codes[0][0] == 'equal':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	617 tag, i1, i2, j1, j2 = codes[0]
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	618 codes[0] = tag, max(i1, i2-n), i2, max(j1, j2-n), j2
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	619 if codes[-1][0] == 'equal':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	620 tag, i1, i2, j1, j2 = codes[-1]
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	621 codes[-1] = tag, i1, min(i2, i1+n), j1, min(j2, j1+n)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	622
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	623 nn = n + n
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	624 group = []
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	625 for tag, i1, i2, j1, j2 in codes:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	626 # End the current group and start a new one whenever
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	627 # there is a large range with no changes.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	628 if tag == 'equal' and i2-i1 > nn:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	629 group.append((tag, i1, min(i2, i1+n), j1, min(j2, j1+n)))
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	630 yield group
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	631 group = []
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	632 i1, j1 = max(i1, i2-n), max(j1, j2-n)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	633 group.append((tag, i1, i2, j1 ,j2))
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	634 if group and not (len(group)==1 and group[0][0] == 'equal'):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	635 yield group
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	636
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	637 def ratio(self):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	638 """Return a measure of the sequences' similarity (float in [0,1]).
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	639
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	640 Where T is the total number of elements in both sequences, and
32867 8d25835f88ae Repair typo in docstring. Tim Peters <tim.peters@gmail.com> parents: 32612 diff changeset	641 M is the number of matches, this is 2.0*M / T.
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	642 Note that this is 1 if the sequences are identical, and 0 if
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	643 they have nothing in common.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	644
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	645 .ratio() is expensive to compute if you haven't already computed
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	646 .get_matching_blocks() or .get_opcodes(), in which case you may
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	647 want to try .quick_ratio() or .real_quick_ratio() first to get an
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	648 upper bound.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	649
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	650 >>> s = SequenceMatcher(None, "abcd", "bcde")
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	651 >>> s.ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	652 0.75
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	653 >>> s.quick_ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	654 0.75
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	655 >>> s.real_quick_ratio()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	656 1.0
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	657 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	658
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	659 matches = reduce(lambda sum, triple: sum + triple[-1],
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	660 self.get_matching_blocks(), 0)
29719 fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	661 return _calculate_ratio(matches, len(self.a) + len(self.b))
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	662
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	663 def quick_ratio(self):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	664 """Return an upper bound on ratio() relatively quickly.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	665
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	666 This isn't defined beyond that it is an upper bound on .ratio(), and
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	667 is faster to compute.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	668 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	669
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	670 # viewing a and b as multisets, set matches to the cardinality
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	671 # of their intersection; this counts the number of matches
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	672 # without regard to order, so is clearly an upper bound
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	673 if self.fullbcount is None:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	674 self.fullbcount = fullbcount = {}
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	675 for elt in self.b:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	676 fullbcount[elt] = fullbcount.get(elt, 0) + 1
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	677 fullbcount = self.fullbcount
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	678 # avail[x] is the number of times x appears in 'b' less the
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	679 # number of times we've seen it in 'a' so far ... kinda
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	680 avail = {}
47821 0af6f0300eaf Issue 3189: Py3k DeprecationWarning in difflib Raymond Hettinger <python@rcn.com> parents: 44633 diff changeset	681 availhas, matches = avail.__contains__, 0
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	682 for elt in self.a:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	683 if availhas(elt):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	684 numb = avail[elt]
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	685 else:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	686 numb = fullbcount.get(elt, 0)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	687 avail[elt] = numb - 1
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	688 if numb > 0:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	689 matches = matches + 1
29719 fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	690 return _calculate_ratio(matches, len(self.a) + len(self.b))
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	691
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	692 def real_quick_ratio(self):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	693 """Return an upper bound on ratio() very quickly.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	694
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	695 This isn't defined beyond that it is an upper bound on .ratio(), and
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	696 is faster to compute than either .ratio() or .quick_ratio().
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	697 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	698
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	699 la, lb = len(self.a), len(self.b)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	700 # can't have more matches than the number of elements in the
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	701 # shorter sequence
29719 fa4cf878c538 Fix SF bug #763023, difflib.py: ratio() zero division not caught Neal Norwitz <nnorwitz@gmail.com> parents: 29517 diff changeset	702 return _calculate_ratio(min(la, lb), la + lb)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	703
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	704 def get_close_matches(word, possibilities, n=3, cutoff=0.6):
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	705 """Use SequenceMatcher to return list of the best "good enough" matches.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	706
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	707 word is a sequence for which close matches are desired (typically a
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	708 string).
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	709
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	710 possibilities is a list of sequences against which to match word
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	711 (typically a list of strings).
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	712
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	713 Optional arg n (default 3) is the maximum number of close matches to
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	714 return. n must be > 0.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	715
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	716 Optional arg cutoff (default 0.6) is a float in [0, 1]. Possibilities
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	717 that don't score at least that similar to word are ignored.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	718
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	719 The best (no more than n) matches among the possibilities are returned
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	720 in a list, sorted by similarity score, most similar first.
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	721
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	722 >>> get_close_matches("appel", ["ape", "apple", "peach", "puppy"])
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	723 ['apple', 'ape']
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	724 >>> import keyword as _keyword
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	725 >>> get_close_matches("wheel", _keyword.kwlist)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	726 ['while']
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	727 >>> get_close_matches("apple", _keyword.kwlist)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	728 []
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	729 >>> get_close_matches("accept", _keyword.kwlist)
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	730 ['except']
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	731 """
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	732
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	733 if not n > 0:
31515 71a294bd7950 Replace backticks with repr() or "%r" Walter Dörwald <walter@livinglogic.de> parents: 30698 diff changeset	734 raise ValueError("n must be > 0: %r" % (n,))
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	735 if not 0.0 <= cutoff <= 1.0:
31515 71a294bd7950 Replace backticks with repr() or "%r" Walter Dörwald <walter@livinglogic.de> parents: 30698 diff changeset	736 raise ValueError("cutoff must be in [0.0, 1.0]: %r" % (cutoff,))
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	737 result = []
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	738 s = SequenceMatcher()
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	739 s.set_seq2(word)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	740 for x in possibilities:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	741 s.set_seq1(x)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	742 if s.real_quick_ratio() >= cutoff and \
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	743 s.quick_ratio() >= cutoff and \
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	744 s.ratio() >= cutoff:
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	745 result.append((s.ratio(), x))
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	746
30698 3e3fd56ce595 Let library modules use the new keyword arguments for list.sort(). Raymond Hettinger <python@rcn.com> parents: 29891 diff changeset	747 # Move the best scorers to head of list
32357 a46bde9e0c74 Reverse argument order for nsmallest() and nlargest(). Raymond Hettinger <python@rcn.com> parents: 32339 diff changeset	748 result = heapq.nlargest(n, result)
30698 3e3fd56ce595 Let library modules use the new keyword arguments for list.sort(). Raymond Hettinger <python@rcn.com> parents: 29891 diff changeset	749 # Strip scores for the best n matches
32339 408a40e65247 Apply heapq.nlargest() to find best matches. Raymond Hettinger <python@rcn.com> parents: 31515 diff changeset	750 return [x for score, x in result]
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	751
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	752 def _count_leading(line, ch):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	753 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	754 Return number of `ch` characters at the start of `line`.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	755
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	756 Example:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	757
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	758 >>> _count_leading(' abc', ' ')
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	759 3
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	760 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	761
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	762 i, n = 0, len(line)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	763 while i < n and line[i] == ch:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	764 i += 1
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	765 return i
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	766
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	767 class Differ:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	768 r"""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	769 Differ is a class for comparing sequences of lines of text, and
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	770 producing human-readable differences or deltas. Differ uses
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	771 SequenceMatcher both to compare sequences of lines, and to compare
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	772 sequences of characters within similar (near-matching) lines.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	773
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	774 Each line of a Differ delta begins with a two-letter code:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	775
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	776 '- ' line unique to sequence 1
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	777 '+ ' line unique to sequence 2
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	778 ' ' line common to both sequences
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	779 '? ' line not present in either input sequence
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	780
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	781 Lines beginning with '? ' attempt to guide the eye to intraline
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	782 differences, and were not present in either input sequence. These lines
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	783 can be confusing if the sequences contain tab characters.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	784
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	785 Note that Differ makes no claim to produce a minimal diff. To the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	786 contrary, minimal diffs are often counter-intuitive, because they synch
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	787 up anywhere possible, sometimes accidental matches 100 pages apart.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	788 Restricting synch points to contiguous matches preserves some notion of
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	789 locality, at the occasional cost of producing a longer diff.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	790
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	791 Example: Comparing two texts.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	792
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	793 First we set up the texts, sequences of individual single-line strings
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	794 ending with newlines (such sequences can also be obtained from the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	795 `readlines()` method of file-like objects):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	796
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	797 >>> text1 = ''' 1. Beautiful is better than ugly.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	798 ... 2. Explicit is better than implicit.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	799 ... 3. Simple is better than complex.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	800 ... 4. Complex is better than complicated.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	801 ... '''.splitlines(1)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	802 >>> len(text1)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	803 4
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	804 >>> text1[0][-1]
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	805 '\n'
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	806 >>> text2 = ''' 1. Beautiful is better than ugly.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	807 ... 3. Simple is better than complex.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	808 ... 4. Complicated is better than complex.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	809 ... 5. Flat is better than nested.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	810 ... '''.splitlines(1)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	811
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	812 Next we instantiate a Differ object:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	813
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	814 >>> d = Differ()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	815
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	816 Note that when instantiating a Differ object we may pass functions to
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	817 filter out line and character 'junk'. See Differ.__init__ for details.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	818
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	819 Finally, we compare the two:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	820
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	821 >>> result = list(d.compare(text1, text2))
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	822
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	823 'result' is a list of strings, so let's pretty-print it:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	824
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	825 >>> from pprint import pprint as _pprint
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	826 >>> _pprint(result)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	827 [' 1. Beautiful is better than ugly.\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	828 '- 2. Explicit is better than implicit.\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	829 '- 3. Simple is better than complex.\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	830 '+ 3. Simple is better than complex.\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	831 '? ++\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	832 '- 4. Complex is better than complicated.\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	833 '? ^ ---- ^\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	834 '+ 4. Complicated is better than complex.\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	835 '? ++++ ^ ^\n',
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	836 '+ 5. Flat is better than nested.\n']
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	837
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	838 As a single multi-line string it looks like this:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	839
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	840 >>> print ''.join(result),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	841 1. Beautiful is better than ugly.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	842 - 2. Explicit is better than implicit.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	843 - 3. Simple is better than complex.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	844 + 3. Simple is better than complex.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	845 ? ++
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	846 - 4. Complex is better than complicated.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	847 ? ^ ---- ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	848 + 4. Complicated is better than complex.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	849 ? ++++ ^ ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	850 + 5. Flat is better than nested.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	851
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	852 Methods:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	853
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	854 __init__(linejunk=None, charjunk=None)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	855 Construct a text differencer, with optional filters.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	856
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	857 compare(a, b)
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	858 Compare two sequences of lines; generate the resulting delta.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	859 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	860
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	861 def __init__(self, linejunk=None, charjunk=None):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	862 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	863 Construct a text differencer, with optional filters.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	864
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	865 The two optional keyword parameters are for filter functions:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	866
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	867 - `linejunk`: A function that should accept a single string argument,
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	868 and return true iff the string is junk. The module-level function
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	869 `IS_LINE_JUNK` may be used to filter out lines without visible
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	870 characters, except for at most one splat ('#'). It is recommended
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	871 to leave linejunk None; as of Python 2.3, the underlying
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	872 SequenceMatcher class has grown an adaptive notion of "noise" lines
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	873 that's better than any static definition the author has ever been
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	874 able to craft.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	875
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	876 - `charjunk`: A function that should accept a string of length 1. The
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	877 module-level function `IS_CHARACTER_JUNK` may be used to filter out
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	878 whitespace characters (a blank or tab; note: bad idea to include
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	879 newline in this!). Use of IS_CHARACTER_JUNK is recommended.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	880 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	881
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	882 self.linejunk = linejunk
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	883 self.charjunk = charjunk
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	884
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	885 def compare(self, a, b):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	886 r"""
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	887 Compare two sequences of lines; generate the resulting delta.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	888
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	889 Each sequence must contain individual single-line strings ending with
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	890 newlines. Such sequences can be obtained from the `readlines()` method
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	891 of file-like objects. The delta generated also consists of newline-
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	892 terminated strings, ready to be printed as-is via the writeline()
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	893 method of a file-like object.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	894
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	895 Example:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	896
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	897 >>> print ''.join(Differ().compare('one\ntwo\nthree\n'.splitlines(1),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	898 ... 'ore\ntree\nemu\n'.splitlines(1))),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	899 - one
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	900 ? ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	901 + ore
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	902 ? ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	903 - two
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	904 - three
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	905 ? -
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	906 + tree
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	907 + emu
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	908 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	909
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	910 cruncher = SequenceMatcher(self.linejunk, a, b)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	911 for tag, alo, ahi, blo, bhi in cruncher.get_opcodes():
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	912 if tag == 'replace':
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	913 g = self._fancy_replace(a, alo, ahi, b, blo, bhi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	914 elif tag == 'delete':
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	915 g = self._dump('-', a, alo, ahi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	916 elif tag == 'insert':
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	917 g = self._dump('+', b, blo, bhi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	918 elif tag == 'equal':
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	919 g = self._dump(' ', a, alo, ahi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	920 else:
31515 71a294bd7950 Replace backticks with repr() or "%r" Walter Dörwald <walter@livinglogic.de> parents: 30698 diff changeset	921 raise ValueError, 'unknown tag %r' % (tag,)
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	922
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	923 for line in g:
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	924 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	925
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	926 def _dump(self, tag, x, lo, hi):
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	927 """Generate comparison results for a same-tagged range."""
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	928 for i in xrange(lo, hi):
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	929 yield '%s %s' % (tag, x[i])
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	930
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	931 def _plain_replace(self, a, alo, ahi, b, blo, bhi):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	932 assert alo < ahi and blo < bhi
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	933 # dump the shorter block first -- reduces the burden on short-term
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	934 # memory if the blocks are of very different sizes
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	935 if bhi - blo < ahi - alo:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	936 first = self._dump('+', b, blo, bhi)
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	937 second = self._dump('-', a, alo, ahi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	938 else:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	939 first = self._dump('-', a, alo, ahi)
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	940 second = self._dump('+', b, blo, bhi)
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	941
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	942 for g in first, second:
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	943 for line in g:
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	944 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	945
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	946 def _fancy_replace(self, a, alo, ahi, b, blo, bhi):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	947 r"""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	948 When replacing one block of lines with another, search the blocks
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	949 for similar lines; the best-matching pair (if any) is used as a
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	950 synch point, and intraline difference marking is done on the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	951 similar pair. Lots of work, but often worth it.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	952
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	953 Example:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	954
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	955 >>> d = Differ()
29891 9ca291865f9c Fix faulty doctests. There is no results attribute. Raymond Hettinger <python@rcn.com> parents: 29719 diff changeset	956 >>> results = d._fancy_replace(['abcDefghiJkl\n'], 0, 1,
9ca291865f9c Fix faulty doctests. There is no results attribute. Raymond Hettinger <python@rcn.com> parents: 29719 diff changeset	957 ... ['abcdefGhijkl\n'], 0, 1)
9ca291865f9c Fix faulty doctests. There is no results attribute. Raymond Hettinger <python@rcn.com> parents: 29719 diff changeset	958 >>> print ''.join(results),
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	959 - abcDefghiJkl
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	960 ? ^ ^ ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	961 + abcdefGhijkl
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	962 ? ^ ^ ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	963 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	964
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	965 # don't synch up unless the lines have a similarity score of at
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	966 # least cutoff; best_ratio tracks the best score seen so far
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	967 best_ratio, cutoff = 0.74, 0.75
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	968 cruncher = SequenceMatcher(self.charjunk)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	969 eqi, eqj = None, None # 1st indices of equal lines (if any)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	970
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	971 # search for the pair that matches best without being identical
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	972 # (identical lines must be junk lines, & we don't want to synch up
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	973 # on junk -- unless we have to)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	974 for j in xrange(blo, bhi):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	975 bj = b[j]
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	976 cruncher.set_seq2(bj)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	977 for i in xrange(alo, ahi):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	978 ai = a[i]
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	979 if ai == bj:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	980 if eqi is None:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	981 eqi, eqj = i, j
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	982 continue
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	983 cruncher.set_seq1(ai)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	984 # computing similarity is expensive, so use the quick
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	985 # upper bounds first -- have seen this speed up messy
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	986 # compares by a factor of 3.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	987 # note that ratio() is only expensive to compute the first
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	988 # time it's called on a sequence pair; the expensive part
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	989 # of the computation is cached by cruncher
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	990 if cruncher.real_quick_ratio() > best_ratio and \
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	991 cruncher.quick_ratio() > best_ratio and \
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	992 cruncher.ratio() > best_ratio:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	993 best_ratio, best_i, best_j = cruncher.ratio(), i, j
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	994 if best_ratio < cutoff:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	995 # no non-identical "pretty close" pair
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	996 if eqi is None:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	997 # no identical pair either -- treat it as a straight replace
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	998 for line in self._plain_replace(a, alo, ahi, b, blo, bhi):
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	999 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1000 return
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1001 # no close pair, but an identical pair -- synch up on that
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1002 best_i, best_j, best_ratio = eqi, eqj, 1.0
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1003 else:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1004 # there's a close pair, so forget the identical pair (if any)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1005 eqi = None
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1006
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1007 # a[best_i] very similar to b[best_j]; eqi is None iff they're not
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1008 # identical
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1009
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1010 # pump out diffs from before the synch point
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1011 for line in self._fancy_helper(a, alo, best_i, b, blo, best_j):
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1012 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1013
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1014 # do intraline marking on the synch pair
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1015 aelt, belt = a[best_i], b[best_j]
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1016 if eqi is None:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1017 # pump out a '-', '?', '+', '?' quad for the synched lines
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1018 atags = btags = ""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1019 cruncher.set_seqs(aelt, belt)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1020 for tag, ai1, ai2, bj1, bj2 in cruncher.get_opcodes():
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1021 la, lb = ai2 - ai1, bj2 - bj1
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1022 if tag == 'replace':
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1023 atags += '^' * la
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1024 btags += '^' * lb
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1025 elif tag == 'delete':
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1026 atags += '-' * la
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1027 elif tag == 'insert':
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1028 btags += '+' * lb
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1029 elif tag == 'equal':
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1030 atags += ' ' * la
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1031 btags += ' ' * lb
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1032 else:
31515 71a294bd7950 Replace backticks with repr() or "%r" Walter Dörwald <walter@livinglogic.de> parents: 30698 diff changeset	1033 raise ValueError, 'unknown tag %r' % (tag,)
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1034 for line in self._qformat(aelt, belt, atags, btags):
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1035 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1036 else:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1037 # the synch pair is identical
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1038 yield ' ' + aelt
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1039
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1040 # pump out diffs from after the synch point
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1041 for line in self._fancy_helper(a, best_i+1, ahi, b, best_j+1, bhi):
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1042 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1043
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1044 def _fancy_helper(self, a, alo, ahi, b, blo, bhi):
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1045 g = []
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1046 if alo < ahi:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1047 if blo < bhi:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1048 g = self._fancy_replace(a, alo, ahi, b, blo, bhi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1049 else:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1050 g = self._dump('-', a, alo, ahi)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1051 elif blo < bhi:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1052 g = self._dump('+', b, blo, bhi)
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1053
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1054 for line in g:
8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1055 yield line
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1056
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1057 def _qformat(self, aline, bline, atags, btags):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1058 r"""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1059 Format "?" output and deal with leading tabs.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1060
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1061 Example:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1062
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1063 >>> d = Differ()
29891 9ca291865f9c Fix faulty doctests. There is no results attribute. Raymond Hettinger <python@rcn.com> parents: 29719 diff changeset	1064 >>> results = d._qformat('\tabcDefghiJkl\n', '\t\tabcdefGhijkl\n',
9ca291865f9c Fix faulty doctests. There is no results attribute. Raymond Hettinger <python@rcn.com> parents: 29719 diff changeset	1065 ... ' ^ ^ ^ ', '+ ^ ^ ^ ')
9ca291865f9c Fix faulty doctests. There is no results attribute. Raymond Hettinger <python@rcn.com> parents: 29719 diff changeset	1066 >>> for line in results: print repr(line)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1067 ...
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1068 '- \tabcDefghiJkl\n'
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1069 '? \t ^ ^ ^\n'
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1070 '+ \t\tabcdefGhijkl\n'
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1071 '? \t ^ ^ ^\n'
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1072 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1073
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1074 # Can hurt, but will probably help most of the time.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1075 common = min(_count_leading(aline, "\t"),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1076 _count_leading(bline, "\t"))
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1077 common = min(common, _count_leading(atags[:common], " "))
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1078 atags = atags[common:].rstrip()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1079 btags = btags[common:].rstrip()
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1080
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1081 yield "- " + aline
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1082 if atags:
20240 5c4261e74478 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 20038 diff changeset	1083 yield "? %s%s\n" % ("\t" * common, atags)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1084
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1085 yield "+ " + bline
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1086 if btags:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1087 yield "? %s%s\n" % ("\t" * common, btags)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1088
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1089 # With respect to junk, an earlier version of ndiff simply refused to
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1090 # start a match with a junk element. The result was cases like this:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1091 # before: private Thread currentThread;
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1092 # after: private volatile Thread currentThread;
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1093 # If you consider whitespace to be junk, the longest contiguous match
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1094 # not starting with junk is "e Thread currentThread". So ndiff reported
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1095 # that "e volatil" was inserted between the 't' and the 'e' in "private".
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1096 # While an accurate view, to people that's absurd. The current version
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1097 # looks for matching blocks that are entirely junk-free, then extends the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1098 # longest one of those as far as possible but only with matching junk.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1099 # So now "currentThread" is matched, then extended to suck up the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1100 # preceding blank; then "private" is matched, and extended to suck up the
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1101 # following blank; then "Thread" is matched; and finally ndiff reports
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1102 # that "volatile " was inserted before "Thread". The only quibble
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1103 # remaining is that perhaps it was really the case that " volatile"
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1104 # was inserted after "private". I can live with that <wink>.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1105
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1106 import re
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1107
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1108 def IS_LINE_JUNK(line, pat=re.compile(r"\s#?\s$").match):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1109 r"""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1110 Return 1 for ignorable line: iff `line` is blank or contains a single '#'.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1111
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1112 Examples:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1113
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1114 >>> IS_LINE_JUNK('\n')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1115 True
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1116 >>> IS_LINE_JUNK(' # \n')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1117 True
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1118 >>> IS_LINE_JUNK('hello\n')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1119 False
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1120 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1121
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1122 return pat(line) is not None
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1123
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1124 def IS_CHARACTER_JUNK(ch, ws=" \t"):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1125 r"""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1126 Return 1 for ignorable character: iff `ch` is a space or tab.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1127
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1128 Examples:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1129
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1130 >>> IS_CHARACTER_JUNK(' ')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1131 True
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1132 >>> IS_CHARACTER_JUNK('\t')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1133 True
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1134 >>> IS_CHARACTER_JUNK('\n')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1135 False
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1136 >>> IS_CHARACTER_JUNK('x')
22785 aa8d59823add Add the 'bool' type and its values 'False' and 'True', as described in Guido van Rossum <guido@python.org> parents: 22719 diff changeset	1137 False
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1138 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1139
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1140 return ch in ws
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1141
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1142
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1143 def unified_diff(a, b, fromfile='', tofile='', fromfiledate='',
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1144 tofiledate='', n=3, lineterm='\n'):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1145 r"""
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1146 Compare two sequences of lines; generate the delta as a unified diff.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1147
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1148 Unified diffs are a compact way of showing line changes and a few
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1149 lines of context. The number of context lines is set by 'n' which
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1150 defaults to three.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1151
29517 94ac1d42a420 Fix docstring Raymond Hettinger <python@rcn.com> parents: 29384 diff changeset	1152 By default, the diff control lines (those with ---, +++, or @@) are
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1153 created with a trailing newline. This is helpful so that inputs
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1154 created from file.readlines() result in diffs that are suitable for
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1155 file.writelines() since both the inputs and outputs have trailing
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1156 newlines.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1157
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1158 For inputs that do not have trailing newlines, set the lineterm
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1159 argument to "" so that the output will be uniformly newline free.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1160
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1161 The unidiff format normally has a header for filenames and modification
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1162 times. Any or all of these may be specified using strings for
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1163 'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'. The modification
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1164 times are normally expressed in the format returned by time.ctime().
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1165
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1166 Example:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1167
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1168 >>> for line in unified_diff('one two three four'.split(),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1169 ... 'zero one tree four'.split(), 'Original', 'Current',
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1170 ... 'Sat Jan 26 23:30:50 1991', 'Fri Jun 06 10:20:52 2003',
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1171 ... lineterm=''):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1172 ... print line
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1173 --- Original Sat Jan 26 23:30:50 1991
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1174 +++ Current Fri Jun 06 10:20:52 2003
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1175 @@ -1,4 +1,4 @@
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1176 +zero
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1177 one
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1178 -two
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1179 -three
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1180 +tree
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1181 four
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1182 """
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1183
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1184 started = False
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1185 for group in SequenceMatcher(None,a,b).get_grouped_opcodes(n):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1186 if not started:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1187 yield '--- %s %s%s' % (fromfile, fromfiledate, lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1188 yield '+++ %s %s%s' % (tofile, tofiledate, lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1189 started = True
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1190 i1, i2, j1, j2 = group[0][1], group[-1][2], group[0][3], group[-1][4]
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1191 yield "@@ -%d,%d +%d,%d @@%s" % (i1+1, i2-i1, j1+1, j2-j1, lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1192 for tag, i1, i2, j1, j2 in group:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1193 if tag == 'equal':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1194 for line in a[i1:i2]:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1195 yield ' ' + line
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1196 continue
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1197 if tag == 'replace' or tag == 'delete':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1198 for line in a[i1:i2]:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1199 yield '-' + line
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1200 if tag == 'replace' or tag == 'insert':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1201 for line in b[j1:j2]:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1202 yield '+' + line
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1203
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1204 # See http://www.unix.org/single_unix_specification/
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1205 def context_diff(a, b, fromfile='', tofile='',
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1206 fromfiledate='', tofiledate='', n=3, lineterm='\n'):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1207 r"""
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1208 Compare two sequences of lines; generate the delta as a context diff.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1209
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1210 Context diffs are a compact way of showing line changes and a few
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1211 lines of context. The number of context lines is set by 'n' which
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1212 defaults to three.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1213
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1214 By default, the diff control lines (those with *** or ---) are
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1215 created with a trailing newline. This is helpful so that inputs
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1216 created from file.readlines() result in diffs that are suitable for
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1217 file.writelines() since both the inputs and outputs have trailing
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1218 newlines.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1219
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1220 For inputs that do not have trailing newlines, set the lineterm
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1221 argument to "" so that the output will be uniformly newline free.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1222
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1223 The context diff format normally has a header for filenames and
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1224 modification times. Any or all of these may be specified using
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1225 strings for 'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1226 The modification times are normally expressed in the format returned
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1227 by time.ctime(). If not specified, the strings default to blanks.
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1228
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1229 Example:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1230
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1231 >>> print ''.join(context_diff('one\ntwo\nthree\nfour\n'.splitlines(1),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1232 ... 'zero\none\ntree\nfour\n'.splitlines(1), 'Original', 'Current',
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1233 ... 'Sat Jan 26 23:30:50 1991', 'Fri Jun 06 10:22:46 2003')),
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1234 *** Original Sat Jan 26 23:30:50 1991
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1235 --- Current Fri Jun 06 10:22:46 2003
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1236 ***************
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1237 * 1,4 **
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1238 one
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1239 ! two
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1240 ! three
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1241 four
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1242 --- 1,4 ----
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1243 + zero
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1244 one
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1245 ! tree
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1246 four
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1247 """
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1248
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1249 started = False
29384 2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1250 prefixmap = {'insert':'+ ', 'delete':'- ', 'replace':'! ', 'equal':' '}
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1251 for group in SequenceMatcher(None,a,b).get_grouped_opcodes(n):
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1252 if not started:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1253 yield '*** %s %s%s' % (fromfile, fromfiledate, lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1254 yield '--- %s %s%s' % (tofile, tofiledate, lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1255 started = True
29384 2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1256
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1257 yield '***************%s' % (lineterm,)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1258 if group[-1][2] - group[0][1] >= 2:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1259 yield '* %d,%d **%s' % (group[0][1]+1, group[-1][2], lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1260 else:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1261 yield '* %d **%s' % (group[-1][2], lineterm)
29384 2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1262 visiblechanges = [e for e in group if e[0] in ('replace', 'delete')]
2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1263 if visiblechanges:
2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1264 for tag, i1, i2, _, _ in group:
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1265 if tag != 'insert':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1266 for line in a[i1:i2]:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1267 yield prefixmap[tag] + line
29384 2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1268
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1269 if group[-1][4] - group[0][3] >= 2:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1270 yield '--- %d,%d ----%s' % (group[0][3]+1, group[-1][4], lineterm)
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1271 else:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1272 yield '--- %d ----%s' % (group[-1][4], lineterm)
29384 2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1273 visiblechanges = [e for e in group if e[0] in ('replace', 'insert')]
2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1274 if visiblechanges:
2d39ec0e55aa For the context and unified diff functions: Raymond Hettinger <python@rcn.com> parents: 29381 diff changeset	1275 for tag, _, _, j1, j2 in group:
29381 15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1276 if tag != 'delete':
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1277 for line in b[j1:j2]:
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1278 yield prefixmap[tag] + line
15f1dc5b7ddc Added functions for creating context diffs and unified diffs. Raymond Hettinger <python@rcn.com> parents: 25953 diff changeset	1279
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	1280 def ndiff(a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK):
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1281 r"""
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1282 Compare `a` and `b` (lists of strings); return a `Differ`-style delta.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1283
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1284 Optional keyword parameters `linejunk` and `charjunk` are for filter
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1285 functions (or None):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1286
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1287 - linejunk: A function that should accept a single string argument, and
23300 b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	1288 return true iff the string is junk. The default is None, and is
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	1289 recommended; as of Python 2.3, an adaptive notion of "noise" lines is
b5f6e9f6e7f4 Mostly in SequenceMatcher.{__chain_b, find_longest_match}: Tim Peters <tim.peters@gmail.com> parents: 22785 diff changeset	1290 used that does a good job on its own.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1291
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1292 - charjunk: A function that should accept a string of length 1. The
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1293 default is module-level function IS_CHARACTER_JUNK, which filters out
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1294 whitespace characters (a blank or tab; note: bad idea to include newline
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1295 in this!).
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1296
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1297 Tools/scripts/ndiff.py is a command-line front-end to this function.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1298
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1299 Example:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1300
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1301 >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(1),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1302 ... 'ore\ntree\nemu\n'.splitlines(1))
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1303 >>> print ''.join(diff),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1304 - one
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1305 ? ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1306 + ore
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1307 ? ^
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1308 - two
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1309 - three
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1310 ? -
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1311 + tree
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1312 + emu
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1313 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1314 return Differ(linejunk, charjunk).compare(a, b)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1315
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1316 def _mdiff(fromlines, tolines, context=None, linejunk=None,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1317 charjunk=IS_CHARACTER_JUNK):
40552 7f76996c7bf4 [Bug #1622533] Make docstrings raw strings because they contain control characters (\0, \1) Andrew M. Kuchling <amk@amk.ca> parents: 38812 diff changeset	1318 r"""Returns generator yielding marked up from/to side by side differences.
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1319
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1320 Arguments:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1321 fromlines -- list of text lines to compared to tolines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1322 tolines -- list of text lines to be compared to fromlines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1323 context -- number of context lines to display on each side of difference,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1324 if None, all from/to text lines will be generated.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1325 linejunk -- passed on to ndiff (see ndiff documentation)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1326 charjunk -- passed on to ndiff (see ndiff documentation)
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1327
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1328 This function returns an interator which returns a tuple:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1329 (from line tuple, to line tuple, boolean flag)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1330
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1331 from/to line tuple -- (line num, line text)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1332 line num -- integer or None (to indicate a context seperation)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1333 line text -- original line text with following markers inserted:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1334 '\0+' -- marks start of added text
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1335 '\0-' -- marks start of deleted text
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1336 '\0^' -- marks start of changed text
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1337 '\1' -- marks end of added/deleted/changed text
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1338
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1339 boolean flag -- None indicates context separation, True indicates
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1340 either "from" or "to" line contains a change, otherwise False.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1341
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1342 This function/iterator was originally developed to generate side by side
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1343 file difference for making HTML pages (see HtmlDiff class for example
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1344 usage).
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1345
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1346 Note, this function utilizes the ndiff function to generate the side by
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1347 side difference markup. Optional ndiff arguments may be passed to this
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1348 function and they in turn will be passed to ndiff.
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1349 """
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1350 import re
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1351
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1352 # regular expression for finding intraline change indices
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1353 change_re = re.compile('(\++\|\-+\|\^+)')
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1354
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1355 # create the difference iterator to generate the differences
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1356 diff_lines_iterator = ndiff(fromlines,tolines,linejunk,charjunk)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1357
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1358 def _make_line(lines, format_key, side, num_lines=[0,0]):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1359 """Returns line of text with user's change markup and line formatting.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1360
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1361 lines -- list of lines from the ndiff generator to produce a line of
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1362 text from. When producing the line of text to return, the
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1363 lines used are removed from this list.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1364 format_key -- '+' return first line in list with "add" markup around
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1365 the entire line.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1366 '-' return first line in list with "delete" markup around
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1367 the entire line.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1368 '?' return first line in list with add/delete/change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1369 intraline markup (indices obtained from second line)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1370 None return first line in list with no markup
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1371 side -- indice into the num_lines list (0=from,1=to)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1372 num_lines -- from/to current line number. This is NOT intended to be a
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1373 passed parameter. It is present as a keyword argument to
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1374 maintain memory of the current line numbers between calls
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1375 of this function.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1376
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1377 Note, this function is purposefully not defined at the module scope so
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1378 that data it needs from its parent function (within whose context it
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1379 is defined) does not need to be of module scope.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1380 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1381 num_lines[side] += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1382 # Handle case where no user markup is to be added, just return line of
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1383 # text with user's line format to allow for usage of the line number.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1384 if format_key is None:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1385 return (num_lines[side],lines.pop(0)[2:])
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1386 # Handle case of intraline changes
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1387 if format_key == '?':
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1388 text, markers = lines.pop(0), lines.pop(0)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1389 # find intraline changes (store change type and indices in tuples)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1390 sub_info = []
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1391 def record_sub_info(match_object,sub_info=sub_info):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1392 sub_info.append([match_object.group(1)[0],match_object.span()])
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1393 return match_object.group(1)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1394 change_re.sub(record_sub_info,markers)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1395 # process each tuple inserting our special marks that won't be
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1396 # noticed by an xml/html escaper.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1397 for key,(begin,end) in sub_info[::-1]:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1398 text = text[0:begin]+'\0'+key+text[begin:end]+'\1'+text[end:]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1399 text = text[2:]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1400 # Handle case of add/delete entire line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1401 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1402 text = lines.pop(0)[2:]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1403 # if line of text is just a newline, insert a space so there is
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1404 # something for the user to highlight and see.
33981 ec29955b8543 SF bug 1054821: difflib HtmlDiff() extra space on inserted 1 character lines Tim Peters <tim.peters@gmail.com> parents: 33448 diff changeset	1405 if not text:
ec29955b8543 SF bug 1054821: difflib HtmlDiff() extra space on inserted 1 character lines Tim Peters <tim.peters@gmail.com> parents: 33448 diff changeset	1406 text = ' '
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1407 # insert marks that won't be noticed by an xml/html escaper.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1408 text = '\0' + format_key + text + '\1'
35276 4adbd331d335 Fix all wrong instances of "it's". Georg Brandl <georg@python.org> parents: 33981 diff changeset	1409 # Return line of text, first allow user's line formatter to do its
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1410 # thing (such as adding the line number) then replace the special
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1411 # marks with what the user's change markup.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1412 return (num_lines[side],text)
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1413
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1414 def _line_iterator():
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1415 """Yields from/to lines of text with a change indication.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1416
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1417 This function is an iterator. It itself pulls lines from a
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1418 differencing iterator, processes them and yields them. When it can
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1419 it yields both a "from" and a "to" line, otherwise it will yield one
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1420 or the other. In addition to yielding the lines of from/to text, a
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1421 boolean flag is yielded to indicate if the text line(s) have
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1422 differences in them.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1423
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1424 Note, this function is purposefully not defined at the module scope so
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1425 that data it needs from its parent function (within whose context it
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1426 is defined) does not need to be of module scope.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1427 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1428 lines = []
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1429 num_blanks_pending, num_blanks_to_yield = 0, 0
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1430 while True:
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1431 # Load up next 4 lines so we can look ahead, create strings which
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1432 # are a concatenation of the first character of each of the 4 lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1433 # so we can do some very readable comparisons.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1434 while len(lines) < 4:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1435 try:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1436 lines.append(diff_lines_iterator.next())
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1437 except StopIteration:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1438 lines.append('X')
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1439 s = ''.join([line[0] for line in lines])
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1440 if s.startswith('X'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1441 # When no more lines, pump out any remaining blank lines so the
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1442 # corresponding add/delete lines get a matching blank line so
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1443 # all line pairs get yielded at the next level.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1444 num_blanks_to_yield = num_blanks_pending
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1445 elif s.startswith('-?+?'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1446 # simple intraline change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1447 yield _make_line(lines,'?',0), _make_line(lines,'?',1), True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1448 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1449 elif s.startswith('--++'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1450 # in delete block, add block coming: we do NOT want to get
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1451 # caught up on blank lines yet, just process the delete line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1452 num_blanks_pending -= 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1453 yield _make_line(lines,'-',0), None, True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1454 continue
38704 ba6eebf7c719 Make use of new str.startswith/endswith semantics. Georg Brandl <georg@python.org> parents: 36429 diff changeset	1455 elif s.startswith(('--?+', '--+', '- ')):
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1456 # in delete block and see a intraline change or unchanged line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1457 # coming: yield the delete line and then blanks
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1458 from_line,to_line = _make_line(lines,'-',0), None
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1459 num_blanks_to_yield,num_blanks_pending = num_blanks_pending-1,0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1460 elif s.startswith('-+?'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1461 # intraline change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1462 yield _make_line(lines,None,0), _make_line(lines,'?',1), True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1463 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1464 elif s.startswith('-?+'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1465 # intraline change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1466 yield _make_line(lines,'?',0), _make_line(lines,None,1), True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1467 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1468 elif s.startswith('-'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1469 # delete FROM line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1470 num_blanks_pending -= 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1471 yield _make_line(lines,'-',0), None, True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1472 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1473 elif s.startswith('+--'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1474 # in add block, delete block coming: we do NOT want to get
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1475 # caught up on blank lines yet, just process the add line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1476 num_blanks_pending += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1477 yield None, _make_line(lines,'+',1), True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1478 continue
38704 ba6eebf7c719 Make use of new str.startswith/endswith semantics. Georg Brandl <georg@python.org> parents: 36429 diff changeset	1479 elif s.startswith(('+ ', '+-')):
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1480 # will be leaving an add block: yield blanks then add line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1481 from_line, to_line = None, _make_line(lines,'+',1)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1482 num_blanks_to_yield,num_blanks_pending = num_blanks_pending+1,0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1483 elif s.startswith('+'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1484 # inside an add block, yield the add line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1485 num_blanks_pending += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1486 yield None, _make_line(lines,'+',1), True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1487 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1488 elif s.startswith(' '):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1489 # unchanged text, yield it to both sides
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1490 yield _make_line(lines[:],None,0),_make_line(lines,None,1),False
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1491 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1492 # Catch up on the blank lines so when we yield the next from/to
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1493 # pair, they are lined up.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1494 while(num_blanks_to_yield < 0):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1495 num_blanks_to_yield += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1496 yield None,('','\n'),True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1497 while(num_blanks_to_yield > 0):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1498 num_blanks_to_yield -= 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1499 yield ('','\n'),None,True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1500 if s.startswith('X'):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1501 raise StopIteration
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1502 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1503 yield from_line,to_line,True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1504
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1505 def _line_pair_iterator():
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1506 """Yields from/to lines of text with a change indication.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1507
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1508 This function is an iterator. It itself pulls lines from the line
35276 4adbd331d335 Fix all wrong instances of "it's". Georg Brandl <georg@python.org> parents: 33981 diff changeset	1509 iterator. Its difference from that iterator is that this function
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1510 always yields a pair of from/to text lines (with the change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1511 indication). If necessary it will collect single from/to lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1512 until it has a matching pair from/to pair to yield.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1513
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1514 Note, this function is purposefully not defined at the module scope so
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1515 that data it needs from its parent function (within whose context it
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1516 is defined) does not need to be of module scope.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1517 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1518 line_iterator = _line_iterator()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1519 fromlines,tolines=[],[]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1520 while True:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1521 # Collecting lines of text until we have a from/to pair
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1522 while (len(fromlines)==0 or len(tolines)==0):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1523 from_line, to_line, found_diff =line_iterator.next()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1524 if from_line is not None:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1525 fromlines.append((from_line,found_diff))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1526 if to_line is not None:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1527 tolines.append((to_line,found_diff))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1528 # Once we have a pair, remove them from the collection and yield it
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1529 from_line, fromDiff = fromlines.pop(0)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1530 to_line, to_diff = tolines.pop(0)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1531 yield (from_line,to_line,fromDiff or to_diff)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1532
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1533 # Handle case where user does not want context differencing, just yield
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1534 # them up without doing anything else with them.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1535 line_pair_iterator = _line_pair_iterator()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1536 if context is None:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1537 while True:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1538 yield line_pair_iterator.next()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1539 # Handle case where user wants context differencing. We must do some
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1540 # storage of lines until we know for sure that they are to be yielded.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1541 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1542 context += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1543 lines_to_write = 0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1544 while True:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1545 # Store lines up until we find a difference, note use of a
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1546 # circular queue because we only need to keep around what
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1547 # we need for context.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1548 index, contextLines = 0, [None]*(context)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1549 found_diff = False
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1550 while(found_diff is False):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1551 from_line, to_line, found_diff = line_pair_iterator.next()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1552 i = index % context
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1553 contextLines[i] = (from_line, to_line, found_diff)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1554 index += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1555 # Yield lines that we have collected so far, but first yield
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1556 # the user's separator.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1557 if index > context:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1558 yield None, None, None
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1559 lines_to_write = context
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1560 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1561 lines_to_write = index
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1562 index = 0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1563 while(lines_to_write):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1564 i = index % context
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1565 index += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1566 yield contextLines[i]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1567 lines_to_write -= 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1568 # Now yield the context lines after the change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1569 lines_to_write = context-1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1570 while(lines_to_write):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1571 from_line, to_line, found_diff = line_pair_iterator.next()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1572 # If another change within the context, extend the context
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1573 if found_diff:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1574 lines_to_write = context-1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1575 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1576 lines_to_write -= 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1577 yield from_line, to_line, found_diff
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1578
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1579
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1580 _file_template = """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1581 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1582 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1583
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1584 <html>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1585
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1586 <head>
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1587 <meta http-equiv="Content-Type"
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1588 content="text/html; charset=ISO-8859-1" />
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1589 <title></title>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1590 <style type="text/css">%(styles)s
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1591 </style>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1592 </head>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1593
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1594 <body>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1595 %(table)s%(legend)s
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1596 </body>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1597
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1598 </html>"""
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1599
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1600 _styles = """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1601 table.diff {font-family:Courier; border:medium;}
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1602 .diff_header {background-color:#e0e0e0}
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1603 td.diff_header {text-align:right}
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1604 .diff_next {background-color:#c0c0c0}
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1605 .diff_add {background-color:#aaffaa}
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1606 .diff_chg {background-color:#ffff77}
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1607 .diff_sub {background-color:#ffaaaa}"""
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1608
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1609 _table_template = """
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1610 <table class="diff" id="difflib_chg_%(prefix)s_top"
787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1611 cellspacing="0" cellpadding="0" rules="groups" >
787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1612 <colgroup></colgroup> <colgroup></colgroup> <colgroup></colgroup>
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1613 <colgroup></colgroup> <colgroup></colgroup> <colgroup></colgroup>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1614 %(header_row)s
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1615 <tbody>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1616 %(data_rows)s </tbody>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1617 </table>"""
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1618
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1619 _legend = """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1620 <table class="diff" summary="Legends">
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1621 <tr> <th colspan="2"> Legends </th> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1622 <tr> <td> <table border="" summary="Colors">
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1623 <tr><th> Colors </th> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1624 <tr><td class="diff_add"> Added </td></tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1625 <tr><td class="diff_chg">Changed</td> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1626 <tr><td class="diff_sub">Deleted</td> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1627 </table></td>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1628 <td> <table border="" summary="Links">
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1629 <tr><th colspan="2"> Links </th> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1630 <tr><td>(f)irst change</td> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1631 <tr><td>(n)ext change</td> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1632 <tr><td>(t)op</td> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1633 </table></td> </tr>
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1634 </table>"""
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1635
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1636 class HtmlDiff(object):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1637 """For producing HTML side by side comparison with change highlights.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1638
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1639 This class can be used to create an HTML table (or a complete HTML file
33448 5570fae1f01c Typo fix: 'comparisions' is not a word Andrew M. Kuchling <amk@amk.ca> parents: 33326 diff changeset	1640 containing the table) showing a side by side, line by line comparison
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1641 of text with inter-line and intra-line change highlights. The table can
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1642 be generated in either full or contextual difference mode.
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1643
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1644 The following methods are provided for HTML generation:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1645
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1646 make_table -- generates HTML for a single side by side table
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1647 make_file -- generates complete HTML file with a single side by side table
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1648
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1649 See tools/scripts/diff.py for an example usage of this class.
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1650 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1651
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1652 _file_template = _file_template
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1653 _styles = _styles
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1654 _table_template = _table_template
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1655 _legend = _legend
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1656 _default_prefix = 0
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1657
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1658 def __init__(self,tabsize=8,wrapcolumn=None,linejunk=None,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1659 charjunk=IS_CHARACTER_JUNK):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1660 """HtmlDiff instance initializer
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1661
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1662 Arguments:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1663 tabsize -- tab stop spacing, defaults to 8.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1664 wrapcolumn -- column number where lines are broken and wrapped,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1665 defaults to None where lines are not wrapped.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1666 linejunk,charjunk -- keyword arguments passed into ndiff() (used to by
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1667 HtmlDiff() to generate the side by side HTML differences). See
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1668 ndiff() documentation for argument default values and descriptions.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1669 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1670 self._tabsize = tabsize
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1671 self._wrapcolumn = wrapcolumn
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1672 self._linejunk = linejunk
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1673 self._charjunk = charjunk
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1674
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1675 def make_file(self,fromlines,tolines,fromdesc='',todesc='',context=False,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1676 numlines=5):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1677 """Returns HTML file of side by side comparison with change highlights
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1678
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1679 Arguments:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1680 fromlines -- list of "from" lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1681 tolines -- list of "to" lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1682 fromdesc -- "from" file column header string
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1683 todesc -- "to" file column header string
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1684 context -- set to True for contextual differences (defaults to False
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1685 which shows full differences).
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1686 numlines -- number of context lines. When context is set True,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1687 controls number of lines displayed before and after the change.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1688 When context is False, controls the number of lines to place
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1689 the "next" link anchors before the next change (so click of
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1690 "next" link jumps to just before the change).
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1691 """
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1692
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1693 return self._file_template % dict(
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1694 styles = self._styles,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1695 legend = self._legend,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1696 table = self.make_table(fromlines,tolines,fromdesc,todesc,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1697 context=context,numlines=numlines))
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1698
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1699 def _tab_newline_replace(self,fromlines,tolines):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1700 """Returns from/to line lists with tabs expanded and newlines removed.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1701
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1702 Instead of tab characters being replaced by the number of spaces
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1703 needed to fill in to the next tab stop, this function will fill
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1704 the space with tab characters. This is done so that the difference
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1705 algorithms can identify changes in a file when tabs are replaced by
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1706 spaces and vice versa. At the end of the HTML generation, the tab
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1707 characters will be replaced with a nonbreakable space.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1708 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1709 def expand_tabs(line):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1710 # hide real spaces
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1711 line = line.replace(' ','\0')
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1712 # expand tabs into spaces
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1713 line = line.expandtabs(self._tabsize)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1714 # relace spaces from expanded tabs back into tab characters
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1715 # (we'll replace them with markup after we do differencing)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1716 line = line.replace(' ','\t')
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1717 return line.replace('\0',' ').rstrip('\n')
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1718 fromlines = [expand_tabs(line) for line in fromlines]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1719 tolines = [expand_tabs(line) for line in tolines]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1720 return fromlines,tolines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1721
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1722 def _split_line(self,data_list,line_num,text):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1723 """Builds list of text lines by splitting text lines at wrap point
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1724
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1725 This function will determine if the input text line needs to be
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1726 wrapped (split) into separate lines. If so, the first wrap point
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1727 will be determined and the first line appended to the output
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1728 text line list. This function is used recursively to handle
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1729 the second part of the split line to further split it.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1730 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1731 # if blank line or context separator, just add it to the output list
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1732 if not line_num:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1733 data_list.append((line_num,text))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1734 return
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1735
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1736 # if line text doesn't need wrapping, just add it to the output list
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1737 size = len(text)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1738 max = self._wrapcolumn
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1739 if (size <= max) or ((size -(text.count('\0')*3)) <= max):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1740 data_list.append((line_num,text))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1741 return
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1742
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1743 # scan text looking for the wrap point, keeping track if the wrap
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1744 # point is inside markers
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1745 i = 0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1746 n = 0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1747 mark = ''
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1748 while n < max and i < size:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1749 if text[i] == '\0':
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1750 i += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1751 mark = text[i]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1752 i += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1753 elif text[i] == '\1':
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1754 i += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1755 mark = ''
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1756 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1757 i += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1758 n += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1759
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1760 # wrap point is inside text, break it up into separate lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1761 line1 = text[:i]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1762 line2 = text[i:]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1763
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1764 # if wrap point is inside markers, place end marker at end of first
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1765 # line and start marker at beginning of second line because each
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1766 # line will have its own table tag markup around it.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1767 if mark:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1768 line1 = line1 + '\1'
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1769 line2 = '\0' + mark + line2
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1770
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1771 # tack on first line onto the output list
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1772 data_list.append((line_num,line1))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1773
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1774 # use this routine again to wrap the remaining text
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1775 self._split_line(data_list,'>',line2)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1776
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1777 def _line_wrapper(self,diffs):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1778 """Returns iterator that splits (wraps) mdiff text lines"""
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1779
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1780 # pull from/to data and flags from mdiff iterator
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1781 for fromdata,todata,flag in diffs:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1782 # check for context separators and pass them through
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1783 if flag is None:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1784 yield fromdata,todata,flag
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1785 continue
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1786 (fromline,fromtext),(toline,totext) = fromdata,todata
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1787 # for each from/to line split it at the wrap column to form
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1788 # list of text lines.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1789 fromlist,tolist = [],[]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1790 self._split_line(fromlist,fromline,fromtext)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1791 self._split_line(tolist,toline,totext)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1792 # yield from/to line in pairs inserting blank lines as
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1793 # necessary when one side has more wrapped lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1794 while fromlist or tolist:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1795 if fromlist:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1796 fromdata = fromlist.pop(0)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1797 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1798 fromdata = ('',' ')
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1799 if tolist:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1800 todata = tolist.pop(0)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1801 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1802 todata = ('',' ')
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1803 yield fromdata,todata,flag
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1804
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1805 def _collect_lines(self,diffs):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1806 """Collects mdiff output into separate lists
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1807
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1808 Before storing the mdiff from/to data into a list, it is converted
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1809 into a single line of text with HTML markup.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1810 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1811
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1812 fromlist,tolist,flaglist = [],[],[]
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1813 # pull from/to data and flags from mdiff style iterator
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1814 for fromdata,todata,flag in diffs:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1815 try:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1816 # store HTML markup of the lines into the lists
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1817 fromlist.append(self._format_line(0,flag,*fromdata))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1818 tolist.append(self._format_line(1,flag,*todata))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1819 except TypeError:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1820 # exceptions occur for lines where context separators go
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1821 fromlist.append(None)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1822 tolist.append(None)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1823 flaglist.append(flag)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1824 return fromlist,tolist,flaglist
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1825
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1826 def _format_line(self,side,flag,linenum,text):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1827 """Returns HTML markup of "from" / "to" text lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1828
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1829 side -- 0 or 1 indicating "from" or "to" text
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1830 flag -- indicates if difference on line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1831 linenum -- line number (used for line number column)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1832 text -- line text to be marked up
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1833 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1834 try:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1835 linenum = '%d' % linenum
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1836 id = ' id="%s%s"' % (self._prefix[side],linenum)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1837 except TypeError:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1838 # handle blank lines where linenum is '>' or ''
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1839 id = ''
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1840 # replace those things that would get confused with HTML symbols
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1841 text=text.replace("&","&").replace(">",">").replace("<","<")
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1842
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1843 # make space non-breakable so they don't get compressed or line wrapped
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1844 text = text.replace(' ',' ').rstrip()
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1845
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1846 return '<td class="diff_header"%s>%s</td><td nowrap="nowrap">%s</td>' \
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1847 % (id,linenum,text)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1848
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1849 def _make_prefix(self):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1850 """Create unique anchor prefixes"""
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1851
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1852 # Generate a unique anchor prefix so multiple tables
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1853 # can exist on the same HTML page without conflicts.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1854 fromprefix = "from%d_" % HtmlDiff._default_prefix
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1855 toprefix = "to%d_" % HtmlDiff._default_prefix
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1856 HtmlDiff._default_prefix += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1857 # store prefixes so line format method has access
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1858 self._prefix = [fromprefix,toprefix]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1859
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1860 def _convert_flags(self,fromlist,tolist,flaglist,context,numlines):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1861 """Makes list of "next" links"""
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1862
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1863 # all anchor names will be generated using the unique "to" prefix
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1864 toprefix = self._prefix[1]
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1865
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1866 # process change flags, generating middle column of next anchors/links
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1867 next_id = ['']*len(flaglist)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1868 next_href = ['']*len(flaglist)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1869 num_chg, in_change = 0, False
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1870 last = 0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1871 for i,flag in enumerate(flaglist):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1872 if flag:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1873 if not in_change:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1874 in_change = True
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1875 last = i
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1876 # at the beginning of a change, drop an anchor a few lines
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1877 # (the context lines) before the change for the previous
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1878 # link
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1879 i = max([0,i-numlines])
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1880 next_id[i] = ' id="difflib_chg_%s_%d"' % (toprefix,num_chg)
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1881 # at the beginning of a change, drop a link to the next
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1882 # change
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1883 num_chg += 1
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1884 next_href[last] = '<a href="#difflib_chg_%s_%d">n</a>' % (
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1885 toprefix,num_chg)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1886 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1887 in_change = False
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1888 # check for cases where there is no content to avoid exceptions
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1889 if not flaglist:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1890 flaglist = [False]
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1891 next_id = ['']
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1892 next_href = ['']
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1893 last = 0
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1894 if context:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1895 fromlist = ['<td></td><td> No Differences Found </td>']
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1896 tolist = fromlist
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1897 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1898 fromlist = tolist = ['<td></td><td> Empty File </td>']
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1899 # if not a change on first line, drop a link
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1900 if not flaglist[0]:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1901 next_href[0] = '<a href="#difflib_chg_%s_0">f</a>' % toprefix
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1902 # redo the last link to link to the top
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1903 next_href[last] = '<a href="#difflib_chg_%s_top">t</a>' % (toprefix)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1904
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1905 return fromlist,tolist,flaglist,next_href,next_id
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1906
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1907 def make_table(self,fromlines,tolines,fromdesc='',todesc='',context=False,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1908 numlines=5):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1909 """Returns HTML table of side by side comparison with change highlights
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1910
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1911 Arguments:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1912 fromlines -- list of "from" lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1913 tolines -- list of "to" lines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1914 fromdesc -- "from" file column header string
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1915 todesc -- "to" file column header string
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1916 context -- set to True for contextual differences (defaults to False
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1917 which shows full differences).
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1918 numlines -- number of context lines. When context is set True,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1919 controls number of lines displayed before and after the change.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1920 When context is False, controls the number of lines to place
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1921 the "next" link anchors before the next change (so click of
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1922 "next" link jumps to just before the change).
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1923 """
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1924
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1925 # make unique anchor prefixes so that multiple tables may exist
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1926 # on the same page without conflict.
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1927 self._make_prefix()
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1928
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1929 # change tabs to spaces before it gets more difficult after we insert
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1930 # markkup
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1931 fromlines,tolines = self._tab_newline_replace(fromlines,tolines)
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1932
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1933 # create diffs iterator which generates side by side from/to data
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1934 if context:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1935 context_lines = numlines
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1936 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1937 context_lines = None
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1938 diffs = _mdiff(fromlines,tolines,context_lines,linejunk=self._linejunk,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1939 charjunk=self._charjunk)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1940
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1941 # set up iterator to wrap lines that exceed desired width
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1942 if self._wrapcolumn:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1943 diffs = self._line_wrapper(diffs)
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1944
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1945 # collect up from/to lines and flags into lists (also format the lines)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1946 fromlist,tolist,flaglist = self._collect_lines(diffs)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1947
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1948 # process change flags, generating middle column of next anchors/links
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1949 fromlist,tolist,flaglist,next_href,next_id = self._convert_flags(
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1950 fromlist,tolist,flaglist,context,numlines)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1951
41078 f2ba812f7200 SF #1637850: make_table in difflib did not work with unicode Raymond Hettinger <python@rcn.com> parents: 40552 diff changeset	1952 s = []
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1953 fmt = ' <tr><td class="diff_next"%s>%s</td>%s' + \
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1954 '<td class="diff_next">%s</td>%s</tr>\n'
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1955 for i in range(len(flaglist)):
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1956 if flaglist[i] is None:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1957 # mdiff yields None on separator lines skip the bogus ones
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1958 # generated for the first line
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1959 if i > 0:
41078 f2ba812f7200 SF #1637850: make_table in difflib did not work with unicode Raymond Hettinger <python@rcn.com> parents: 40552 diff changeset	1960 s.append(' </tbody> \n <tbody>\n')
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1961 else:
41078 f2ba812f7200 SF #1637850: make_table in difflib did not work with unicode Raymond Hettinger <python@rcn.com> parents: 40552 diff changeset	1962 s.append( fmt % (next_id[i],next_href[i],fromlist[i],
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1963 next_href[i],tolist[i]))
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1964 if fromdesc or todesc:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1965 header_row = '<thead><tr>%s%s%s%s</tr></thead>' % (
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1966 '<th class="diff_next"><br /></th>',
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1967 '<th colspan="2" class="diff_header">%s</th>' % fromdesc,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1968 '<th class="diff_next"><br /></th>',
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1969 '<th colspan="2" class="diff_header">%s</th>' % todesc)
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1970 else:
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1971 header_row = ''
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1972
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1973 table = self._table_template % dict(
41078 f2ba812f7200 SF #1637850: make_table in difflib did not work with unicode Raymond Hettinger <python@rcn.com> parents: 40552 diff changeset	1974 data_rows=''.join(s),
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1975 header_row=header_row,
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1976 prefix=self._prefix[1])
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1977
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1978 return table.replace('\0+','<span class="diff_add">'). \
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1979 replace('\0-','<span class="diff_sub">'). \
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1980 replace('\0^','<span class="diff_chg">'). \
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1981 replace('\1','</span>'). \
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1982 replace('\t',' ')
33326 787fff51bf2a Whitespace normalization. test_difflib passes again. Tim Peters <tim.peters@gmail.com> parents: 33324 diff changeset	1983
33319 6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1984 del re
6d3bdd19beeb Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. Martin v. Löwis <martin@v.loewis.de> parents: 32867 diff changeset	1985
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1986 def restore(delta, which):
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1987 r"""
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1988 Generate one of the two sequences that generated a delta.
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1989
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1990 Given a `delta` produced by `Differ.compare()` or `ndiff()`, extract
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1991 lines originating from file 1 or 2 (parameter `which`), stripping off line
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1992 prefixes.
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1993
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1994 Examples:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1995
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1996 >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(1),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1997 ... 'ore\ntree\nemu\n'.splitlines(1))
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	1998 >>> diff = list(diff)
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	1999 >>> print ''.join(restore(diff, 1)),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2000 one
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2001 two
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2002 three
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2003 >>> print ''.join(restore(diff, 2)),
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2004 ore
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2005 tree
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2006 emu
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2007 """
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2008 try:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2009 tag = {1: "- ", 2: "+ "}[int(which)]
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2010 except KeyError:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2011 raise ValueError, ('unknown delta choice (must be 1 or 2): %r'
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2012 % which)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2013 prefixes = (" ", tag)
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2014 for line in delta:
50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2015 if line[:2] in prefixes:
20038 8a6f2ee6eaba Make difflib.ndiff() and difflib.Differ.compare() generators. This Tim Peters <tim.peters@gmail.com> parents: 19200 diff changeset	2016 yield line[2:]
19200 50fb4683a461 SF patch #445412 extract ndiff functionality to difflib, from Tim Peters <tim.peters@gmail.com> parents: 16703 diff changeset	2017
16551 7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2018 def _test():
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2019 import doctest, difflib
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2020 return doctest.testmod(difflib)
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2021
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2022 if __name__ == "__main__":
7de5043827f7 Moved SequenceMatcher from ndiff into new std library module difflib.py. Tim Peters <tim.peters@gmail.com> parents: diff changeset	2023 _test()

Mercurial > cpython-lru_cache-weakref

annotate Lib/difflib.py @ 49955:878d40468c4e legacy-trunk