a
ikE @ s0 d Z g dZddlmZ ddlmZ ddlm Z eddZ
dd Z G d
d d Z d:ddZ
dd ZG dd dZddlZedjfddZd;ddZdd Zd
d)d*Zdefd+d,Zddefd-d.Z d/Z d0Z d1Z d2Z G d3d4 d4e!Z"[d5d6 Z#d7d8 Z$e%d9kr,e$ dS )?ae
Module difflib -- helpers for computing deltas between objects.
Function get_close_matches(word, possibilities, n=3, cutoff=0.6):
Use SequenceMatcher to return list of the best "good enough" matches.
Function context_diff(a, b):
For two lists of strings, return a delta in context diff format.
Function ndiff(a, b):
Return a delta: the difference between `a` and `b` (lists of strings).
Function restore(delta, which):
Return one of the two sequences that generated an ndiff delta.
Function unified_diff(a, b):
For two lists of strings, return a delta in unified diff format.
Class SequenceMatcher:
A flexible class for comparing pairs of sequences of any type.
Class Differ:
For producing human-readable deltas from sequences of lines of text.
Class HtmlDiff:
For producing HTML side by side comparison with change highlights.
) get_close_matchesndiffrestoreSequenceMatcherDifferIS_CHARACTER_JUNK IS_LINE_JUNK context_diff unified_diff
diff_bytesHtmlDiffMatch )nlargest)
namedtuple) GenericAliasr za b sizec C s |rd| | S dS )Ng @ ? )matcheslengthr r /usr/lib64/python3.9/difflib.py_calculate_ratio' s r c @ s~ e Zd ZdZd ddZdd Zd d
Zd d Zd
d Zd ddZ dd Z
dd Z d!ddZ dd Z
dd Zd d ZeeZdS )"r ao
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 syncing up on blocks of "junk lines", though (like blank lines in
ordinary text files, or maybe "" lines in HTML files). That may be
because this is the only method of the 3 that has a *concept* of
"junk" .
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 21 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:29] b[17: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.
N Tc C s( || _ d | _| _|| _| || dS )a! 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().
Optional arg autojunk should be set to False to disable the
"automatic junk heuristic" that treats popular elements as junk
(see module documentation for more information).
N)isjunkabautojunkset_seqs)selfr r r r r r r __init__x s ; zSequenceMatcher.__init__c C s | | | | dS )zSet the two sequences to be compared.
>>> s = SequenceMatcher()
>>> s.set_seqs("abcd", "bcde")
>>> s.ratio()
0.75
N)set_seq1set_seq2)r r r r r r r s
zSequenceMatcher.set_seqsc C s$ || j u rdS || _ d | _| _dS )aM 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().
N)r matching_blocksopcodes)r r r r r r s
zSequenceMatcher.set_seq1c C s2 || j u rdS || _ d | _| _d| _| dS )aM 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().
N)r r! r"
fullbcount_SequenceMatcher__chain_b)r r r r r r s
zSequenceMatcher.set_seq2c C s | j }i | _}t|D ] \}}||g }|| qt | _}| j}|r~| D ]}||rV| | qV|D ]
}||= qrt | _
}t |} | j r| dkr| d d }
|
D ] \}} t | |
kr| | q|D ]
}||= qd S )N d )r b2j enumerate
setdefaultappendsetbjunkr keysaddZbpopularlenr items) r r r( ieltindicesZjunkr ZpopularnZntestZidxsr r r Z __chain_b
s,
zSequenceMatcher.__chain_br
c C sT | j | j| j| jjf\}}}}|du r.t|}|du r>t|}||d } }
} i } g }
t||D ]}| j}i }||| |
D ]\}||k rq~||kr q||d dd }||< || kr~|| d || d | } }
} q~|} q`| |kr@|
|kr@|||
d s@|| d ||
d kr@| d |
d | d } }
} q| | |k r|
| |k r|||
| s|| | ||
| kr| d7 } q@| |kr|
|kr|||
d r|| d ||
d kr| d |
d | d } }
} q| | |k rH|
| |k rH|||
| rH|| | ||
| krH| d } qt| |
| S )aA Find longest matching block in a[alo:ahi] and b[blo:bhi].
By default it will find the longest match in the entirety of a and b.
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)
Match(a=0, b=4, size=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)
Match(a=1, b=0, size=4)
If no blocks match, return (alo, blo, 0).
>>> s = SequenceMatcher(None, "ab", "c")
>>> s.find_longest_match(0, 2, 0, 1)
Match(a=0, b=0, size=0)
Nr
r' ) r r r( r- __contains__r0 rangegetr )r aloahiblobhir r r( ZisbjunkZbestiZbestjZbestsizeZj2lenZnothingr2 Zj2lengetZnewj2lenjkr r r find_longest_match1 sZ : " z"SequenceMatcher.find_longest_matchc C s| | j dur| j S t| jt| j }}d|d|fg}g }|r| \}}}}| |||| \} }
} } | r8|| || k r||
k r||| ||
f | | |k r8|
| |k r8|| | ||
| |f q8| d }
}}g }|D ]V\}}}|
| |kr|| |kr||7 }q|r,||
||f ||| }
}}q|rT||
||f |||df tt t
j || _ | j S )a 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. New in Python 2.5, it's also guaranteed that if
(i, j, n) and (i', j', n') are adjacent triples in the list, and
the second is not the last triple in the list, then i+n != i' or
j+n != j'. IOW, adjacent triples never describe adjacent equal
blocks.
The last triple is a dummy, (len(a), len(b), 0), and is the only
triple with n==0.
>>> s = SequenceMatcher(None, "abxcd", "abcd")
>>> list(s.get_matching_blocks())
[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]
Nr
) r! r0 r r popr? r+ sortlistmapr _make)r lalbqueuer! r9 r: r; r< r2 r= r> xi1j1Zk1Z non_adjacenti2j2Zk2r r r get_matching_blocks s8
z#SequenceMatcher.get_matching_blocksc C s | j dur| j S d }}g | _ }| D ]\}}}d}||k rN||k rNd}n||k r\d}n ||k rhd}|r||||||f || || }}|r*|d||||f q*|S )a[ 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)
Nr
r replacedeleteinsertequal)r" rM r+ )r r2 r= Zansweraibjsizetagr r r get_opcodes s$
zSequenceMatcher.get_opcodes c
c sn | }|sdg}|d d dkrZ|d \}}}}}|t||| |t||| |f|d< |d d dkr|d \}}}}}||t||| |t||| f|d< || }g } |D ]\}}}}}|dkr(|| |kr(| ||t||| |t||| f | V g } t||| t||| }}| |||||f q| rjt| dkrd| d d dksj| V dS )a Isolate change clusters by eliminating ranges with no changes.
Return a generator of groups with up to n lines of context.
Each group is in the same format as returned by get_opcodes().
>>> from pprint import pprint
>>> a = list(map(str, range(1,40)))
>>> b = a[:]
>>> b[8:8] = ['i'] # Make an insertion
>>> b[20] += 'x' # Make a replacement
>>> b[23:28] = [] # Make a deletion
>>> b[30] += 'y' # Make another replacement
>>> pprint(list(SequenceMatcher(None,a,b).get_grouped_opcodes()))
[[('equal', 5, 8, 5, 8), ('insert', 8, 8, 8, 9), ('equal', 8, 11, 9, 12)],
[('equal', 16, 19, 17, 20),
('replace', 19, 20, 20, 21),
('equal', 20, 22, 21, 23),
('delete', 22, 27, 23, 23),
('equal', 27, 30, 23, 26)],
[('equal', 31, 34, 27, 30),
('replace', 34, 35, 30, 31),
('equal', 35, 38, 31, 34)]]
)rQ r
r' r
r' r
rQ r' N)rV maxminr+ r0 )
r r5 ZcodesrU rI rK rJ rL nngroupr r r get_grouped_opcodes# s( &&( &z#SequenceMatcher.get_grouped_opcodesc C s0 t dd | D }t|t| jt| j S )a 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
c s s | ]}|d V qdS )rX Nr ).0Ztripler r r k z(SequenceMatcher.ratio..)sumrM r r0 r r )r r r r r ratioU s zSequenceMatcher.ratioc C s | j du r4i | _ }| jD ]}||dd ||< q| j }i }|jd }}| jD ]>}||rf|| }n ||d}|d ||< |dkrP|d }qPt|t| jt| j S )zReturn 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.
Nr
r' )r# r r8 r6 r r r0 )r r# r3 ZavailZavailhasr Znumbr r r quick_ration s
zSequenceMatcher.quick_ratioc C s* t | jt | j }}tt|||| S )zReturn 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().
)r0 r r r rZ )r rE rF r r r real_quick_ratio s z SequenceMatcher.real_quick_ratio)Nr r T)r
Nr
N)rW )__name__
__module__ __qualname____doc__r r r r r$ r? rM rV r] rb rc rd classmethodr __class_getitem__r r r r r , s J
@ ,'
tG7
2 r rW 333333?c C s |dkst d|f d| kr*dks:n t d|f g }t }|| |D ]D}|| | |krR| |krR| |krR|| |f qRt||}dd |D S )a 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']
r
zn must be > 0: %rg r z cutoff must be in [0.0, 1.0]: %rc S s g | ] \}}|qS r r )r^ ZscorerH r r r
r` z%get_close_matches..)
ValueErrorr r r rd rc rb r+ _nlargest)ZwordZ
possibilitiesr5 cutoffresultsrH r r r r s"
r c C s d dd t| |D S )zAReplace whitespace with the original whitespace characters in `s`r c s s* | ]"\}}|d kr | r |n|V qdS ) N)isspace)r^ cZtag_cr r r r_ s z$_keep_original_ws..)joinzip)rq Ztag_sr r r _keep_original_ws s
rw c @ sJ e Zd ZdZdddZdd Zdd Zd d
Zd d Zd
d Z dd Z
dS )r a
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(keepends=True)
>>> 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(keepends=True)
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), end="")
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.
Nc C s || _ || _dS )a
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 ('#'). It is recommended
to leave linejunk None; the underlying SequenceMatcher class has
an adaptive notion of "noise" lines that's better than any static
definition the author has ever been able to craft.
- `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!). Use of IS_CHARACTER_JUNK is recommended.
Nlinejunkcharjunk)r ry rz r r r r * s zDiffer.__init__c
c s t | j||}| D ]\}}}}}|dkrB| ||||||} n\|dkr\| d|||} nB|dkrv| d|||} n(|dkr| d|||} ntd|f | E d H qd S )
a
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(True),
... 'ore\ntree\nemu\n'.splitlines(True))),
... end="")
- one
? ^
+ ore
? ^
- two
- three
? -
+ tree
+ emu
rN rO -rP +rQ rr unknown tag %rN)r ry rV _fancy_replace_dumprm )
r r r cruncherrU r9 r: r; r< gr r r compareA s zDiffer.comparec c s& t ||D ]}d||| f V q
dS )z4Generate comparison results for a same-tagged range.z%s %sN)r7 )r rU rH lohir2 r r r r j s z Differ._dumpc
c sn || || k r2| d|||}| d|||}n | d|||}| d|||}||fD ]} | E d H qZd S )Nr| r{ )r )
r r r9 r: r r; r< firstsecondr r r r _plain_replaceo s zDiffer._plain_replacec c s: d\}}t | j} d\}
} t||D ]} || }
| |
t||D ]j}|| }||
krl|
du rD|| }
} qD| | | |krD| |krD| |krD| || }}}qDq$||k r|
du r| ||||||E dH dS |
| d }}}nd}
| ||||||E dH || || }}|
du r
d }}|
|| | D ]\}}}}}|| || }} |dkr|d| 7 }|d| 7 }nb|dkr|d | 7 }nJ|d
kr|d | 7 }n2|d kr|d
| 7 }|d
| 7 }nt d|f qH|
||||E dH n
d| V | ||d |||d |E dH dS )aL
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()
>>> results = d._fancy_replace(['abcDefghiJkl\n'], 0, 1,
... ['abcdefGhijkl\n'], 0, 1)
>>> print(''.join(results), end="")
- abcDefghiJkl
? ^ ^ ^
+ abcdefGhijkl
? ^ ^ ^
)gGz?g ?)NNNr r rN ^rO r{ rP r| rQ rr r} r' )r rz r7 r r rd rc rb r
_fancy_helperr rV rm _qformat) r r r9 r: r r; r< Z
best_ratioro r ZeqiZeqjr= rS r2 rR Zbest_iZbest_jZaeltZbeltatagsbtagsrU Zai1Zai2Zbj1Zbj2rE rF r r r r~ } s\
zDiffer._fancy_replacec c sb g }||k r<||k r*| ||||||}qT| d|||}n||k rT| d|||}|E d H d S )Nr{ r| )r~ r )r r r9 r: r r; r< r r r r r s zDiffer._fancy_helperc c sX t || }t || }d| V |r8d| dV d| V |rTd| dV dS )a
Format "?" output and deal with tabs.
Example:
>>> d = Differ()
>>> results = d._qformat('\tabcDefghiJkl\n', '\tabcdefGhijkl\n',
... ' ^ ^ ^ ', ' ^ ^ ^ ')
>>> for line in results: print(repr(line))
...
'- \tabcDefghiJkl\n'
'? \t ^ ^ ^\n'
'+ \tabcdefGhijkl\n'
'? \t ^ ^ ^\n'
- z?
+ N)rw rstrip)r ZalineZbliner r r r r r s
zDiffer._qformat)NN) re rf rg rh r r r r r~ r r r r r r r s U
)^ r Nz
\s*(?:#\s*)?$c C s || duS )z
Return True for ignorable line: iff `line` is blank or contains a single '#'.
Examples:
>>> IS_LINE_JUNK('\n')
True
>>> IS_LINE_JUNK(' # \n')
True
>>> IS_LINE_JUNK('hello\n')
False
Nr )linepatr r r r s r c C s | |v S )z
Return True for ignorable character: iff `ch` is a space or tab.
Examples:
>>> IS_CHARACTER_JUNK(' ')
True
>>> IS_CHARACTER_JUNK('\t')
True
>>> IS_CHARACTER_JUNK('\n')
False
>>> IS_CHARACTER_JUNK('x')
False
r )Zchwsr r r r % s r c C s: | d }|| }|dkr"d |S |s.|d8 }d ||S z Convert range to the "ed" formatr' z{}z{},{}formatstartstopZ beginningr r r r _format_range_unified< s
r r r c c sP t | |||||| d}td| ||D ] } |s|d}|rFd|nd}
|rXd|nd} d||
|V d|| |V | d | d } }
t| d
|
d }t| d |
d
}d|||V | D ]\}}}}}|dkr| || D ]}d| V qq|dv r"| || D ]}d| V q|dv r||| D ]}d| V q6qq*dS )a
Compare two sequences of lines; generate the delta as a unified diff.
Unified diffs are a compact way of showing line changes and a few
lines of context. The number of context lines is set by 'n' which
defaults to three.
By default, the diff control lines (those with ---, +++, or @@) are
created with a trailing newline. This is helpful so that inputs
created from file.readlines() result in diffs that are suitable for
file.writelines() since both the inputs and outputs have trailing
newlines.
For inputs that do not have trailing newlines, set the lineterm
argument to "" so that the output will be uniformly newline free.
The unidiff format normally has a header for filenames and modification
times. Any or all of these may be specified using strings for
'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.
The modification times are normally expressed in the ISO 8601 format.
Example:
>>> for line in unified_diff('one two three four'.split(),
... 'zero one tree four'.split(), 'Original', 'Current',
... '2005-01-26 23:30:50', '2010-04-02 10:20:52',
... lineterm=''):
... print(line) # doctest: +NORMALIZE_WHITESPACE
--- Original 2005-01-26 23:30:50
+++ Current 2010-04-02 10:20:52
@@ -1,4 +1,4 @@
+zero
one
-two
-three
+tree
four
FNT {}r
--- {}{}{}z
+++ {}{}{}r
rX r' rW z@@ -{} +{} @@{}rQ rr > rO rN r{ > rN rP r| ) _check_typesr r] r r )r r fromfiletofile fromfiledate
tofiledater5 linetermstartedr\ fromdatetodater last file1_range file2_rangerU rI rK rJ rL r r r r r G s0 )
r c C sB | d }|| }|s |d8 }|dkr.d |S d ||| d S r r r r r r _format_range_context s
r c c s t | |||||| tddddd}d} td| ||D ]R}
| sd} |rVd |nd
} |rhd |nd
} d || |V d || |V |
d
|
d }
}d| V t|
d |d }d||V tdd |
D r|
D ]8\}}}}}|dkr| || D ]}|| | V qqt|
d |d }d||V tdd |
D r:|
D ]<\}}}}}|dkrP||| D ]}|| | V qtqPq:dS )ah
Compare two sequences of lines; generate the delta as a context diff.
Context diffs are a compact way of showing line changes and a few
lines of context. The number of context lines is set by 'n' which
defaults to three.
By default, the diff control lines (those with *** or ---) are
created with a trailing newline. This is helpful so that inputs
created from file.readlines() result in diffs that are suitable for
file.writelines() since both the inputs and outputs have trailing
newlines.
For inputs that do not have trailing newlines, set the lineterm
argument to "" so that the output will be uniformly newline free.
The context diff format normally has a header for filenames and
modification times. Any or all of these may be specified using
strings for 'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.
The modification times are normally expressed in the ISO 8601 format.
If not specified, the strings default to blanks.
Example:
>>> print(''.join(context_diff('one\ntwo\nthree\nfour\n'.splitlines(True),
... 'zero\none\ntree\nfour\n'.splitlines(True), 'Original', 'Current')),
... end="")
*** Original
--- Current
***************
*** 1,4 ****
one
! two
! three
four
--- 1,4 ----
+ zero
one
! tree
four
r r z! r )rP rO rN rQ FNTr r z
*** {}{}{}r r
rX z***************r' r z
*** {} ****{}c s s | ]\}}}}}|d v V qdS )> rO rN Nr r^ rU _r r r r_ r` z context_diff..rP rW r z
--- {} ----{}c s s | ]\}}}}}|d v V qdS )> rN rP Nr r r r r r_ r` rO )r dictr r] r r any)r r r r r r r5 r prefixr r\ r r r r r rU rI rK r r r rJ rL r r r r s4 ,
r c G s | r0t | d ts0tdt| d j| d f |r`t |d ts`tdt|d j|d f |D ] }t |tsdtd|f qdd S )Nr
z)lines to compare must be str, not %s (%r)z"all arguments must be str, not: %r)
isinstancestr TypeErrortypere )r r argsargr r r r s
r r`
c c s~ dd } t t| |}t t| |}| |}| |}| |}| |}| |}| ||||||||}
|
D ]} | ddV qfdS )a
Compare `a` and `b`, two sequences of lines represented as bytes rather
than str. This is a wrapper for `dfunc`, which is typically either
unified_diff() or context_diff(). Inputs are losslessly converted to
strings so that `dfunc` only has to worry about strings, and encoded
back to bytes on return. This is necessary to compare files with
unknown or inconsistent encoding. All other inputs (except `n`) must be
bytes rather than str.
c
S sT z| ddW S tyN } z(dt| j| f }t||W Y d }~n
d }~0 0 d S )Nasciisurrogateescapez(all arguments must be bytes, not %s (%r))decodeAttributeErrorr re r )rq errmsgr r r r s zdiff_bytes..decoder r N)rB rC encode) Zdfuncr r r r r r r5 r r linesr r r r r
s r
c C s t ||| |S )aJ
Compare `a` and `b` (lists of strings); return a `Differ`-style delta.
Optional keyword parameters `linejunk` and `charjunk` are for filter
functions, or can be None:
- linejunk: A function that should accept a single string argument and
return true iff the string is junk. The default is None, and is
recommended; the underlying SequenceMatcher class has an adaptive
notion of "noise" lines.
- charjunk: A function that accepts a character (string of length
1), and returns true iff the character is junk. The default is
the module-level function IS_CHARACTER_JUNK, which filters out
whitespace characters (a blank or tab; note: it's a 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(keepends=True),
... 'ore\ntree\nemu\n'.splitlines(keepends=True))
>>> print(''.join(diff), end="")
- one
? ^
+ ore
? ^
- two
- three
? -
+ tree
+ emu
)r r )r r ry rz r r r r s #r c # s ddl }|dt| |||ddgffdd fdd fdd }| }|du rj|E dH n|d
7 }d}ddg| } }
d } | d u rzt|\} }
} W n ty Y dS 0 | | }| |
| f|
|< | d
7 } q| |krd V |}n| }d} |r | | }| d
7 } |
| V |d
8 }q|d
}z@|rft|\} }
} | rN|d
}n|d
8 }| |
| fV q*W qv ty~ Y dS 0 qvdS )
a Returns generator yielding marked up from/to side by side differences.
Arguments:
fromlines -- list of text lines to compared to tolines
tolines -- list of text lines to be compared to fromlines
context -- number of context lines to display on each side of difference,
if None, all from/to text lines will be generated.
linejunk -- passed on to ndiff (see ndiff documentation)
charjunk -- passed on to ndiff (see ndiff documentation)
This function returns an iterator which returns a tuple:
(from line tuple, to line tuple, boolean flag)
from/to line tuple -- (line num, line text)
line num -- integer or None (to indicate a context separation)
line text -- original line text with following markers inserted:
'\0+' -- marks start of added text
'\0-' -- marks start of deleted text
'\0^' -- marks start of changed text
'\1' -- marks end of added/deleted/changed text
boolean flag -- None indicates context separation, True indicates
either "from" or "to" line contains a change, otherwise False.
This function/iterator was originally developed to generate side by side
file difference for making HTML pages (see HtmlDiff class for example
usage).
Note, this function utilizes the ndiff function to generate the side by
side difference markup. Optional ndiff arguments may be passed to this
function and they in turn will be passed to ndiff.
r
Nz
(\++|\-+|\^+)c s || d7 < |du r2|| | ddd fS |dkr| d| d }}g }|fdd} || t|D ]<\}\} }
|d| d | || |
d ||
d }qt|dd }n*| ddd }|sd
}d| | d }|| |fS ) a Returns line of text with user's change markup and line formatting.
lines -- list of lines from the ndiff generator to produce a line of
text from. When producing the line of text to return, the
lines used are removed from this list.
format_key -- '+' return first line in list with "add" markup around
the entire line.
'-' return first line in list with "delete" markup around
the entire line.
'?' return first line in list with add/delete/change
intraline markup (indices obtained from second line)
None return first line in list with no markup
side -- indice into the num_lines list (0=from,1=to)
num_lines -- from/to current line number. This is NOT intended to be a
passed parameter. It is present as a keyword argument to
maintain memory of the current line numbers between calls
of this function.
Note, this function is purposefully not defined at the module scope so
that data it needs from its parent function (within whose context it
is defined) does not need to be of module scope.
r' Nr
r ?c S s& | | dd | g | dS )Nr' r
)r+ r\ span)Z match_objectsub_infor r r record_sub_info s z3_mdiff.._make_line..record_sub_info rr )r@ subreversed) r Z
format_keysideZ num_linestextZmarkersr r keyZbeginend) change_rer r
_make_linef s 2z_mdiff.._make_linec 3 sn g } d\}}t | dk r*| td q ddd | D }|drP|}n|dr| | dd | dd
d fV q n|d r|d
8 } | d
d dd fV q nl|drֈ | d
d d }}|d
d }}n>|dr | dd | dd
d fV q n|dr0 | dd | dd
d fV q n|d
r\|d
8 } | d
d dd fV q n|dr|d
7 }d | dd
d fV q n|drd | dd
}}|d
d }}n^|dr|d
7 }d | dd
d fV q n2|dr | dd dd | dd
dfV q |d k r0|d
7 }dV q|d krL|d
8 }dV q0|dr\dS ||d fV q dS )a Yields from/to lines of text with a change indication.
This function is an iterator. It itself pulls lines from a
differencing iterator, processes them and yields them. When it can
it yields both a "from" and a "to" line, otherwise it will yield one
or the other. In addition to yielding the lines of from/to text, a
boolean flag is yielded to indicate if the text line(s) have
differences in them.
Note, this function is purposefully not defined at the module scope so
that data it needs from its parent function (within whose context it
is defined) does not need to be of module scope.
)r
r
r Xr c S s g | ] }|d qS )r
r r^ r r r r rl r` z2_mdiff.._line_iterator..z-?+?r r
r' Tz--++r{ N)z--?+z--+r z-+?z-?+z+--r| )r z+-rr F)Nr r T)r NT)r0 r+ nextru
startswith)r Znum_blanks_pendingZnum_blanks_to_yieldrq from_lineto_line)r diff_lines_iteratorr r _line_iterator sd
$
z _mdiff.._line_iteratorc 3 s } g g }}t |dks(t |dkr~zt| \}}}W n tyN Y dS 0 |durf|||f |dur|||f q|d\}}|d\}}|||p|fV qdS )at Yields from/to lines of text with a change indication.
This function is an iterator. It itself pulls lines from the line
iterator. Its difference from that iterator is that this function
always yields a pair of from/to text lines (with the change
indication). If necessary it will collect single from/to lines
until it has a matching pair from/to pair to yield.
Note, this function is purposefully not defined at the module scope so
that data it needs from its parent function (within whose context it
is defined) does not need to be of module scope.
r
N)r0 r
StopIterationr+ r@ )Z
line_iterator fromlinestolinesr r
found_diffZfromDiffZto_diff)r r r _line_pair_iterator s
z#_mdiff.._line_pair_iteratorr' F)NNN)recompiler r r )r r contextry rz r r Zline_pair_iteratorZlines_to_writeindexZ contextLinesr r r r2 r )r r r r r _mdiff< sR "
8X !
r an
%(table)s%(legend)s
aH
table.diff {font-family:Courier; border:medium;}
.diff_header {background-color:#e0e0e0}
td.diff_header {text-align:right}
.diff_next {background-color:#c0c0c0}
.diff_add {background-color:#aaffaa}
.diff_chg {background-color:#ffff77}
.diff_sub {background-color:#ffaaaa}aZ
%(header_row)s
%(data_rows)s
a
| Legends |
| Colors |
|---|
| Added |
| Changed |
| Deleted |
|
| Links |
|---|
| (f)irst change |
| (n)ext change |
| (t)op |
|
c @ s e Zd ZdZeZeZeZeZdZddde fddZ
d d
d d d
Z dd Z dd Z
dd Zdd Zdd Zdd Zdd Zd d d ZdS ) r a{ For producing HTML side by side comparison with change highlights.
This class can be used to create an HTML table (or a complete HTML file
containing the table) showing a side by side, line by line comparison
of text with inter-line and intra-line change highlights. The table can
be generated in either full or contextual difference mode.
The following methods are provided for HTML generation:
make_table -- generates HTML for a single side by side table
make_file -- generates complete HTML file with a single side by side table
See tools/scripts/diff.py for an example usage of this class.
r
Nc C s || _ || _|| _|| _dS )a HtmlDiff instance initializer
Arguments:
tabsize -- tab stop spacing, defaults to 8.
wrapcolumn -- column number where lines are broken and wrapped,
defaults to None where lines are not wrapped.
linejunk,charjunk -- keyword arguments passed into ndiff() (used by
HtmlDiff() to generate the side by side HTML differences). See
ndiff() documentation for argument default values and descriptions.
N)_tabsize _wrapcolumn _linejunk _charjunk)r tabsizeZ
wrapcolumnry rz r r r r s zHtmlDiff.__init__r F zutf-8)charsetc C s: | j t| j| j| j||||||d|d |d|S )a Returns HTML file of side by side comparison with change highlights
Arguments:
fromlines -- list of "from" lines
tolines -- list of "to" lines
fromdesc -- "from" file column header string
todesc -- "to" file column header string
context -- set to True for contextual differences (defaults to False
which shows full differences).
numlines -- number of context lines. When context is set True,
controls number of lines displayed before and after the change.
When context is False, controls the number of lines to place
the "next" link anchors before the next change (so click of
"next" link jumps to just before the change).
charset -- charset of the HTML document
)r numlines)ZstylesZlegendtabler xmlcharrefreplace)_file_templater _styles_legend
make_tabler r )r r r fromdesctodescr r r r r r make_file s zHtmlDiff.make_filec s8 fdd fdd|D } fdd|D }||fS )a Returns from/to line lists with tabs expanded and newlines removed.
Instead of tab characters being replaced by the number of spaces
needed to fill in to the next tab stop, this function will fill
the space with tab characters. This is done so that the difference
algorithms can identify changes in a file when tabs are replaced by
spaces and vice versa. At the end of the HTML generation, the tab
characters will be replaced with a nonbreakable space.
c s6 | dd} | j} | dd} | dddS )Nrr r r )rN
expandtabsr r )r )r r r expand_tabs s z2HtmlDiff._tab_newline_replace..expand_tabsc s g | ] } |qS r r r r r r rl r` z1HtmlDiff._tab_newline_replace..c s g | ] } |qS r r r r r r rl r` r )r r r r )r r r _tab_newline_replace s
z HtmlDiff._tab_newline_replacec C s |s| ||f dS t|}| j}||ksB||dd |krT| ||f dS d}d}d}||k r||k r|| dkr|d7 }|| }|d7 }q`|| dkr|d7 }d}q`|d7 }|d7 }q`|d| } ||d }
|r| d } d| |
}
| || f | |d|
dS ) a Builds list of text lines by splitting text lines at wrap point
This function will determine if the input text line needs to be
wrapped (split) into separate lines. If so, the first wrap point
will be determined and the first line appended to the output
text line list. This function is used recursively to handle
the second part of the split line to further split it.
Nr rW r
r r' r >)r+ r0 r count _split_line) r Z data_listZline_numr rT rY r2 r5 ZmarkZline1Zline2r r r r s8
zHtmlDiff._split_linec c s |D ]\}}}|du r$|||fV q|| \}}\}}g g } }
| | || | |
|| | sd|
r| rt| d}nd}|
r|
d}nd}|||fV q\qdS )z5Returns iterator that splits (wraps) mdiff text linesNr
)r rr )r r@ ) r diffsfromdatatodataflagZfromlineZfromtextZtolineZtotextfromlisttolistr r r
_line_wrapper s
zHtmlDiff._line_wrapperc C s g g g }}}|D ]t\}}}z8| | jd|g|R | | jd|g|R W n& ty| | d | d Y n0 | | q|||fS )zCollects mdiff output into separate lists
Before storing the mdiff from/to data into a list, it is converted
into a single line of text with HTML markup.
r
r' N)r+ _format_liner )r r r r flaglistr r r r r r _collect_lines. s
zHtmlDiff._collect_linesc C sp z d| }d| j | |f }W n ty4 d}Y n0 |dddddd }|d
d }d |||f S )
a Returns HTML markup of "from" / "to" text lines
side -- 0 or 1 indicating "from" or "to" text
flag -- indicates if difference on line
linenum -- line number (used for line number column)
text -- line text to be marked up
z%dz
id="%s%s"r &z&r z>