Prevent cached callables being invoked multiple times when multithrea…

…ding

CHANGELOG.rst

@@ -1,3 +1,9 @@
+v4.2.4 (2021-09-30)
+===================
+
+- Add submodule shims for backward compatibility.
+
+
 v4.2.3 (2021-09-29)
 ===================
 

setup.cfg

@@ -36,7 +36,9 @@ where = src
 max-line-length = 80
 exclude = .git, .tox, build
 select = C, E, F, W, B, B950, I, N
-ignore = E501, W503
+# F401: imported but unused (submodule shims)
+# E501: line too long (black)
+ignore = F401, E501
 
 [build_sphinx]
 source-dir = docs/

src/cachetools/__init__.py

@@ -12,7 +12,7 @@
     "cachedmethod",
 )
 
-__version__ = "4.2.3"
+__version__ = "4.2.4"
 
 import collections
 import collections.abc

src/cachetools/cache.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import Cache
+
+warnings.warn(
+    "cachetools.cache is deprecated, please use cachetools.Cache", DeprecationWarning
+)

src/cachetools/fifo.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import FIFOCache
+
+warnings.warn(
+    "cachetools.fifo is deprecated, please use cachetools.FIFOCache", DeprecationWarning
+)

src/cachetools/lfu.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import LFUCache
+
+warnings.warn(
+    "cachetools.lfu is deprecated, please use cachetools.LFUCache", DeprecationWarning
+)

src/cachetools/lru.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import LRUCache
+
+warnings.warn(
+    "cachetools.lru is deprecated, please use cachetools.LRUCache", DeprecationWarning
+)

src/cachetools/mru.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import MRUCache
+
+warnings.warn(
+    "cachetools.mru is deprecated, please use cachetools.MRUCache", DeprecationWarning
+)

src/cachetools/rr.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import RRCache
+
+warnings.warn(
+    "cachetools.rr is deprecated, please use cachetools.RRCache", DeprecationWarning
+)

src/cachetools/ttl.py

@@ -0,0 +1,7 @@
+import warnings
+
+from . import TTLCache
+
+warnings.warn(
+    "cachetools.ttl is deprecated, please use cachetools.TTLCache", DeprecationWarning
+)

tests/test_deprecated.py

@@ -0,0 +1,67 @@
+import unittest
+import warnings
+
+
+class DeprecatedTest(unittest.TestCase):
+    def test_cache(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.cache import Cache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.cache" in str(w[-1].message)
+
+    def test_fifo(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.fifo import FIFOCache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.fifo" in str(w[-1].message)
+
+    def test_lfu(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.lfu import LFUCache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.lfu" in str(w[-1].message)
+
+    def test_lru(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.lru import LRUCache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.lru" in str(w[-1].message)
+
+    def test_mru(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.mru import MRUCache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.mru" in str(w[-1].message)
+
+    def test_rr(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.rr import RRCache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.rr" in str(w[-1].message)
+
+    def test_ttl(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            from cachetools.ttl import TTLCache
+
+            assert len(w) == 1
+            assert issubclass(w[-1].category, DeprecationWarning)
+            assert "cachetools.ttl" in str(w[-1].message)