Move Waypoint to schedule.py

Author: VeckoTheGecko

src/virtualship/expedition/__init__.py

@@ -2,7 +2,7 @@
 
 from .do_expedition import do_expedition
 from .input_data import InputData
-from .schedule import Schedule
+from .schedule import Schedule, Waypoint
 from .ship_config import (
     ADCPConfig,
     ArgoFloatConfig,
@@ -12,7 +12,6 @@
     ShipUnderwaterSTConfig,
 )
 from .space_time_region import SpaceTimeRegion
-from .waypoint import Waypoint
 
 __all__ = [
     "ADCPConfig",

src/virtualship/expedition/schedule.py

@@ -3,22 +3,37 @@
 from __future__ import annotations
 
 import itertools
-from datetime import timedelta
+from datetime import datetime, timedelta
 from pathlib import Path
 
 import pydantic
 import pyproj
 import yaml
 from parcels import FieldSet
 
+from ..location import Location
 from .input_data import InputData
 from .ship_config import InstrumentType
 from .space_time_region import SpaceTimeRegion
-from .waypoint import Waypoint
 
 projection: pyproj.Geod = pyproj.Geod(ellps="WGS84")
 
 
+class Waypoint(pydantic.BaseModel):
+    """A Waypoint to sail to with an optional time and an optional instrument."""
+
+    location: Location
+    time: datetime | None = None
+    instrument: InstrumentType | list[InstrumentType] | None = None
+
+    @pydantic.field_serializer("instrument")
+    def serialize_instrument(self, instrument):
+        """Ensure InstrumentType is serialized as a string (or list of strings)."""
+        if isinstance(instrument, list):
+            return [inst.value for inst in instrument]
+        return instrument.value if instrument else None
+
+
 class Schedule(pydantic.BaseModel):
     """Schedule of the virtual ship."""
 

src/virtualship/expedition/simulate_schedule.py

@@ -13,9 +13,8 @@
 from ..instruments.xbt import XBT
 from ..location import Location
 from ..spacetime import Spacetime
-from .schedule import Schedule
+from .schedule import Schedule, Waypoint
 from .ship_config import InstrumentType, ShipConfig
-from .waypoint import Waypoint
 
 
 @dataclass

src/virtualship/expedition/waypoint.py

@@ -139,14 +139,13 @@ def mfp_to_yaml(coordinates_file_path: str, yaml_output_path: str):  # noqa: D41
 
     """
     # Importing Schedule and related models from expedition module
-    from virtualship.expedition.schedule import Schedule
+    from virtualship.expedition.schedule import Location, Schedule, Waypoint
     from virtualship.expedition.ship_config import InstrumentType
     from virtualship.expedition.space_time_region import (
         SpaceTimeRegion,
         SpatialRange,
         TimeRange,
     )
-    from virtualship.expedition.waypoint import Location, Waypoint
 
     # Read data from file
     coordinates_data = load_coordinates(coordinates_file_path)

src/virtualship/utils.py

@@ -5,9 +5,8 @@
 import pytest
 
 from virtualship import Location
-from virtualship.expedition import Waypoint
 from virtualship.expedition.do_expedition import _load_input_data
-from virtualship.expedition.schedule import Schedule, ScheduleError
+from virtualship.expedition.schedule import Schedule, ScheduleError, Waypoint
 from virtualship.utils import _get_ship_config
 
 projection = pyproj.Geod(ellps="WGS84")