Add deprecation warnings

Author: Mauko Quiroga

openfisca_core/data_storage.py

@@ -1,6 +1,7 @@
 import abc
 import os
 import shutil
+import warnings
 from typing import Any, Dict, KeysView, Optional, Union
 
 import numpy
@@ -51,11 +52,11 @@ def delete(self, period: Optional[Period] = None) -> None:
         ...
 
     @abc.abstractmethod
-    def memory_usage(self) -> Dict[str, int]:
+    def known_periods(self) -> KeysView[Period]:
         ...
 
     @abc.abstractmethod
-    def known_periods(self) -> KeysView[Period]:
+    def memory_usage(self) -> Dict[str, int]:
         ...
 
 
@@ -107,9 +108,13 @@ def memory_usage(self, state: StateType) -> Dict[str, int]:
             "cell_size": array.itemsize,
             }
 
+    def restore(self, state: StateType) -> StateType:
+        ...
+
 
 class DiskStorage(StorageLike):
     """Low-level class responsible for storing and retrieving values on disk."""
+
     directory: str
     preserve: bool
 
@@ -120,7 +125,7 @@ def __init__(self, directory: str, preserve: bool) -> None:
         if not os.path.isdir(self.directory):
             os.makedirs(self.directory, exist_ok = True)
 
-    def get(self, state: Dict[Period, Any], key: Period) -> Any:
+    def get(self, state: StateType, key: Period) -> Any:
         file = state.get(key)
 
         if file is None:
@@ -241,20 +246,35 @@ def delete(self, period: Optional[Period] = None) -> None:
         casted: Period = self.cast_period(period, self.is_eternal)
         self.state = self.storage.delete(self.state, casted)
 
-    def memory_usage(self) -> Dict[str, int]:
-        return self.storage.memory_usage(self.state)
-
     def known_periods(self) -> KeysView[Period]:
         return self.state.keys()
 
-    # TODO : test
+    def memory_usage(self) -> Dict[str, int]:
+        return self.storage.memory_usage(self.state)
+
     def get_known_periods(self) -> KeysView[Period]:
-        raise ValueError("TODO: add a deprecation warning")
+        message = [
+            "The 'Cache.get_known_periods' method has been deprecated since version",
+            "34.8.0, and will be removed in the future. Henceforth, please prefer",
+            "Cache.known_periods.",
+            ]
+        warnings.warn(" ".join(message), DeprecationWarning)
+        return self.known_periods()
 
-    # TODO : test
     def get_memory_usage(self) -> Dict[str, int]:
-        raise ValueError("TODO: add a deprecation warning")
-
-    # TODO : test
-    def restore(self, state: StateType) -> StateType:
-        raise ValueError("TODO: add a deprecation warning")
+        message = [
+            "The 'Cache.get_memory_usage' method has been deprecated since version",
+            "34.8.0, and will be removed in the future. Henceforth, please prefer",
+            "Cache.memory_usage.",
+            ]
+        warnings.warn(" ".join(message), DeprecationWarning)
+        return self.memory_usage()
+
+    def restore(self) -> StateType:
+        message = [
+            "The 'Cache.restore' method has been deprecated since version",
+            "34.8.0, and will be removed in the future. Henceforth, please prefer",
+            "DiskStorage.restore.",
+            ]
+        warnings.warn(" ".join(message), DeprecationWarning)
+        return self.storage.restore(self.state)

tests/core/data_storage/test_cache.py

@@ -100,7 +100,7 @@ def test_delete_when_is_eternal(cache, storage, period, eternal_period, mocker):
     storage.delete.assert_called_once_with(*result)
 
 
-def test_get_memory_usage(cache, storage, mocker):
+def test_memory_usage(cache, storage, mocker):
     mocker.patch.object(storage, "memory_usage")
     cache.memory_usage()
 
@@ -115,3 +115,29 @@ def test_known_periods(cache, period, array):
     result = cache.known_periods()
 
     assert period in result
+
+
+def test_get_known_periods(cache, mocker):
+    mocker.patch.object(cache, "known_periods")
+
+    with pytest.warns(DeprecationWarning):
+        cache.get_known_periods()  # act
+        cache.known_periods.assert_called_once()
+
+
+def test_get_memory_usage(cache, storage, mocker):
+    mocker.patch.object(storage, "memory_usage")
+
+    with pytest.warns(DeprecationWarning):
+        cache.get_memory_usage()
+        result = {}
+        storage.memory_usage.assert_called_once_with(result)
+
+
+def test_restore(cache, storage, mocker):
+    mocker.patch.object(storage, "restore")
+
+    with pytest.warns(DeprecationWarning):
+        cache.restore()
+        result = {}
+        storage.restore.assert_called_once_with(result)