Parse dataset id from downloaded nml (#1256)

* parse dataset id from downloaded nml

* add changelog entry

* add test testing access to renamed dataset from an annotation
- improve existing test to check whether the dataset id is parsed from a zipped annotation

* format tests

* fix dumping dataset id to nml in wklibs

* remove regression test and do it in a follow up pr

* remove debug logs

---------

Co-authored-by: Michael Büßemeyer <[email protected]>

Author: MichaelBuessemeyer

webknossos/Changelog.md

@@ -19,6 +19,7 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
 ### Changed
 
 ### Fixed
+- Fixed opening a renamed dataset via an annotation link. [#1256](https://github.com/scalableminds/webknossos-libs/pull/1256)
 
 
 ## [0.16.8](https://github.com/scalableminds/webknossos-libs/releases/tag/v0.16.8) - 2025-02-04

webknossos/testdata/annotations/l4dense_motta_et_al_demo_v2__explorational__4a6356.zip

@@ -21,6 +21,7 @@ def test_annotation_from_wkw_zip_file() -> None:
 
     assert annotation.dataset_name == "l4dense_motta_et_al_demo_v2"
     assert annotation.organization_id == "scalable_minds"
+    assert annotation.dataset_id == "67b7c81b0100004d00f5ab31"
     assert annotation.owner_name == "Philipp Otto"
     assert annotation.annotation_id == "61c20205010000cc004a6356"
     assert "timestamp" in annotation.metadata
@@ -32,6 +33,7 @@ def test_annotation_from_wkw_zip_file() -> None:
 
     assert copied_annotation.dataset_name == "l4dense_motta_et_al_demo_v2"
     assert copied_annotation.organization_id == "scalable_minds"
+    assert copied_annotation.dataset_id == "67b7c81b0100004d00f5ab31"
     assert copied_annotation.owner_name == "Philipp Otto"
     assert copied_annotation.annotation_id == "61c20205010000cc004a6356"
     assert "timestamp" in copied_annotation.metadata

webknossos/tests/test_annotation.py

@@ -15,6 +15,7 @@ class Parameters(NamedTuple):
     scale: Vector3  # dataset voxel_size
     description: Optional[str] = None
     organization: Optional[str] = None
+    dataset_id: Optional[str] = None
     offset: Optional[Vector3] = None  # deprecated. Kept for backward compatibility.
     time: Optional[int] = (
         None  # UNIX timestamp marking the creation time & date of an annotation.
@@ -87,6 +88,7 @@ def _dump(self, xf: XmlWriter) -> None:
                     "name": self.name,
                     "organization": self.organization,
                     "description": self.description,
+                    "datasetId": self.dataset_id,
                 }
             ),
         )
@@ -240,6 +242,7 @@ def _parse(cls, nml_parameters: Element) -> "Parameters":
             name=experiment_element.get("name", "Unnamed Experiment"),
             description=experiment_element.get("description"),
             organization=experiment_element.get("organization"),
+            dataset_id=experiment_element.get("datasetId"),
             scale=(
                 float(scale_element.get("x", 0)),
                 float(scale_element.get("y", 0)),

webknossos/webknossos/_nml/parameters.py

@@ -19,6 +19,7 @@ def nml_to_skeleton(nml: wknml.Nml) -> "Skeleton":
     from ..skeleton import Skeleton
 
     skeleton = Skeleton(
+        dataset_id=nml.parameters.dataset_id,
         dataset_name=nml.parameters.name,
         voxel_size=nml.parameters.scale,
         organization_id=nml.parameters.organization,
@@ -120,7 +121,8 @@ def _random_color_rgba() -> Tuple[float, float, float, float]:
 def annotation_to_nml(
     annotation: "Annotation",
 ) -> wknml.Nml:
-    nmlParameters = wknml.Parameters(
+    nml_parameters = wknml.Parameters(
+        dataset_id=annotation.dataset_id,
         name=annotation.dataset_name,
         scale=annotation.voxel_size,
         description=annotation.description,
@@ -199,7 +201,7 @@ def annotation_to_nml(
 
     nml = wknml.Nml(
         meta=meta,
-        parameters=nmlParameters,
+        parameters=nml_parameters,
         trees=trees,
         branchpoints=branchpoints,
         comments=comments,