🐛 Ensure validator runs on defaults for timestamp

Author: kzscisoft

simvue/api/objects/events.py

@@ -14,10 +14,9 @@
 import pydantic
 
 from simvue.api.url import URL
-from simvue.utilities import simvue_timestamp
 
 from .base import SimvueObject
-from simvue.models import EventSet
+from simvue.models import EventSet, simvue_timestamp
 from simvue.api.request import get as sv_get, get_json_from_response
 
 try:

simvue/api/objects/run.py

@@ -14,7 +14,7 @@
 import datetime
 import json
 
-from simvue.utilities import simvue_timestamp
+from simvue.models import simvue_timestamp
 
 try:
     from typing import Self
@@ -471,7 +471,9 @@ def runtime(self) -> datetime.datetime | None:
         """Retrieve execution time for the run"""
         _runtime: str | None = self._get_attribute("runtime")
         return (
-            _runtime.strptime(_runtime, "%H:%M:%S.%f").astimezone(datetime.timezone.utc)
+            datetime.datetime.strptime(_runtime, "%H:%M:%S.%f").astimezone(
+                datetime.timezone.utc
+            )
             if _runtime
             else None
         )

simvue/metadata.py

@@ -16,7 +16,7 @@
 import logging
 import pathlib
 
-from simvue.utilities import simvue_timestamp
+from simvue.models import simvue_timestamp
 
 logger = logging.getLogger(__file__)
 

simvue/models.py

@@ -18,6 +18,51 @@
 ]
 
 
+def validate_timestamp(timestamp: str, raise_except: bool = True) -> bool:
+    """
+    Validate a user-provided timestamp
+    """
+    try:
+        _ = datetime.datetime.strptime(timestamp, DATETIME_FORMAT)
+    except ValueError as e:
+        if raise_except:
+            raise e
+        return False
+
+    return True
+
+
+@pydantic.validate_call(config=pydantic.ConfigDict(validate_default=True))
+def simvue_timestamp(
+    date_time: datetime.datetime
+    | typing.Annotated[str, validate_timestamp]
+    | None = None,
+) -> str:
+    """Return the Simvue valid timestamp
+
+    Parameters
+    ----------
+    date_time: datetime.datetime | str, optional
+        if provided, the datetime object to convert, else use current date and time
+
+    Returns
+    -------
+    str
+        Datetime string valid for the Simvue server
+    """
+    if not date_time:
+        date_time = datetime.datetime.now(datetime.timezone.utc)
+    elif isinstance(date_time, str):
+        # If the user specifies the 'naive' datetime string expected by the server
+        # it is assumed that this is in their local timezone
+        _local_timezone = datetime.datetime.now().astimezone().tzinfo
+        date_time = datetime.datetime.strptime(date_time, DATETIME_FORMAT).replace(
+            tzinfo=_local_timezone
+        )
+    _utc_datetime = date_time.astimezone(datetime.timezone.utc)
+    return _utc_datetime.strftime(DATETIME_FORMAT)
+
+
 # Pydantic class to validate run.init()
 class RunInput(pydantic.BaseModel):
     model_config = pydantic.ConfigDict(extra="forbid")
@@ -33,42 +78,20 @@ class RunInput(pydantic.BaseModel):
 class MetricSet(pydantic.BaseModel):
     model_config = pydantic.ConfigDict(extra="forbid")
     time: pydantic.NonNegativeFloat | pydantic.NonNegativeInt
-    timestamp: str
+    timestamp: typing.Annotated[str, validate_timestamp]
     step: pydantic.NonNegativeInt
     values: dict[str, int | float | bool]
 
-    @pydantic.field_validator("timestamp", mode="after")
-    @classmethod
-    def timestamp_str(cls, value: str) -> str:
-        try:
-            _ = datetime.datetime.strptime(value, DATETIME_FORMAT)
-        except ValueError as e:
-            raise AssertionError(
-                f"Invalid timestamp, expected form '{DATETIME_FORMAT}'"
-            ) from e
-        return value
-
 
 class GridMetricSet(pydantic.BaseModel):
     model_config = pydantic.ConfigDict(arbitrary_types_allowed=True, extra="forbid")
     time: pydantic.NonNegativeFloat | pydantic.NonNegativeInt
-    timestamp: str
+    timestamp: typing.Annotated[str, validate_timestamp]
     step: pydantic.NonNegativeInt
     array: list | numpy.ndarray
     grid: str
     metric: str
 
