Added modification date update and removed errant files from pyproject.toml (#452)

Author: dougollerenshaw

src/aind_metadata_mapper/utils.py

@@ -4,7 +4,7 @@
 import logging
 import sys
 import time
-from datetime import datetime
+from datetime import date, datetime
 from pathlib import Path
 from typing import Optional
 from urllib.parse import urljoin
@@ -348,6 +348,7 @@ def _write_instrument_to_path(
 def save_instrument(
     instrument_model: instrument.Instrument | dict | str | Path,
     replace: bool = False,
+    update_modification_date: bool = True,
 ) -> None:
     """Save instrument and validate round-trip.
 
@@ -361,6 +362,9 @@ def save_instrument(
         a JSON file. If a path (str or Path) is provided, the file is loaded and validated.
     replace : bool
         If True, overwrite existing record with same instrument_id and modification_date.
+    update_modification_date : bool
+        If True (default), set modification_date to today (YYYY-MM-DD). If False,
+        keep the modification date as passed in the instrument.
 
     Raises
     ------
@@ -377,6 +381,9 @@ def save_instrument(
     if isinstance(instrument_model, dict):
         instrument_model = instrument.Instrument.model_validate(instrument_model)
 
+    if update_modification_date:
+        instrument_model = instrument_model.model_copy(update={"modification_date": date.today()})
+
     # Use model_dump_json() and parse to ensure dates are properly serialized
     source_dict = json.loads(instrument_model.model_dump_json())
     logger.info(f"POSTing instrument to {INSTRUMENT_BASE_URL}")

tests/test_utils.py

@@ -11,7 +11,7 @@
 import shutil
 import tempfile
 import unittest
-from datetime import datetime, timedelta, timezone
+from datetime import date, datetime, timedelta, timezone
 from pathlib import Path
 from types import SimpleNamespace
 from unittest.mock import MagicMock, patch
@@ -88,11 +88,40 @@ def test_get_instrument_writes_to_file_when_output_directory_given(self, mock_he
     def test_save_instrument_loads_from_filepath(self, mock_post, mock_get):
         """save_instrument loads from file when given a path."""
         with open(INSTRUMENT_JSON) as f:
-            mock_get.return_value = instrument.Instrument.model_validate(json.load(f))
+            instrument_data = json.load(f)
+        instrument_data["modification_date"] = date.today().isoformat()
+        mock_get.return_value = instrument.Instrument.model_validate(instrument_data)
         mock_post.return_value = MagicMock(status_code=201)
         save_instrument(str(INSTRUMENT_JSON))
         mock_post.assert_called_once()
 
+    @patch("aind_metadata_mapper.utils.get_instrument")
+    @patch("aind_metadata_mapper.utils.requests.post")
+    def test_save_instrument_updates_modification_date_by_default(self, mock_post, mock_get):
+        """save_instrument sets modification_date to today when update_modification_date=True."""
+        with open(INSTRUMENT_JSON) as f:
+            instrument_data = json.load(f)
+        instrument_data["modification_date"] = date.today().isoformat()
+        mock_get.return_value = instrument.Instrument.model_validate(instrument_data)
+        mock_post.return_value = MagicMock(status_code=201)
+        save_instrument(str(INSTRUMENT_JSON))
+        posted_json = mock_post.call_args[1]["json"]
+        today = date.today().isoformat()
+        self.assertEqual(posted_json["modification_date"], today)
+
+    @patch("aind_metadata_mapper.utils.get_instrument")
+    @patch("aind_metadata_mapper.utils.requests.post")
+    def test_save_instrument_preserves_modification_date_when_false(self, mock_post, mock_get):
+        """save_instrument keeps original modification_date when update_modification_date=False."""
+        with open(INSTRUMENT_JSON) as f:
+            instrument_data = json.load(f)
+        original_date = instrument_data["modification_date"]
+        mock_get.return_value = instrument.Instrument.model_validate(instrument_data)
+        mock_post.return_value = MagicMock(status_code=201)
+        save_instrument(str(INSTRUMENT_JSON), update_modification_date=False)
+        posted_json = mock_post.call_args[1]["json"]
+        self.assertEqual(posted_json["modification_date"], original_date)
+
     @patch("aind_metadata_mapper.utils.get_instrument")
     def test_check_existing_instrument(self, mock_get):
         """check_existing_instrument returns True when instrument exists."""