Skip to content

Commit 2cffa6d

Browse files
committed
gh-161973: Don't modify the cached opcodes in difflib.SequenceMatcher.get_grouped_opcodes()
1 parent af106b8 commit 2cffa6d

3 files changed

Lines changed: 23 additions & 1 deletion

File tree

‎Lib/difflib.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,9 @@ def get_grouped_opcodes(self, n=3):
570570
('equal', 35, 38, 31, 34)]]
571571
"""
572572

573-
codes = self.get_opcodes()
573+
# Copy, since get_opcodes() returns the cached list and it is
574+
# modified below.
575+
codes = list(self.get_opcodes())
574576
if not codes:
575577
codes = [("equal", 0, 1, 0, 1)]
576578
# Fixup leading and trailing groups if they show no changes.

‎Lib/test/test_difflib.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,23 @@ def test_matching_blocks_cache(self):
179179
self.assertEqual(second[1].size, 2)
180180
self.assertEqual(second[2].size, 0)
181181

182+
def test_grouped_opcodes_keep_cached_opcodes(self):
183+
# get_grouped_opcodes() must not modify the list cached by
184+
# get_opcodes().
185+
a = 'abcdefghxijklmnop'
186+
b = 'abcdefghyijklmnop'
187+
s = difflib.SequenceMatcher(None, a, b)
188+
opcodes = list(s.get_opcodes())
189+
self.assertEqual(list(s.get_grouped_opcodes(1)),
190+
[[('equal', 7, 8, 7, 8),
191+
('replace', 8, 9, 8, 9),
192+
('equal', 9, 10, 9, 10)]])
193+
self.assertEqual(s.get_opcodes(), opcodes)
194+
self.assertEqual(list(s.get_grouped_opcodes(3)),
195+
[[('equal', 5, 8, 5, 8),
196+
('replace', 8, 9, 8, 9),
197+
('equal', 9, 12, 9, 12)]])
198+
182199
def test_added_tab_hint(self):
183200
# Check fix for bug #1488943
184201
diff = list(difflib.Differ().compare(["\tI am a buggy"],["\t\tI am a bug"]))
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Fix :meth:`difflib.SequenceMatcher.get_grouped_opcodes` changing the list
2+
cached by :meth:`~difflib.SequenceMatcher.get_opcodes`, which made later calls
3+
on the same matcher return wrong results.

0 commit comments

Comments
 (0)