-    @pydantic.field_validator("timestamp", mode="after")
-    @classmethod
-    def timestamp_str(cls, value: str) -> str:
-        try:
-            _ = datetime.datetime.strptime(value, DATETIME_FORMAT)
-        except ValueError as e:
-            raise AssertionError(
-                f"Invalid timestamp, expected form '{DATETIME_FORMAT}'"
-            ) from e
-        return value
-
     @pydantic.field_serializer("array", when_used="always")
     def serialize_array(self, value: numpy.ndarray | list, *_) -> list:
         if isinstance(value, list):
@@ -79,15 +102,4 @@ def serialize_array(self, value: numpy.ndarray | list, *_) -> list:
 class EventSet(pydantic.BaseModel):
     model_config = pydantic.ConfigDict(extra="forbid")
     message: str
-    timestamp: str
-
-    @pydantic.field_validator("timestamp", mode="after")
-    @classmethod
-    def timestamp_str(cls, value: str) -> str:
-        try:
-            _ = datetime.datetime.strptime(value, DATETIME_FORMAT)
-        except ValueError as e:
-            raise AssertionError(
-                f"Invalid timestamp, expected form '{DATETIME_FORMAT}'"
-            ) from e
-        return value
+    timestamp: typing.Annotated[str | None, simvue_timestamp]

simvue/run.py

@@ -41,14 +41,13 @@
 from .factory.dispatch import Dispatcher
 from .executor import Executor, get_current_shell
 from .metrics import SystemResourceMeasurement
