Fix SF bug #763023, difflib.py: ratio() zero division not caught

nnorwitz · nnorwitz · commit e7dfe21bed41 · 2003-07-01T14:59:46.000Z
Backport candidate
diff --git a/Lib/difflib.py b/Lib/difflib.py
@@ -29,6 +29,11 @@
            'Differ','IS_CHARACTER_JUNK', 'IS_LINE_JUNK', 'context_diff',
            'unified_diff']
 
+def _calculate_ratio(matches, length):
+    if length:
+        return 2.0 * matches / length
+    return 1.0
+
 class SequenceMatcher:
 
     """
@@ -611,7 +616,7 @@ def ratio(self):
 
         matches = reduce(lambda sum, triple: sum + triple[-1],
                          self.get_matching_blocks(), 0)
-        return 2.0 * matches / (len(self.a) + len(self.b))
+        return _calculate_ratio(matches, len(self.a) + len(self.b))
 
     def quick_ratio(self):
         """Return an upper bound on ratio() relatively quickly.
@@ -640,7 +645,7 @@ def quick_ratio(self):
             avail[elt] = numb - 1
             if numb > 0:
                 matches = matches + 1
-        return 2.0 * matches / (len(self.a) + len(self.b))
+        return _calculate_ratio(matches, len(self.a) + len(self.b))
 
     def real_quick_ratio(self):
         """Return an upper bound on ratio() very quickly.
@@ -652,7 +657,7 @@ def real_quick_ratio(self):
         la, lb = len(self.a), len(self.b)
         # can't have more matches than the number of elements in the
         # shorter sequence
-        return 2.0 * min(la, lb) / (la + lb)
+        return _calculate_ratio(min(la, lb), la + lb)
 
 def get_close_matches(word, possibilities, n=3, cutoff=0.6):
     """Use SequenceMatcher to return list of the best "good enough" matches.
diff --git a/Lib/test/test_difflib.py b/Lib/test/test_difflib.py
@@ -1,3 +1,15 @@
 import difflib
 from test import test_support
+import unittest
+
+class TestSFbugs(unittest.TestCase):
+
+    def test_ratio_for_null_seqn(self):
+        # Check clearing of SF bug 763023
+        s = difflib.SequenceMatcher(None, [], [])
+        self.assertEqual(s.ratio(), 1)
+        self.assertEqual(s.quick_ratio(), 1)
+        self.assertEqual(s.real_quick_ratio(), 1)
+
+test_support.run_unittest(TestSFbugs)
 test_support.run_doctest(difflib)
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -24,6 +24,9 @@ Extension modules
 Library
 -------
 
+- SF bug 763023: fix uncaught ZeroDivisionError in difflib ratio methods
+  when there are no lines.
+
 Tools/Demos
 -----------
 
