From b655d24bfb4d0cc1bedfed769416a30ccfd431d4 Mon Sep 17 00:00:00 2001
From: Joseph Hamman <joe@earthmover.io>
Date: Thu, 18 Apr 2024 20:48:03 -0700
Subject: [PATCH] deprecate(stores): add deprecation warnings to DBMStore,
 LMDBStore, SQLiteStore, MongoDBStore, RedisStore, and ABSStore

---
 zarr/_storage/absstore.py | 15 ++++++++++++++-
 zarr/_storage/store.py    |  5 +++++
 zarr/storage.py           | 31 +++++++++++++++++++++++++++++++
 3 files changed, 50 insertions(+), 1 deletion(-)

diff --git a/zarr/_storage/absstore.py b/zarr/_storage/absstore.py
index 217b2a29e0..5d2606f2f2 100644
--- a/zarr/_storage/absstore.py
+++ b/zarr/_storage/absstore.py
@@ -5,7 +5,14 @@
 
 from numcodecs.compat import ensure_bytes
 from zarr.util import normalize_storage_path
-from zarr._storage.store import _get_metadata_suffix, data_root, meta_root, Store, StoreV3
+from zarr._storage.store import (
+    _get_metadata_suffix,
+    data_root,
+    meta_root,
+    Store,
+    StoreV3,
+    V3_DEPRECATION_MESSAGE,
+)
 from zarr.types import DIMENSION_SEPARATOR
 
 __doctest_requires__ = {
@@ -73,6 +80,12 @@ def __init__(
         dimension_separator: Optional[DIMENSION_SEPARATOR] = None,
         client=None,
     ):
+        warnings.warn(
+            V3_DEPRECATION_MESSAGE.format(store=self.__class__.__name__),
+            FutureWarning,
+            stacklevel=3,
+        )
+
         self._dimension_separator = dimension_separator
         self.prefix = normalize_storage_path(prefix)
         if client is None:
diff --git a/zarr/_storage/store.py b/zarr/_storage/store.py
index 0a08080548..bc4a3ca496 100644
--- a/zarr/_storage/store.py
+++ b/zarr/_storage/store.py
@@ -24,6 +24,11 @@
 
 v3_api_available = os.environ.get("ZARR_V3_EXPERIMENTAL_API", "0").lower() not in ["0", "false"]
 
+V3_DEPRECATION_MESSAGE = (
+    "The {store} is deprecated and will be removed in a Zarr-Python version 3, see"
+    "https://github.com/zarr-developers/zarr-python/issues/1274 for more information."
+)
+
 
 def assert_zarr_v3_api_available():
     if not v3_api_available:
diff --git a/zarr/storage.py b/zarr/storage.py
index 10f55f0ba3..7f03462403 100644
--- a/zarr/storage.py
+++ b/zarr/storage.py
@@ -88,6 +88,7 @@
     DEFAULT_ZARR_VERSION,
     BaseStore,
     Store,
+    V3_DEPRECATION_MESSAGE,
 )
 
 __doctest_requires__ = {
@@ -2083,6 +2084,12 @@ def __init__(
         dimension_separator: Optional[DIMENSION_SEPARATOR] = None,
         **open_kwargs,
     ):
+        warnings.warn(
+            V3_DEPRECATION_MESSAGE.format(store=self.__class__.__name__),
+            FutureWarning,
+            stacklevel=2,
+        )
+
         if open is None:
             import dbm
 
@@ -2261,6 +2268,12 @@ def __init__(
     ):
         import lmdb
 
+        warnings.warn(
+            V3_DEPRECATION_MESSAGE.format(store=self.__class__.__name__),
+            FutureWarning,
+            stacklevel=2,
+        )
+
         # set default memory map size to something larger than the lmdb default, which is
         # very likely to be too small for any moderate array (logic copied from zict)
         map_size = 2**40 if sys.maxsize >= 2**32 else 2**28
@@ -2612,6 +2625,12 @@ class SQLiteStore(Store):
     def __init__(self, path, dimension_separator: Optional[DIMENSION_SEPARATOR] = None, **kwargs):
         import sqlite3
 
+        warnings.warn(
+            V3_DEPRECATION_MESSAGE.format(store=self.__class__.__name__),
+            FutureWarning,
+            stacklevel=2,
+        )
+
         self._dimension_separator = dimension_separator
 
         # normalize path
@@ -2810,6 +2829,12 @@ def __init__(
     ):
         import pymongo
 
+        warnings.warn(
+            V3_DEPRECATION_MESSAGE.format(store=self.__class__.__name__),
+            FutureWarning,
+            stacklevel=2,
+        )
+
         self._database = database
         self._collection = collection
         self._dimension_separator = dimension_separator
@@ -2885,6 +2910,12 @@ def __init__(
     ):
         import redis
 
+        warnings.warn(
+            V3_DEPRECATION_MESSAGE.format(store=self.__class__.__name__),
+            FutureWarning,
+            stacklevel=2,
+        )
+
         self._prefix = prefix
         self._kwargs = kwargs
         self._dimension_separator = dimension_separator