Move InstrumentType to ship_config.py

Author: VeckoTheGecko

src/virtualship/cli/_fetch.py

@@ -38,7 +38,7 @@ def _fetch(path: str | Path, username: str | None, password: str | None) -> None
     be provided on prompt, via command line arguments, or via a YAML config file. Run
     `virtualship fetch` on an expedition for more info.
     """
-    from virtualship.expedition.instrument_type import InstrumentType
+    from virtualship.expedition.ship_config import InstrumentType
 
     if sum([username is None, password is None]) == 1:
         raise ValueError("Both username and password must be provided when using CLI.")

src/virtualship/expedition/__init__.py

@@ -2,7 +2,6 @@
 
 from .do_expedition import do_expedition
 from .input_data import InputData
-from .instrument_type import InstrumentType
 from .schedule import Schedule
 from .ship_config import (
     ADCPConfig,

src/virtualship/expedition/checkpoint.py

@@ -7,8 +7,8 @@
 import pydantic
 import yaml
 
-from .instrument_type import InstrumentType
 from .schedule import Schedule
+from .ship_config import InstrumentType
 
 
 class _YamlDumper(yaml.SafeDumper):

src/virtualship/expedition/instrument_type.py

@@ -12,7 +12,7 @@
 from parcels import FieldSet
 
 from .input_data import InputData
-from .instrument_type import InstrumentType
+from .ship_config import InstrumentType
 from .space_time_region import SpaceTimeRegion
 from .waypoint import Waypoint
 

src/virtualship/expedition/schedule.py

@@ -3,15 +3,26 @@
 from __future__ import annotations
 
 from datetime import timedelta
+from enum import Enum
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import pydantic
 import yaml
 
 from virtualship.utils import _validate_numeric_mins_to_timedelta
 
-from .instrument_type import InstrumentType
-from .schedule import Schedule
+if TYPE_CHECKING:
+    from .schedule import Schedule
+
+
+class InstrumentType(Enum):
+    """Types of instruments."""
+
+    CTD = "CTD"
+    DRIFTER = "DRIFTER"
+    ARGO_FLOAT = "ARGO_FLOAT"
+    XBT = "XBT"
 
 
 class ArgoFloatConfig(pydantic.BaseModel):

src/virtualship/expedition/ship_config.py

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

src/virtualship/expedition/simulate_schedule.py

@@ -1,21 +1,23 @@
 """Waypoint class."""
 
+from __future__ import annotations
+
 from datetime import datetime
 
-from pydantic import BaseModel, field_serializer
+import pydantic
 
 from ..location import Location
-from .instrument_type import InstrumentType
+from .ship_config import InstrumentType
 
 
-class Waypoint(BaseModel):
+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
 
-    @field_serializer("instrument")
+    @pydantic.field_serializer("instrument")
     def serialize_instrument(self, instrument):
         """Ensure InstrumentType is serialized as a string (or list of strings)."""
         if isinstance(instrument, list):

src/virtualship/expedition/waypoint.py

@@ -139,8 +139,8 @@ 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.instrument_type import InstrumentType
     from virtualship.expedition.schedule import Schedule
+    from virtualship.expedition.ship_config import InstrumentType
     from virtualship.expedition.space_time_region import (
         SpaceTimeRegion,
         SpatialRange,

src/virtualship/utils.py

@@ -3,8 +3,8 @@
 import pandas as pd
 import pytest
 
-from virtualship.expedition.instrument_type import InstrumentType
 from virtualship.expedition.schedule import Schedule
+from virtualship.expedition.ship_config import InstrumentType
 from virtualship.utils import mfp_to_yaml