-from .models import FOLDER_REGEX, NAME_REGEX, MetricKeyString
+from .models import simvue_timestamp, FOLDER_REGEX, NAME_REGEX, MetricKeyString
 from .system import get_system
 from .metadata import git_info, environment
 from .eco import CO2Monitor
 from .utilities import (
     skip_if_failed,
     validate_timestamp,
-    simvue_timestamp,
 )
 from .api.objects import (
     Run as RunObject,
@@ -281,11 +280,6 @@ def duration(self) -> float:
         """Return current run duration"""
         return time.time() - self._start_time
 
-    @property
-    def time_stamp(self) -> str:
-        """Return current timestamp"""
-        return simvue_timestamp()
-
     @property
     def processes(self) -> list[psutil.Process]:
         """Create an array containing a list of processes"""
@@ -1256,22 +1250,30 @@ def update_tags(self, tags: list[str]) -> bool:
 
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @check_run_initialised
-    @pydantic.validate_call
-    def log_event(self, message: str, timestamp: str | None = None) -> bool:
+    @pydantic.validate_call(config=pydantic.ConfigDict(validate_default=True))
+    def log_event(
+        self,
+        message: str,
+        timestamp: typing.Annotated[
+            str | None, pydantic.BeforeValidator(simvue_timestamp)
+        ] = None,
+    ) -> bool:
         """Log event to the server
 
         Parameters
         ----------
         message : str
             event message to log
         timestamp : str, optional
-            manually specify the time stamp for this log, by default None
+            manually specify the Simvue time stamp for this log, by default None
 
         Returns
         -------
         bool
             whether event log was successful
         """
+        if not timestamp:
+            raise Exception
         if self._aborted:
             return False
 
@@ -1287,22 +1289,24 @@ def log_event(self, message: str, timestamp: str | None = None) -> bool:
             self._error("Cannot log events when not in the running state")
             return False
 
-        if timestamp and not validate_timestamp(timestamp):
-            self._error("Invalid timestamp format")
-            return False
-
-        _data = {"message": message, "timestamp": timestamp or self.time_stamp}
+        _data = {
+            "message": message,
+            "timestamp": timestamp,
+        }
         self._dispatcher.add_item(_data, "events", self._queue_blocking)
 
         return True
 
+    @pydantic.validate_call(config=pydantic.ConfigDict(validate_default=True))
     def _add_metrics_to_dispatch(
         self,
         metrics: dict[str, int | float],
         *,
         step: int | None = None,
         time: float | None = None,
-        timestamp: str | None = None,
+        timestamp: typing.Annotated[
+            str | None, pydantic.BeforeValidator(simvue_timestamp)
+        ] = None,
         join_on_fail: bool = True,
     ) -> bool:
         if self._user_config.run.mode == "disabled":
@@ -1326,34 +1330,37 @@ def _add_metrics_to_dispatch(
             )
             return False
 
-        if timestamp and not validate_timestamp(timestamp):
+        if timestamp and not validate_timestamp(timestamp, raise_except=False):
             self._error("Invalid timestamp format", join_on_fail)
             return False
 
         _data: dict[str, typing.Any] = {
             "values": metrics,
             "time": time if time is not None else self.duration,
-            "timestamp": timestamp if timestamp is not None else self.time_stamp,
+            "timestamp": timestamp,
             "step": step if step is not None else self._step,
         }
         self._dispatcher.add_item(_data, "metrics_regular", self._queue_blocking)
 
         return True
 
+    @pydantic.validate_call(config=pydantic.ConfigDict(validate_default=True))
     def _add_tensors_to_dispatch(
         self,
         tensors: dict[str, int | float],
         *,
         step: int | None = None,
         time: float | None = None,
-        timestamp: str | None = None,
+        timestamp: typing.Annotated[
+            str | None, pydantic.BeforeValidator(simvue_timestamp)
+        ] = None,
         join_on_fail: bool = True,
     ) -> bool:
         for tensor, array in tensors.items():
             _data: dict[str, typing.Any] = {
                 "array": array,
                 "time": time if time is not None else self.duration,
-                "timestamp": timestamp if timestamp is not None else self.time_stamp,
+                "timestamp": timestamp,
                 "step": step if step is not None else self._step,
                 "grid": self._grids[tensor]["id"],
                 "metric": tensor,
@@ -1389,7 +1396,7 @@ def _add_values_to_dispatch(
             )
             return False
 
-        if timestamp and not validate_timestamp(timestamp):
+        if timestamp and not validate_timestamp(timestamp, raise_except=False):
             self._error("Invalid timestamp format", join_on_fail)
             return False
 
@@ -1549,7 +1556,7 @@ def log_metrics(
             )
             return False
 
-        if timestamp and not validate_timestamp(timestamp):
+        if timestamp and not validate_timestamp(timestamp, raise_except=False):
             self._error("Invalid timestamp format", timestamp)
             return False
 

simvue/utilities.py

@@ -1,4 +1,3 @@
-import datetime
 import hashlib
 import logging
 import json
@@ -14,9 +13,6 @@
 import jwt
 from deepmerge import Merger
 
-from datetime import timezone
-from simvue.models import DATETIME_FORMAT
-
 
 CHECKSUM_BLOCK_SIZE = 4096
 EXTRAS: tuple[str, ...] = ("plot", "torch")
@@ -120,7 +116,7 @@ def parse_validation_response(
                     input_arg = None if obj_type == "missing" else input_arg[loc]
                 except TypeError:
                     break
-            information.append(input_arg)
+            information.append(str(input_arg))
 
         # Limit message to be 60 characters
         msg: str = issue["msg"][:60]
@@ -372,37 +368,6 @@ def calculate_sha256(filename: str | typing.Any, is_file: bool) -> str | None:
     return sha256_hash.hexdigest()
 
 
-def validate_timestamp(timestamp):
-    """
-    Validate a user-provided timestamp
-    """
-    try:
-        _ = datetime.datetime.strptime(timestamp, DATETIME_FORMAT)
-    except ValueError:
-        return False
-
-    return True
-
-
-def simvue_timestamp(date_time: datetime.datetime | None = None) -> str:
-    """Return the Simvue valid timestamp
-
-    Parameters
-    ----------
-    date_time: datetime.datetime, optional
-        if provided, the datetime object to convert, else use current date and time
-
-    Returns
-    -------
-    str
-        Datetime string valid for the Simvue server
-    """
-    if not date_time:
-        date_time = datetime.datetime.now(timezone.utc)
-    _utc_datetime = date_time.astimezone(datetime.timezone.utc)
-    return _utc_datetime.strftime(DATETIME_FORMAT)
-
-
 @functools.lru_cache
 def get_mimetypes() -> list[str]:
     """Returns a list of allowed MIME types"""

tests/functional/test_run_class.py

@@ -30,7 +30,7 @@
 import simvue.config.user as sv_cfg
 
 from simvue.api.objects import Run as RunObject
-from simvue.utilities import simvue_timestamp
+from simvue.models import simvue_timestamp
 
 if typing.TYPE_CHECKING:
     from .conftest import CountingLogHandler

tests/unit/test_events.py

@@ -8,7 +8,7 @@
 from simvue.api.objects import Events, Folder, Run
 from simvue.models import DATETIME_FORMAT
 from simvue.sender import sender
-from simvue.utilities import simvue_timestamp
+from simvue.models import simvue_timestamp
 
 @pytest.mark.api
 @pytest.mark.online

tests/unit/test_grids.py

@@ -14,7 +14,7 @@
 from simvue.run import Run as sv_Run
 from simvue.sender import sender
 from simvue.client import Client
-from simvue.utilities import simvue_timestamp
+from simvue.models import simvue_timestamp
 
 @pytest.mark.api
 @pytest.mark.online