difflib
index
/usr/lib/python2.2/difflib.py

 
Classes
            
Differ
SequenceMatcher
 
class Differ
      Differ is a class for comparing sequences of lines of text, and
producing human-readable differences or deltas.  Differ uses
SequenceMatcher both to compare sequences of lines, and to compare
sequences of characters within similar (near-matching) lines.
 
Each line of a Differ delta begins with a two-letter code:
 
    '- '    line unique to sequence 1
    '+ '    line unique to sequence 2
    '  '    line common to both sequences
    '? '    line not present in either input sequence
 
Lines beginning with '? ' attempt to guide the eye to intraline
differences, and were not present in either input sequence.  These lines
can be confusing if the sequences contain tab characters.
 
Note that Differ makes no claim to produce a *minimal* diff.  To the
contrary, minimal diffs are often counter-intuitive, because they synch
up anywhere possible, sometimes accidental matches 100 pages apart.
Restricting synch points to contiguous matches preserves some notion of
locality, at the occasional cost of producing a longer diff.
 
Example: Comparing two texts.
 
First we set up the texts, sequences of individual single-line strings
ending with newlines (such sequences can also be obtained from the
`readlines()` method of file-like objects):
 
>>> text1 = '''  1. Beautiful is better than ugly.
...   2. Explicit is better than implicit.
...   3. Simple is better than complex.
...   4. Complex is better than complicated.
... '''.splitlines(1)
>>> len(text1)
4
>>> text1[0][-1]
'\n'
>>> text2 = '''  1. Beautiful is better than ugly.
...   3.   Simple is better than complex.
...   4. Complicated is better than complex.
...   5. Flat is better than nested.
... '''.splitlines(1)
 
Next we instantiate a Differ object:
 
>>> d = Differ()
 
Note that when instantiating a Differ object we may pass functions to
filter out line and character 'junk'.  See Differ.__init__ for details.
 
Finally, we compare the two:
 
>>> result = list(d.compare(text1, text2))
 
'result' is a list of strings, so let's pretty-print it:
 
>>> from pprint import pprint as _pprint
>>> _pprint(result)
['    1. Beautiful is better than ugly.\n',
 '-   2. Explicit is better than implicit.\n',
 '-   3. Simple is better than complex.\n',
 '+   3.   Simple is better than complex.\n',
 '?     ++\n',
 '-   4. Complex is better than complicated.\n',
 '?            ^                     ---- ^\n',
 '+   4. Complicated is better than complex.\n',
 '?           ++++ ^                      ^\n',
 '+   5. Flat is better than nested.\n']
 
As a single multi-line string it looks like this:
 
>>> print ''.join(result),
    1. Beautiful is better than ugly.
-   2. Explicit is better than implicit.
-   3. Simple is better than complex.
+   3.   Simple is better than complex.
?     ++
-   4. Complex is better than complicated.
?            ^                     ---- ^
+   4. Complicated is better than complex.
?           ++++ ^                      ^
+   5. Flat is better than nested.
 
Methods:
 
__init__(linejunk=None, charjunk=None)
    Construct a text differencer, with optional filters.
 
compare(a, b)
    Compare two sequences of lines; generate the resulting delta.
 
   Methods defined here:
__init__(self, linejunk=None, charjunk=None)
Construct a text differencer, with optional filters.
 
The two optional keyword parameters are for filter functions:
 
- `linejunk`: A function that should accept a single string argument,
  and return true iff the string is junk. The module-level function
  `IS_LINE_JUNK` may be used to filter out lines without visible
  characters, except for at most one splat ('#').
 
- `charjunk`: A function that should accept a string of length 1. The
  module-level function `IS_CHARACTER_JUNK` may be used to filter out
  whitespace characters (a blank or tab; **note**: bad idea to include
  newline in this!).
_dump(self, tag, x, lo, hi)
Generate comparison results for a same-tagged range.
_fancy_helper(self, a, alo, ahi, b, blo, bhi)
_fancy_replace(self, a, alo, ahi, b, blo, bhi)
When replacing one block of lines with another, search the blocks
for *similar* lines; the best-matching pair (if any) is used as a
synch point, and intraline difference marking is done on the
similar pair. Lots of work, but often worth it.
 
