rename store_kwargs->chunkmanager_store_kwargs

Author: TomNicholas

xarray/backends/api.py

@@ -1546,7 +1546,7 @@ def to_zarr(
     safe_chunks: bool = True,
     storage_options: dict[str, str] | None = None,
     zarr_version: int | None = None,
-    store_kwargs: dict[str, Any] | None = None,
+    chunkmanager_store_kwargs: dict[str, Any] | None = None,
 ) -> backends.ZarrStore:
     ...
 
@@ -1569,7 +1569,7 @@ def to_zarr(
     safe_chunks: bool = True,
     storage_options: dict[str, str] | None = None,
     zarr_version: int | None = None,
-    store_kwargs: dict[str, Any] | None = None,
+    chunkmanager_store_kwargs: dict[str, Any] | None = None,
 ) -> Delayed:
     ...
 
@@ -1589,7 +1589,7 @@ def to_zarr(
     safe_chunks: bool = True,
     storage_options: dict[str, str] | None = None,
     zarr_version: int | None = None,
-    store_kwargs: dict[str, Any] | None = None,
+    chunkmanager_store_kwargs: dict[str, Any] | None = None,
 ) -> backends.ZarrStore | Delayed:
     """This function creates an appropriate datastore for writing a dataset to
     a zarr ztore
@@ -1711,7 +1711,9 @@ def to_zarr(
     writer = ArrayWriter()
     # TODO: figure out how to properly handle unlimited_dims
     dump_to_store(dataset, zstore, writer, encoding=encoding)
-    writes = writer.sync(compute=compute, store_kwargs=store_kwargs)
+    writes = writer.sync(
+        compute=compute, chunkmanager_store_kwargs=chunkmanager_store_kwargs
+    )
 
     if compute:
         _finalize_store(writes, zstore)

xarray/backends/common.py

@@ -164,16 +164,16 @@ def add(self, source, target, region=None):
             else:
                 target[...] = source
 
-    def sync(self, compute=True, store_kwargs=None):
+    def sync(self, compute=True, chunkmanager_store_kwargs=None):
         if self.sources:
             chunkmanager = get_chunked_array_type(*self.sources)
 
             # TODO: consider wrapping targets with dask.delayed, if this makes
             # for any discernible difference in perforance, e.g.,
             # targets = [dask.delayed(t) for t in self.targets]
 
-            if store_kwargs is None:
-                store_kwargs = {}
+            if chunkmanager_store_kwargs is None:
+                chunkmanager_store_kwargs = {}
 
             delayed_store = chunkmanager.store(
                 self.sources,
@@ -182,7 +182,7 @@ def sync(self, compute=True, store_kwargs=None):
                 compute=compute,
                 flush=True,
                 regions=self.regions,
-                **store_kwargs,
+                **chunkmanager_store_kwargs,
             )
             self.sources = []
             self.targets = []

xarray/core/daskmanager.py

@@ -198,8 +198,6 @@ def store(
     ):
         from dask.array import store
 
-        # TODO separate expected store kwargs from other compute kwargs?
-
         return store(
             sources=sources,
             targets=targets,

xarray/core/dataset.py

@@ -1972,7 +1972,7 @@ def to_zarr(
         safe_chunks: bool = True,
         storage_options: dict[str, str] | None = None,
         zarr_version: int | None = None,
-        store_kwargs: dict[str, Any] | None = None,
+        chunkmanager_store_kwargs: dict[str, Any] | None = None,
     ) -> ZarrStore:
         ...
 
@@ -1994,7 +1994,7 @@ def to_zarr(
         safe_chunks: bool = True,
         storage_options: dict[str, str] | None = None,
         zarr_version: int | None = None,
-        store_kwargs: dict[str, Any] | None = None,
+        chunkmanager_store_kwargs: dict[str, Any] | None = None,
     ) -> Delayed:
         ...
 
@@ -2013,7 +2013,7 @@ def to_zarr(
         safe_chunks: bool = True,
         storage_options: dict[str, str] | None = None,
         zarr_version: int | None = None,
-        store_kwargs: dict[str, Any] | None = None,
+        chunkmanager_store_kwargs: dict[str, Any] | None = None,
     ) -> ZarrStore | Delayed:
         """Write dataset contents to a zarr group.
 
@@ -2102,7 +2102,7 @@ def to_zarr(
             The desired zarr spec version to target (currently 2 or 3). The
             default of None will attempt to determine the zarr version from
             ``store`` when possible, otherwise defaulting to 2.
-        store_kwargs : dict
+        chunkmanager_store_kwargs : dict
             Additional keyword arguments passed on to the `ChunkManager.store` method used to store
             chunked arrays. For example for a dask array additional kwargs will be passed eventually to
             :py:func:`dask.array.store()`. Experimental API that should not be relied upon.
@@ -2151,7 +2151,7 @@ def to_zarr(
             region=region,
             safe_chunks=safe_chunks,
             zarr_version=zarr_version,
-            store_kwargs=store_kwargs,
+            chunkmanager_store_kwargs=chunkmanager_store_kwargs,
         )
 
     def __repr__(self) -> str: