From: Raymond Hettinger <python@rcn.com>
Date: Tue, 12 Aug 2014 19:44:52 +0000 (-0700)
Subject: Issue 22184: Early detection and reporting of missing lru_cache parameters
X-Git-Tag: v3.4.2rc1~124
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4d58897fdb0f123340246fac79174a52d7cbcf85;p=python

Issue 22184: Early detection and reporting of missing lru_cache parameters
---

diff --git a/Lib/functools.py b/Lib/functools.py
index b8463ad245..24fdb166ab 100644
--- a/Lib/functools.py
+++ b/Lib/functools.py
@@ -392,6 +392,12 @@ def lru_cache(maxsize=128, typed=False):
     # The internals of the lru_cache are encapsulated for thread safety and
     # to allow the implementation to change (including a possible C version).
 
+    # Early detection of an erroneous call to @lru_cache without any arguments
+    # resulting in the inner function being passed to maxsize instead of an
+    # integer or None.
+    if maxsize is not None and not isinstance(maxsize, int):
+        raise TypeError('Expected maxsize to be an integer or None')
+
     # Constants shared by all lru cache instances:
     sentinel = object()          # unique object used to signal cache misses
     make_key = _make_key         # build a key from the function arguments
diff --git a/Lib/test/test_functools.py b/Lib/test/test_functools.py
index 75ae7f3a15..a7e5c7e3ef 100644
--- a/Lib/test/test_functools.py
+++ b/Lib/test/test_functools.py
@@ -1070,6 +1070,13 @@ class TestLRU(unittest.TestCase):
         self.assertEqual(test_func(DoubleEq(2)),    # Trigger a re-entrant __eq__ call
                          DoubleEq(2))               # Verify the correct return value
 
+    def test_early_detection_of_bad_call(self):
+        # Issue #22184
+        with self.assertRaises(TypeError):
+            @functools.lru_cache
+            def f():
+                pass
+
 
 class TestSingleDispatch(unittest.TestCase):
     def test_simple_overloads(self):
diff --git a/Misc/NEWS b/Misc/NEWS
index 1c87874afc..310a3b0b36 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -30,6 +30,9 @@ Library
 - Issue #21448: Changed FeedParser feed() to avoid O(N**2) behavior when
   parsing long line.  Original patch by Raymond Hettinger.
 
+- Issue #22184:  The functools LRU Cache decorator factory now gives an earlier
+  and clearer error message when the user forgets the required parameters.
+
 - Issue #17923: glob() patterns ending with a slash no longer match non-dirs on
   AIX.  Based on patch by Delhallt.