Example:
 
>>> d = Differ()
>>> d._fancy_replace(['abcDefghiJkl\n'], 0, 1, ['abcdefGhijkl\n'], 0, 1)
>>> print ''.join(d.results),
- abcDefghiJkl
?    ^  ^  ^
+ abcdefGhijkl
?    ^  ^  ^
_plain_replace(self, a, alo, ahi, b, blo, bhi)
_qformat(self, aline, bline, atags, btags)
Format "?" output and deal with leading tabs.
 
Example:
 
>>> d = Differ()
>>> d._qformat('\tabcDefghiJkl\n', '\t\tabcdefGhijkl\n',
...            '  ^ ^  ^      ', '+  ^ ^  ^      ')
>>> for line in d.results: print repr(line)
...
'- \tabcDefghiJkl\n'
'? \t ^ ^  ^\n'
'+ \t\tabcdefGhijkl\n'
'? \t  ^ ^  ^\n'
compare(self, a, b)
Compare two sequences of lines; generate the resulting delta.
 
Each sequence must contain individual single-line strings ending with
newlines. Such sequences can be obtained from the `readlines()` method
of file-like objects.  The delta generated also consists of newline-
terminated strings, ready to be printed as-is via the writeline()
method of a file-like object.
 
Example:
 
>>> print ''.join(Differ().compare('one\ntwo\nthree\n'.splitlines(1),
...                                'ore\ntree\nemu\n'.splitlines(1))),
- one
?  ^
+ ore
?  ^
- two
- three
?  -
+ tree
+ emu

Data and non-method functions defined here:
__doc__ = '\n Differ is a class for comparing sequences...es of lines; generate the resulting delta.\n '
__module__ = 'difflib'
 
class SequenceMatcher
      SequenceMatcher is a flexible class for comparing pairs of sequences of
