Merge pull request #33 from michelin/BugFix---Fix-bug-when-adding-annotations

Bug fix   fix bug when adding annotations

Author: Zwartx

examples/object_classes/README.md

@@ -48,7 +48,7 @@ img_pydantic = Image.pydantic()
 
 # Now img_pydantic is a valid pydantic object will can be used to serialize the object
 
-img_dict = img_pydantic.dict()
+img_dict = img_pydantic.model_dump()
 ```
 
 ## Annotation class

src/yarrow/yarrow.py

@@ -323,16 +323,18 @@ def save_to_file(
 
         :param fp: File path to save the dataset to
         :type fp: _type_
-        :param exclude_unset: Exclude unset keys you should not write what you don't use, defaults to True
-        :type exclude_unset: bool, optional
+        :param exclude_unset: Exclude unset keys you should not write what you don't use, defaults to False
+        :type exclude_unset: bool, optional False
+        :param exclude_none: (bool) Exclude none keys you should not write what you don't use, defaults to True
+        :type exclude_none: bool, optional True
         :param indent: Number of indents in the json file, defaults to 4
         :type indent: int, optional
         :param default: default(obj) is a function that should return a serializable version of obj or raise TypeError. The default simply raises TypeError, defaults to str
         :type default: obj, optional
         """
         with open(fp, "w") as fp:
             json.dump(
-                self.dict(
+                self.model_dump(
                     exclude_unset=exclude_unset, exclude_none=exclude_none, **kwargs
                 ),
                 fp,

src/yarrow/yarrow_cls.py

@@ -6,7 +6,7 @@
 
 >>> img = Image(...)
     img_pydantic = img.pydantic() # you have a Image_pydantic instance
-    img_as_dict = img_pydantic.dict() # now you have a dict
+    img_as_dict = img_pydantic.model_dump() # now you have a dict
 
 """
 from copy import copy
@@ -211,13 +211,15 @@ def __hash__(self) -> int:
 
     def __eq__(self, other) -> bool:
         if isinstance(other, Annotation):
+
             return all(
                 (
                     self.name == other.name,
                     set(self.images) == set(other.images),
                     self.contributor == other.contributor,
                     set(self.categories) == set(other.categories),
-                    self.polygon == other.polygon,
+                    np.asarray(self.polygon).shape == np.asarray(other.polygon).shape
+                    and self.polygon == other.polygon,
                     self.polyline == other.polyline,
                     self.mask == other.mask,
                     self.bbox == other.bbox,
@@ -704,7 +706,7 @@ def from_yarrow(cls, yarrow: YarrowDataset_pydantic) -> "YarrowDataset":
         # img_list = []
         img_id_dict = {}
         for img in yarrow.images:
-            img_param = img.dict()
+            img_param = img.model_dump()
 
             # Get confidential from its id
             conf = next(

tests/test_cls.py

@@ -33,7 +33,7 @@ def new_contributor():
 @pytest.fixture
 def new_image(new_clearance: Clearance):
     new_image_pydantic = rand_image(conf_id=new_clearance.id)
-    return Image(confidential=new_clearance, **new_image_pydantic.dict())
+    return Image(confidential=new_clearance, **new_image_pydantic.model_dump())
 
 
 @pytest.fixture
@@ -45,7 +45,7 @@ def new_annotation(
         images=[new_image],
         categories=[new_category],
         contributor=new_contributor,
-        **new_annotation_pydantic.dict()
+        **new_annotation_pydantic.model_dump()
     )
 
 
@@ -216,7 +216,7 @@ def test_parse_with_null_values(yar_dataset_pydantic: YarrowDataset_pydantic):
     """
 
     # First test is with keys completely removed
-    primary_dict = yar_dataset_pydantic.dict()
+    primary_dict = yar_dataset_pydantic.model_dump()
     primary_dict.pop("annotations")
     primary_dict.pop("contributors")
     primary_dict.pop("categories")
@@ -228,7 +228,7 @@ def test_parse_with_null_values(yar_dataset_pydantic: YarrowDataset_pydantic):
     assert isinstance(yar_dataset, YarrowDataset)
 
     # Second test if values set to None
-    second_dict = yar_dataset_pydantic.dict()
+    second_dict = yar_dataset_pydantic.model_dump()
     second_dict["annotations"] = None
     second_dict["contributors"] = None
     second_dict["categories"] = None

tests/test_creation.py

@@ -0,0 +1,66 @@
+from datetime import datetime
+
+import numpy as np
+import pytest
+
+from yarrow import Annotation, Contributor, Image, Info, YarrowDataset
+
+
+@pytest.fixture
+def contributor_base():
+    return Contributor(name="Jean Claude Vandamme", human=True)
+
+
+@pytest.fixture
+def yarrow_base(contributor_base):
+    yarrow = YarrowDataset(
+        info=Info(date_created=datetime.now(), source="Bruxelles"),
+        images=[
+            Image(
+                file_name="image1.jpg",
+                height=100,
+                width=100,
+                date_captured=datetime.now(),
+            ),
+            Image(
+                file_name="image2.jpg",
+                height=100,
+                width=100,
+                date_captured=datetime.now(),
+            ),
+        ],
+        contributors=[contributor_base],
+    )
+    return yarrow
+
+
+def test_create_multiple_annotations_with_same_attributes_expected_polygon_should_works(
+    yarrow_base: YarrowDataset, contributor_base: Contributor
+):
+    """In this test we make sure adding annotations with different polygon shape is working.
+
+    Args:
+        yarrow (YarrowDataset): _description_
+        contributor (Contributor): _description_
+    """
+    # Given
+    annotation_shape_23 = Annotation(
+        contributor_base,
+        name="chaussure",
+        images=yarrow_base.images,
+        polygon=np.zeros((23, 2)),
+    )
+    annotation_shape_10 = Annotation(
+        contributor_base,
+        name="chaussure",
+        images=yarrow_base.images,
+        polygon=np.zeros((10, 2)),
+    )
+    list_annotations = [annotation_shape_23, annotation_shape_10]
+
+    # When
+    yarrow_base.add_annotations(list_annotations)
+
+    # Then
+    assert np.asarray(yarrow_base.annotations[0].polygon).shape[0] == 23
+    assert np.asarray(yarrow_base.annotations[1].polygon).shape[0] == 10

tests/test_init.py

@@ -91,19 +91,19 @@ class MetaExample(BaseModel):
 
     meta_ex = MetaExample()
 
-    image_base = rand_image().dict(exclude_unset=True)
+    image_base = rand_image().model_dump(exclude_unset=True)
     image_base["meta"] = meta_ex.json()
     image_meta = Image_pydantic(**image_base)
-    assert image_meta.meta == meta_ex.dict()
+    assert image_meta.meta == meta_ex.model_dump()
 
-    image_base2 = rand_image().dict(exclude_unset=True)
-    image_base2["meta"] = meta_ex.dict()
+    image_base2 = rand_image().model_dump(exclude_unset=True)
+    image_base2["meta"] = meta_ex.model_dump()
     image_meta2 = Image_pydantic(**image_base2)
-    assert image_meta2.meta == meta_ex.dict()
+    assert image_meta2.meta == meta_ex.model_dump()
 
-    image_base3 = rand_image().dict(exclude_unset=True)
+    image_base3 = rand_image().model_dump(exclude_unset=True)
     image_base3["meta"] = str(
-        meta_ex.dict()
+        meta_ex.model_dump()
     )  # putting the dict output in a str should not be sufficient
 
     with pytest.raises(ValidationError):
@@ -117,8 +117,8 @@ def test_annot_list_init():
     annot.image_id = [uuid4().hex for _ in range(5)]
 
     assert isinstance(
-        Annotation_pydantic(**annot.dict(exclude_unset=True)), Annotation_pydantic
+        Annotation_pydantic(**annot.model_dump(exclude_unset=True)), Annotation_pydantic
     )
-    new_annot = Annotation_pydantic(**annot.dict(exclude_unset=True))
+    new_annot = Annotation_pydantic(**annot.model_dump(exclude_unset=True))
     assert new_annot.category_id == annot.category_id
     assert new_annot.image_id == annot.image_id