get_slice_dataset --> open_slice_source

Author: forman

tests/test_slice.py

@@ -10,7 +10,7 @@
 from zappend.context import Context
 from zappend.fsutil.fileobj import FileObj
 from zappend.slice.abc import SliceSource
-from zappend.slice.factory import get_slice_dataset
+from zappend.slice.factory import open_slice_source
 from zappend.slice.factory import import_attribute
 from zappend.slice.factory import to_slice_factories
 from zappend.slice.factory import normalize_slice_arg
@@ -22,7 +22,7 @@
 from .test_context import CustomSliceSource
 
 
-class GetSliceDatasetTest(unittest.TestCase):
+class OpenSliceSourceTest(unittest.TestCase):
     def setUp(self):
         clear_memory_fs()
 
@@ -33,7 +33,7 @@ def test_slice_source_class_slice_source(self):
                 slice_source="tests.test_context.CustomSliceSource",
             )
         )
-        slice_source = get_slice_dataset(ctx, 7)
+        slice_source = open_slice_source(ctx, 7)
         self.assertIsInstance(slice_source, CustomSliceSource)
         self.assertEqual(7, slice_source.index)
 
@@ -44,7 +44,7 @@ def test_slice_source_func_slice_source(self):
                 slice_source="tests.test_context.new_custom_slice_source",
             )
         )
-        slice_source = get_slice_dataset(ctx, 13)
+        slice_source = open_slice_source(ctx, 13)
         self.assertIsInstance(slice_source, CustomSliceSource)
         self.assertEqual(13, slice_source.index)
 
@@ -63,13 +63,13 @@ def test_slice_source_class_slice_source_fails(self):
                 " 'false_slice_source_function', but got <class 'int'>"
             ),
         ):
-            get_slice_dataset(ctx, "test.nc")
+            open_slice_source(ctx, "test.nc")
 
     def test_slice_source_slice_source(self):
         dataset = make_test_dataset()
         ctx = Context(dict(target_dir="memory://target.zarr"))
         slice_obj = MemorySliceSource(ctx, dataset, 0)
-        slice_source = get_slice_dataset(ctx, slice_obj)
+        slice_source = open_slice_source(ctx, slice_obj)
         self.assertIs(slice_obj, slice_source)
 
     def test_slice_factory_slice_source(self):
@@ -80,23 +80,23 @@ def factory(_ctx):
             self.assertIs(ctx, _ctx)
             return dataset
 
-        slice_source = get_slice_dataset(ctx, factory)
+        slice_source = open_slice_source(ctx, factory)
         self.assertIsInstance(slice_source, MemorySliceSource)
         with slice_source as slice_ds:
             self.assertIs(dataset, slice_ds)
 
     def test_memory_slice_source(self):
         dataset = make_test_dataset()
         ctx = Context(dict(target_dir="memory://target.zarr"))
-        slice_source = get_slice_dataset(ctx, dataset)
+        slice_source = open_slice_source(ctx, dataset)
         self.assertIsInstance(slice_source, MemorySliceSource)
         with slice_source as slice_ds:
             self.assertIsInstance(slice_ds, xr.Dataset)
 
     def test_temporary_slice_source(self):
         dataset = make_test_dataset()
         ctx = Context(dict(target_dir="memory://target.zarr", persist_mem_slices=True))
-        slice_source = get_slice_dataset(ctx, dataset)
+        slice_source = open_slice_source(ctx, dataset)
         self.assertIsInstance(slice_source, TemporarySliceSource)
         with slice_source as slice_ds:
             self.assertIsInstance(slice_ds, xr.Dataset)
@@ -105,7 +105,7 @@ def test_file_obj_slice_source(self):
         slice_dir = FileObj("memory://slice.zarr")
         make_test_dataset(uri=slice_dir.uri)
         ctx = Context(dict(target_dir="memory://target.zarr"))
