Add get_annotations to a sample resource

genialis · Nov 22, 2023 · ff2e69d · ff2e69d
1 parent 1f22257
commit ff2e69d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
@@ -18,6 +18,8 @@ Added
 -----
 - Add ``set_annotations`` on ``Sample`` resource to allow bulk annotation
   update
+- Add ``get_annotations`` on ``Sample`` which returns all annotations on a
+  sample as a dictionary
 
 
 ===================

diff --git a/src/resdk/resources/sample.py b/src/resdk/resources/sample.py
@@ -282,6 +282,13 @@ def set_annotation(self, full_path: str, value) -> Optional["AnnotationValue"]:
             )
         return annotation_value
 
+    def get_annotations(self) -> Dict[str, Any]:
+        """Get all annotations for the given sample in a dictionary."""
+        return {
+            str(annotation.field): annotation.value
+            for annotation in self.annotations.all()
+        }
+
     def set_annotations(self, annotations: Dict[str, Any]):
         """Bulk set annotations on the sample."""
         payload = [