Add the parameter name for Dataset.get_or_create (#353)

* allow names for get_or_create

* Update tests/test_dataset.py

Author: rschwanhold

tests/test_dataset.py

@@ -684,10 +684,19 @@ def test_dataset_get_or_create() -> None:
     ds2 = Dataset.get_or_create(ds_path, scale=(1, 1, 1))
     assert "color" in ds2.layers.keys()
 
+    ds2 = Dataset.get_or_create(
+        ds_path, scale=(1, 1, 1), name="wk_dataset_get_or_create"
+    )
+    assert "color" in ds2.layers.keys()
+
     with pytest.raises(AssertionError):
         # dataset already exists, but with a different scale
         Dataset.get_or_create(ds_path, scale=(2, 2, 2))
 
+    with pytest.raises(AssertionError):
+        # dataset already exists, but with a different name
+        Dataset.get_or_create(ds_path, scale=(1, 1, 1), name="some different name")
+
 
 def test_changing_layer_bounding_box() -> None:
     delete_dir(TESTOUTPUT_DIR / "test_changing_layer_bounding_box")

wkcuber/api/dataset.py

@@ -614,7 +614,10 @@ def create(
 
     @classmethod
     def get_or_create(
-        cls, dataset_path: Union[str, Path], scale: Tuple[float, float, float]
+        cls,
+        dataset_path: Union[str, Path],
+        scale: Tuple[float, float, float],
+        name: Optional[str] = None,
     ) -> "Dataset":
         """
         Creates a new `Dataset`, in case it did not exist before, and then returns it.
@@ -628,9 +631,13 @@ def get_or_create(
             assert tuple(ds.properties.scale) == tuple(
                 scale
             ), f"Cannot get_or_create Dataset: The dataset {dataset_path} already exists, but the scales do not match ({ds.properties.scale} != {scale})"
+            if name is not None:
+                assert (
+                    ds.name == name
+                ), f"Cannot get_or_create Dataset: The dataset {dataset_path} already exists, but the names do not match ({ds.name} != {name})"
             return ds
         else:
-            return cls.create(dataset_path, scale)
+            return cls.create(dataset_path, scale, name)
 
     def _create_layer(
         self,