-        slice_source = get_slice_dataset(ctx, slice_dir)
+        slice_source = open_slice_source(ctx, slice_dir)
         self.assertIsInstance(slice_source, PersistentSliceSource)
         with slice_source as slice_ds:
             self.assertIsInstance(slice_ds, xr.Dataset)
@@ -114,7 +114,7 @@ def test_persistent_slice_source_for_zarr(self):
         slice_dir = FileObj("memory://slice.zarr")
         make_test_dataset(uri=slice_dir.uri)
         ctx = Context(dict(target_dir="memory://target.zarr"))
-        slice_source = get_slice_dataset(ctx, slice_dir.uri)
+        slice_source = open_slice_source(ctx, slice_dir.uri)
         self.assertIsInstance(slice_source, PersistentSliceSource)
         with slice_source as slice_ds:
             self.assertIsInstance(slice_ds, xr.Dataset)
@@ -140,7 +140,7 @@ def test_persistent_wait_success(self):
                 slice_polling=dict(timeout=0.1, interval=0.02),
             )
         )
-        slice_source = get_slice_dataset(ctx, slice_dir.uri)
+        slice_source = open_slice_source(ctx, slice_dir.uri)
         self.assertIsInstance(slice_source, PersistentSliceSource)
         with slice_source as slice_ds:
             self.assertIsInstance(slice_ds, xr.Dataset)
@@ -154,7 +154,7 @@ def test_it_raises_on_persistent_wait_fail(self):
                 slice_polling=dict(timeout=0.1, interval=0.02),
             )
         )
-        slice_source = get_slice_dataset(ctx, slice_dir.uri)
+        slice_source = open_slice_source(ctx, slice_dir.uri)
         with pytest.raises(FileNotFoundError, match=slice_dir.uri):
             with slice_source:
                 pass
@@ -164,7 +164,7 @@ def test_it_raises_on_invalid_type(self):
         ctx = Context(dict(target_dir="memory://target.zarr"))
         with pytest.raises(TypeError, match="slice_obj must be a str, "):
             # noinspection PyTypeChecker
-            get_slice_dataset(ctx, 42)
+            open_slice_source(ctx, 42)
 
 
 class YieldSlicesTest(unittest.TestCase):

zappend/processor.py

@@ -16,7 +16,7 @@
 from .log import configure_logging
 from .rollbackstore import RollbackStore
 from .slice import SliceObj
-from .slice import get_slice_dataset
+from .slice import open_slice_source
 from .tailoring import tailor_target_dataset
 from .tailoring import tailor_slice_dataset
 
@@ -83,7 +83,7 @@ def process_slice(self, slice_obj: SliceObj, slice_index: int = 0):
 
         ctx = Context(self._config)
 
-        with get_slice_dataset(ctx, slice_obj, slice_index) as slice_dataset:
+        with open_slice_source(ctx, slice_obj, slice_index) as slice_dataset:
             slice_metadata = ctx.get_dataset_metadata(slice_dataset)
             if ctx.target_metadata is None:
                 ctx.target_metadata = slice_metadata

zappend/slice/__init__.py

@@ -5,7 +5,7 @@
 from .abc import SliceSource
 from .factory import SliceFactory
 from .factory import SliceObj
-from .factory import get_slice_dataset
+from .factory import open_slice_source
 from .factory import to_slice_factories
 from .factory import to_slice_factory
 from .factory import to_slice_source_type

zappend/slice/factory.py

@@ -24,12 +24,12 @@
 """
 
 
-def get_slice_dataset(
+def open_slice_source(
     ctx: Context,
     slice_obj: SliceObj | SliceFactory | Any,
     slice_index: int = 0,
 ) -> SliceSource:
-    """Get the slice source for given slice object `slice_obj`.
+    """Open the slice source for given slice object `slice_obj`.
 
     The intended and only use of the returned slice source is as context
     manager. When used as context manager the slice source yields a slice