Update Deprecating Warning with version number. (#560)

* Update Deprecating Warning with version number.

Adding the versing number make it slightly easier on consumers to update
to the new naming as they will get a sens of compatibility.

Also update pytest to fail is any deprecation warning are not marked in
the test suite, and catch them in more places.

In particular we realise that many more places trigger the warnings in
create_store so we catch the warning there, but also that
`pickle.load()` can trigger it.

* Try to limit Deprecationwarnigs to zarr

Author: Carreau

pytest.ini

@@ -1,4 +1,6 @@
 [pytest]
 doctest_optionflags = NORMALIZE_WHITESPACE ELLIPSIS IGNORE_EXCEPTION_DETAIL
 addopts = --durations=10
+filterwarnings =
+    error::DeprecationWarning:zarr.*
 

zarr/storage.py

@@ -660,8 +660,8 @@ def clear(self):
 class DictStore(MemoryStore):
 
     def __init__(self, *args, **kwargs):
-        warnings.warn("DictStore has been renamed to MemoryStore and will be "
-                      "removed in the future. Please use MemoryStore.",
+        warnings.warn("DictStore has been renamed to MemoryStore in 2.4.0 and "
+                      "will be removed in the future. Please use MemoryStore.",
                       DeprecationWarning,
                       stacklevel=2)
         super(DictStore, self).__init__(*args, **kwargs)

zarr/tests/test_storage.py

@@ -764,13 +764,18 @@ def test_setdel(self):
 class TestDictStore(StoreTests, unittest.TestCase):
 
     def create_store(self):
-        return DictStore()
+        with pytest.warns(DeprecationWarning):
+            return DictStore()
 
     def test_deprecated(self):
-        with pytest.warns(DeprecationWarning):
-            store = self.create_store()
+        store = self.create_store()
         assert isinstance(store, MemoryStore)
 
+    def test_pickle(self):
+        with pytest.warns(DeprecationWarning):
+            # pickle.load() will also trigger deprecation warning
+            super().test_pickle()
+
 
 class TestDirectoryStore(StoreTests, unittest.TestCase):