refactor: deprecate breeding_group and clear field (#1640)

* refactor: deprecate breeding_group and clear field

* docs: update docs to show deprecation

* fix: change how breeding_group gets cleared

* chore: typo

* chore: lint

* tests: assert that breeding group was cleared

Author: dbirman

docs/source/components/subjects.md

@@ -8,7 +8,7 @@ Description of breeding info for subject
 
 | Field | Type | Title (Description) |
 |-------|------|-------------|
-| `breeding_group` | `str` | Breeding Group  |
+| <del>`breeding_group`</del> | `str` | **[DEPRECATED]** Field will be removed in future releases. Breeding Group  |
 | `maternal_id` | `str` | Maternal specimen ID  |
 | `maternal_genotype` | `str` | Maternal genotype  |
 | `paternal_id` | `str` | Paternal specimen ID  |

src/aind_data_schema/components/subjects.py

@@ -72,12 +72,26 @@ class Housing(DataModel):
 class BreedingInfo(DataModel):
     """Description of breeding info for subject"""
 
-    breeding_group: str = Field(..., title="Breeding Group")
+    breeding_group: Optional[str] = Field(
+        default=None, title="Breeding Group", deprecated="Field will be removed in future releases"
+    )
     maternal_id: str = Field(..., title="Maternal specimen ID")
     maternal_genotype: str = Field(..., title="Maternal genotype")
     paternal_id: str = Field(..., title="Paternal specimen ID")
     paternal_genotype: str = Field(..., title="Paternal genotype")
 
+    @field_validator("breeding_group", mode="before")
+    def warn_breeding_group_deprecated(cls, v: Optional[str]) -> Optional[str]:
+        """Validator to warn about deprecated breeding_group field"""
+        if v:
+            import warnings
+
+            warnings.warn(
+                "The 'breeding_group' field is deprecated and will be removed. The field's value has been cleared.",
+                DeprecationWarning,
+            )
+        return None
+
 
 class MouseSubject(DataModel):
     """Description of a mouse subject"""

tests/test_subject.py

@@ -54,6 +54,19 @@ def test_constructors(self):
         Subject.model_validate_json(s.model_dump_json())
 
         self.assertIsNotNone(s)
+        self.assertIsNone(s.subject_details.breeding_info.breeding_group)
+
+    def test_breeding_info_deprecated_field(self):
+        """test that using deprecated field raises warning"""
+
+        with self.assertWarns(DeprecationWarning):
+            BreedingInfo(
+                breeding_group="Emx1-IRES-Cre(ND)",
+                maternal_id="546543",
+                maternal_genotype="Emx1-IRES-Cre/wt; Camk2a-tTa/Camk2a-tTA",
+                paternal_id="232323",
+                paternal_genotype="Ai93(TITL-GCaMP6f)/wt",
+            )
 
 
 if __name__ == "__main__":