any type, so long as the sequence elements are hashable.  The basic
algorithm predates, and is a little fancier than, an algorithm
published in the late 1980's by Ratcliff and Obershelp under the
hyperbolic name "gestalt pattern matching".  The basic idea is to find
the longest contiguous matching subsequence that contains no "junk"
elements (R-O doesn't address junk).  The same idea is then applied
recursively to the pieces of the sequences to the left and to the right
of the matching subsequence.  This does not yield minimal edit
sequences, but does tend to yield matches that "look right" to people.
 
SequenceMatcher tries to compute a "human-friendly diff" between two
sequences.  Unlike e.g. UNIX(tm) diff, the fundamental notion is the
longest *contiguous* & junk-free matching subsequence.  That's what
catches peoples' eyes.  The Windows(tm) windiff has another interesting
notion, pairing up elements that appear uniquely in each sequence.
That, and the method here, appear to yield more intuitive difference
reports than does diff.  This method appears to be the least vulnerable
to synching up on blocks of "junk lines", though (like blank lines in
ordinary text files, or maybe "<P>" lines in HTML files).  That may be
because this is the only method of the 3 that has a *concept* of
"junk" <wink>.
 
Example, comparing two strings, and considering blanks to be "junk":
 
>>> s = SequenceMatcher(lambda x: x == " ",
...                     "private Thread currentThread;",
...                     "private volatile Thread currentThread;")
>>>
 
.ratio() returns a float in [0, 1], measuring the "similarity" of the
sequences.  As a rule of thumb, a .ratio() value over 0.6 means the
sequences are close matches:
 
>>> print round(s.ratio(), 3)
0.866
>>>
 
If you're only interested in where the sequences match,
.get_matching_blocks() is handy:
 
>>> for block in s.get_matching_blocks():
...     print "a[%d] and b[%d] match for %d elements" % block
a[0] and b[0] match for 8 elements
a[8] and b[17] match for 6 elements
a[14] and b[23] match for 15 elements
a[29] and b[38] match for 0 elements
 
Note that the last tuple returned by .get_matching_blocks() is always a
dummy, (len(a), len(b), 0), and this is the only case in which the last
tuple element (number of elements matched) is 0.
 
If you want to know how to change the first sequence into the second,
use .get_opcodes():
 
>>> for opcode in s.get_opcodes():
...     print "%6s a[%d:%d] b[%d:%d]" % opcode
 equal a[0:8] b[0:8]
insert a[8:8] b[8:17]
 equal a[8:14] b[17:23]
 equal a[14:29] b[23:38]
 
See the Differ class for a fancy human-friendly file differencer, which
uses SequenceMatcher both to compare sequences of lines, and to compare
sequences of characters within similar (near-matching) lines.
 
See also function get_close_matches() in this module, which shows how
simple code building on SequenceMatcher can be used to do useful work.
 
Timing:  Basic R-O is cubic time worst case and quadratic time expected
case.  SequenceMatcher is quadratic time for the worst case and has
expected-case behavior dependent in a complicated way on how many
elements the sequences have in common; best case time is linear.
 
Methods:
 
__init__(isjunk=None, a='', b='')
    Construct a SequenceMatcher.
 
set_seqs(a, b)
    Set the two sequences to be compared.
 
set_seq1(a)
    Set the first sequence to be compared.
 
set_seq2(b)
    Set the second sequence to be compared.
 
find_longest_match(alo, ahi, blo, bhi)
    Find longest matching block in a[alo:ahi] and b[blo:bhi].
 
get_matching_blocks()
    Return list of triples describing matching subsequences.
 
get_opcodes()
    Return list of 5-tuples describing how to turn a into b.
 
ratio()
    Return a measure of the sequences' similarity (float in [0,1]).
 
quick_ratio()
    Return an upper bound on .ratio() relatively quickly.
 
real_quick_ratio()
    Return an upper bound on ratio() very quickly.
 
   Methods defined here:
_SequenceMatcher__chain_b = __chain_b(self)
_SequenceMatcher__helper = __helper(self, alo, ahi, blo, bhi, answer)
__init__(self, isjunk=None, a='', b='')
Construct a SequenceMatcher.
 
Optional arg isjunk is None (the default), or a one-argument
function that takes a sequence element and returns true iff the
element is junk.  None is equivalent to passing "lambda x: 0", i.e.
no elements are considered to be junk.  For example, pass
    lambda x: x in " \t"
if you're comparing lines as sequences of characters, and don't
want to synch up on blanks or hard tabs.
 
Optional arg a is the first of two sequences to be compared.  By
default, an empty string.  The elements of a must be hashable.  See
also .set_seqs() and .set_seq1().
 
Optional arg b is the second of two sequences to be compared.  By
default, an empty string.  The elements of b must be hashable. See
also .set_seqs() and .set_seq2().
find_longest_match(self, alo, ahi, blo, bhi)
Find longest matching block in a[alo:ahi] and b[blo:bhi].
 
If isjunk is not defined:
 
Return (i,j,k) such that a[i:i+k] is equal to b[j:j+k], where
    alo <= i <= i+k <= ahi
    blo <= j <= j+k <= bhi
and for all (i',j',k') meeting those conditions,
    k >= k'
    i <= i'
    and if i == i', j <= j'
 
In other words, of all maximal matching blocks, return one that
starts earliest in a, and of all those maximal matching blocks that
start earliest in a, return the one that starts earliest in b.
 
>>> s = SequenceMatcher(None, " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
(0, 4, 5)
 
If isjunk is defined, first the longest matching block is
determined as above, but with the additional restriction that no
junk element appears in the block.  Then that block is extended as
far as possible by matching (only) junk elements on both sides.  So
the resulting block never matches on junk except as identical junk
happens to be adjacent to an "interesting" match.
 
Here's the same example as before, but considering blanks to be
junk.  That prevents " abcd" from matching the " abcd" at the tail
end of the second sequence directly.  Instead only the "abcd" can
match, and matches the leftmost "abcd" in the second sequence:
 
>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
(1, 0, 4)
 
If no blocks match, return (alo, blo, 0).
 
>>> s = SequenceMatcher(None, "ab", "c")
>>> s.find_longest_match(0, 2, 0, 1)
(0, 0, 0)
get_matching_blocks(self)
Return list of triples describing matching subsequences.
 
Each triple is of the form (i, j, n), and means that
a[i:i+n] == b[j:j+n].  The triples are monotonically increasing in
i and in j.
 
The last triple is a dummy, (len(a), len(b), 0), and is the only
triple with n==0.
 
>>> s = SequenceMatcher(None, "abxcd", "abcd")
>>> s.get_matching_blocks()
[(0, 0, 2), (3, 2, 2), (5, 4, 0)]
get_opcodes(self)
Return list of 5-tuples describing how to turn a into b.
 
Each tuple is of the form (tag, i1, i2, j1, j2).  The first tuple
has i1 == j1 == 0, and remaining tuples have i1 == the i2 from the
tuple preceding it, and likewise for j1 == the previous j2.
 
The tags are strings, with these meanings:
 
'replace':  a[i1:i2] should be replaced by b[j1:j2]
'delete':   a[i1:i2] should be deleted.
            Note that j1==j2 in this case.
'insert':   b[j1:j2] should be inserted at a[i1:i1].
            Note that i1==i2 in this case.
'equal':    a[i1:i2] == b[j1:j2]
 
>>> a = "qabxcd"
>>> b = "abycdf"
>>> s = SequenceMatcher(None, a, b)
>>> for tag, i1, i2, j1, j2 in s.get_opcodes():
...    print ("%7s a[%d:%d] (%s) b[%d:%d] (%s)" %
...           (tag, i1, i2, a[i1:i2], j1, j2, b[j1:j2]))
 delete a[0:1] (q) b[0:0] ()
  equal a[1:3] (ab) b[0:2] (ab)
replace a[3:4] (x) b[2:3] (y)
  equal a[4:6] (cd) b[3:5] (cd)
 insert a[6:6] () b[5:6] (f)
quick_ratio(self)
Return an upper bound on ratio() relatively quickly.
 
This isn't defined beyond that it is an upper bound on .ratio(), and
is faster to compute.
ratio(self)
Return a measure of the sequences' similarity (float in [0,1]).
 
Where T is the total number of elements in both sequences, and
M is the number of matches, this is 2,0*M / T.
Note that this is 1 if the sequences are identical, and 0 if
they have nothing in common.
 
.ratio() is expensive to compute if you haven't already computed
.get_matching_blocks() or .get_opcodes(), in which case you may
want to try .quick_ratio() or .real_quick_ratio() first to get an
upper bound.
 
>>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio()
0.75
>>> s.quick_ratio()
0.75
>>> s.real_quick_ratio()
1.0
real_quick_ratio(self)
Return an upper bound on ratio() very quickly.
 
This isn't defined beyond that it is an upper bound on .ratio(), and
is faster to compute than either .ratio() or .quick_ratio().
set_seq1(self, a)
Set the first sequence to be compared.
 
The second sequence to be compared is not changed.
 
>>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio()
0.75
>>> s.set_seq1("bcde")
>>> s.ratio()
1.0
>>>
 
SequenceMatcher computes and caches detailed information about the
second sequence, so if you want to compare one sequence S against
many sequences, use .set_seq2(S) once and call .set_seq1(x)
repeatedly for each of the other sequences.
 
See also set_seqs() and set_seq2().
set_seq2(self, b)
Set the second sequence to be compared.
 
The first sequence to be compared is not changed.
 
>>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio()
0.75
>>> s.set_seq2("abcd")
>>> s.ratio()
1.0
>>>
 
SequenceMatcher computes and caches detailed information about the
second sequence, so if you want to compare one sequence S against
many sequences, use .set_seq2(S) once and call .set_seq1(x)
repeatedly for each of the other sequences.
 
See also set_seqs() and set_seq1().
set_seqs(self, a, b)
Set the two sequences to be compared.
 
>>> s = SequenceMatcher()
>>> s.set_seqs("abcd", "bcde")
>>> s.ratio()
0.75

Data and non-method functions defined here:
__doc__ = '\n SequenceMatcher is a flexible class for c...rn an upper bound on ratio() very quickly.\n '
__module__ = 'difflib'
 
Functions
            
IS_CHARACTER_JUNK(ch, ws=' \t')
Return 1 for ignorable character: iff `ch` is a space or tab.
 
Examples:
 
>>> IS_CHARACTER_JUNK(' ')
1
>>> IS_CHARACTER_JUNK('\t')
1
>>> IS_CHARACTER_JUNK('\n')
0
>>> IS_CHARACTER_JUNK('x')
0
IS_LINE_JUNK(line, pat=<built-in method match of _sre.SRE_Pattern object>)
Return 1 for ignorable line: iff `line` is blank or contains a single '#'.
 
Examples:
 
>>> IS_LINE_JUNK('\n')
1
>>> IS_LINE_JUNK('  #   \n')
1
>>> IS_LINE_JUNK('hello\n')
0
_count_leading(line, ch)
Return number of `ch` characters at the start of `line`.
 
Example:
 
>>> _count_leading('   abc', ' ')
3
_test()
get_close_matches(word, possibilities, n=3, cutoff=0.59999999999999998)
Use SequenceMatcher to return list of the best "good enough" matches.
 
word is a sequence for which close matches are desired (typically a
string).
 
possibilities is a list of sequences against which to match word
(typically a list of strings).
 
Optional arg n (default 3) is the maximum number of close matches to
return.  n must be > 0.
 
Optional arg cutoff (default 0.6) is a float in [0, 1].  Possibilities
that don't score at least that similar to word are ignored.
 
The best (no more than n) matches among the possibilities are returned
in a list, sorted by similarity score, most similar first.
 
>>> get_close_matches("appel", ["ape", "apple", "peach", "puppy"])
['apple', 'ape']
>>> import keyword as _keyword
>>> get_close_matches("wheel", _keyword.kwlist)
['while']
>>> get_close_matches("apple", _keyword.kwlist)
[]
>>> get_close_matches("accept", _keyword.kwlist)
['except']
ndiff(a, b, linejunk=<function IS_LINE_JUNK>, charjunk=<function IS_CHARACTER_JUNK>)
Compare `a` and `b` (lists of strings); return a `Differ`-style delta.
 
Optional keyword parameters `linejunk` and `charjunk` are for filter
functions (or None):
 
- linejunk: A function that should accept a single string argument, and
  return true iff the string is junk. The default is module-level function
  IS_LINE_JUNK, which filters out lines without visible characters, except
  for at most one splat ('#').
 
- charjunk: A function that should accept a string of length 1. The
  default is module-level function IS_CHARACTER_JUNK, which filters out
  whitespace characters (a blank or tab; note: bad idea to include newline
  in this!).
 
Tools/scripts/ndiff.py is a command-line front-end to this function.
 
Example:
 
>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(1),
...              'ore\ntree\nemu\n'.splitlines(1))
>>> print ''.join(diff),
- one
?  ^
+ ore
?  ^
- two
- three
?  -
+ tree
+ emu
restore(delta, which)
Generate one of the two sequences that generated a delta.
 
Given a `delta` produced by `Differ.compare()` or `ndiff()`, extract
lines originating from file 1 or 2 (parameter `which`), stripping off line
prefixes.
 
Examples:
 
>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(1),
...              'ore\ntree\nemu\n'.splitlines(1))
>>> diff = list(diff)
>>> print ''.join(restore(diff, 1)),
one
two
three
>>> print ''.join(restore(diff, 2)),
ore
tree
emu
 
Data
             __all__ = ['get_close_matches', 'ndiff', 'restore', 'SequenceMatcher', 'Differ']
__file__ = '/usr/lib/python2.2/difflib.pyc'
__name__ = 'difflib'
generators = _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 4096)