Rename open_backend_array as open_storage_array

Rename backend_storage_name as get_storage_name

Rename is_backend_storage_array as is_storage_array

cubed.storage.backend -> cubed.storage.store

cubed.storage.backends -> cubed.storage.stores

Update docs

Author: tomwhite

cubed/core/ops.py

@@ -23,7 +23,7 @@
 from cubed.primitive.memory import get_buffer_copies
 from cubed.primitive.rechunk import rechunk as primitive_rechunk
 from cubed.spec import spec_from_config
-from cubed.storage.backend import is_backend_storage_array, open_backend_array
+from cubed.storage.store import is_storage_array, open_storage_array
 from cubed.storage.zarr import lazy_zarr_array
 from cubed.types import T_RegularChunks, T_Shape
 from cubed.utils import (
@@ -112,7 +112,7 @@ def from_zarr(store, path=None, spec=None) -> "Array":
     """
     name = gensym()
     spec = spec or spec_from_config(config)
-    target = open_backend_array(
+    target = open_storage_array(
         store,
         mode="r",
         path=path,
@@ -181,7 +181,7 @@ def store(
 
 
 def _store_array(source: "Array", target, path=None, region=None):
-    if target is not None and not is_backend_storage_array(target):
+    if target is not None and not is_storage_array(target):
         target = lazy_zarr_array(
             target,
             shape=source.shape,

cubed/core/plan.py

@@ -15,7 +15,7 @@
 from cubed.primitive.types import PrimitiveOperation
 from cubed.runtime.pipeline import visit_nodes
 from cubed.runtime.types import ComputeEndEvent, ComputeStartEvent, CubedPipeline
-from cubed.storage.backend import is_backend_storage_array
+from cubed.storage.store import is_storage_array
 from cubed.storage.zarr import LazyZarrArray, open_if_lazy_zarr_array
 from cubed.utils import (
     chunk_memory,
@@ -456,9 +456,7 @@ def visualize(
                 chunkmem = memory_repr(chunk_memory(target))
 
                 # materialized arrays are light orange, virtual arrays are white
-                if isinstance(target, LazyZarrArray) or is_backend_storage_array(
-                    target
-                ):
+                if isinstance(target, LazyZarrArray) or is_storage_array(target):
                     d["style"] = "filled"
                     d["fillcolor"] = "#ffd8b1"
                 if n in array_display_names:

cubed/primitive/blockwise.py

@@ -18,7 +18,7 @@
 from cubed.primitive.memory import BufferCopies, MemoryModeller, calculate_projected_mem
 from cubed.primitive.types import CubedArrayProxy, PrimitiveOperation
 from cubed.runtime.types import CubedPipeline
-from cubed.storage.backend import is_backend_storage_array
+from cubed.storage.store import is_storage_array
 from cubed.storage.zarr import LazyZarrArray, T_ZarrArray, lazy_zarr_array
 from cubed.types import T_Chunks, T_DType, T_RegularChunks, T_Shape, T_Store
 from cubed.utils import (
@@ -367,9 +367,7 @@ def general_blockwise(
                     f"All outputs must have matching number of blocks in each dimension. Chunks specified: {chunkss}"
                 )
         ta: Union[zarr.Array, LazyZarrArray]
-        if is_backend_storage_array(target_store) or isinstance(
-            target_store, LazyZarrArray
-        ):
+        if is_storage_array(target_store) or isinstance(target_store, LazyZarrArray):
             ta = target_store
         else:
             ta = lazy_zarr_array(

cubed/storage/backend.py renamed to cubed/storage/store.py

@@ -4,7 +4,7 @@
 from cubed.types import T_DType, T_RegularChunks, T_Shape, T_Store
 
 
-def backend_storage_name():
+def get_storage_name():
     # get storage name from top-level config
     # e.g. set globally with CUBED_STORAGE_NAME=tensorstore
     storage_name = config.get("storage_name", None)
@@ -20,23 +20,23 @@ def backend_storage_name():
     return storage_name
 
 
-def is_backend_storage_array(obj):
-    storage_name = backend_storage_name()
+def is_storage_array(obj):
+    storage_name = get_storage_name()
 
     if storage_name == "zarr-python":
         import zarr
 
-        from cubed.storage.backends.zarr_python import ZarrArrayGroup
+        from cubed.storage.stores.zarr_python import ZarrArrayGroup
 
         return isinstance(obj, (zarr.Array, ZarrArrayGroup))
     elif storage_name in ("zarr-python-v3", "zarrs-python"):
         import zarr
 
-        from cubed.storage.backends.zarr_python_v3 import ZarrV3ArrayGroup
+        from cubed.storage.stores.zarr_python_v3 import ZarrV3ArrayGroup
 
         return isinstance(obj, (zarr.Array, ZarrV3ArrayGroup))
     elif storage_name == "tensorstore":
-        from cubed.storage.backends.tensorstore import (
+        from cubed.storage.stores.tensorstore import (
             TensorStoreArray,
             TensorStoreGroup,
         )
@@ -46,7 +46,7 @@ def is_backend_storage_array(obj):
         raise ValueError(f"Unrecognized storage name: {storage_name}")
 
 
-def open_backend_array(
+def open_storage_array(
     store: T_Store,
     mode: str,
     *,
@@ -56,10 +56,10 @@ def open_backend_array(
     path: Optional[str] = None,
     **kwargs,
 ):
-    storage_name = backend_storage_name()
+    storage_name = get_storage_name()
 
     if storage_name == "zarr-python":
-        from cubed.storage.backends.zarr_python import open_zarr_array  # type: ignore
+        from cubed.storage.stores.zarr_python import open_zarr_array  # type: ignore
 
         open_func = open_zarr_array
 
@@ -73,15 +73,15 @@ def open_backend_array(
             kwargs["object_codec"] = object_codec
 
     elif storage_name == "zarr-python-v3":
-        from cubed.storage.backends.zarr_python_v3 import open_zarr_v3_array
+        from cubed.storage.stores.zarr_python_v3 import open_zarr_v3_array
 
         open_func = open_zarr_v3_array
     elif storage_name == "zarrs-python":
-        from cubed.storage.backends.zarrs_python import open_zarr_v3_array
+        from cubed.storage.stores.zarrs_python import open_zarr_v3_array
 
         open_func = open_zarr_v3_array
     elif storage_name == "tensorstore":
-        from cubed.storage.backends.tensorstore import open_tensorstore_array
+        from cubed.storage.stores.tensorstore import open_tensorstore_array
 
         open_func = open_tensorstore_array
     else:

cubed/storage/backends/__init__.py renamed to cubed/storage/stores/__init__.py

@@ -2,7 +2,7 @@
 import zarrs  # noqa: F401
 
 # re-export the Zarr v3 open function
-from cubed.storage.backends.zarr_python_v3 import open_zarr_v3_array  # noqa: F401
+from cubed.storage.stores.zarr_python_v3 import open_zarr_v3_array  # noqa: F401
 
 # need to set zarr config after importing from zarr_python_v3 to ensure pipeline is set
 zarr.config.set(

cubed/storage/backends/tensorstore.py renamed to cubed/storage/stores/tensorstore.py

@@ -2,7 +2,7 @@
 
 import zarr
 
-from cubed.storage.backend import open_backend_array
+from cubed.storage.store import open_storage_array
 from cubed.storage.types import ArrayMetadata
 from cubed.types import T_DType, T_RegularChunks, T_Shape, T_Store
 
@@ -42,7 +42,7 @@ def create(self, mode: str = "w-") -> zarr.Array:
             The mode to open the Zarr array with using ``zarr.open``.
             Default is 'w-', which means create, fail it already exists.
         """
-        target = open_backend_array(
+        target = open_storage_array(
             self.store,
             mode=mode,
             shape=self.shape,
@@ -59,7 +59,7 @@ def open(self) -> zarr.Array:
         Note that the Zarr array must have been created or this method will raise an exception.
         """
         # r+ means read/write, fail if it doesn't exist
-        return open_backend_array(
+        return open_storage_array(
             self.store,
             mode="r+",
             shape=self.shape,