Move configuration objects to virtualship.models (#189)

* Move location.py and spacetime.py to models

* Move ship_config to models

* Move schedule to models

* Move space_time_region to models

* Move errors to separate file

* Run hooks

* Update reference to ConfigError

* Add tidy-imports ruff rule

* Add models.__init__

* Update imports to models subpackage

* Update imports of errors

* cleanup virtualship/expedition/__init__.py

* cleanup virtualship/__init__.py

Author: VeckoTheGecko

docs/user-guide/tutorials/Drifter_data_tutorial.ipynb

@@ -17,7 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from virtualship import Location, Spacetime\n",
+    "from virtualship.models import Location, Spacetime\n",
     "from virtualship.instruments.drifter import Drifter, simulate_drifters\n",
     "from virtualship.expedition.input_data import InputData\n",
     "from pathlib import Path\n",

pyproject.toml

@@ -95,6 +95,7 @@ select = [
     "ICN", # import conventions
     "RUF", # ruff
     "ISC001", # single-line-implicit-string-concatenation
+    "TID", # flake8-tidy-imports
 ]
 ignore = [
     # line too long (82 > 79 characters)

src/virtualship/__init__.py

@@ -2,17 +2,12 @@
 
 from importlib.metadata import version as _version
 
-from .location import Location
-from .spacetime import Spacetime
-
 try:
     __version__ = _version("virtualship")
 except Exception:
     # Local copy or not installed with setuptools
     __version__ = "unknown"
 
 __all__ = [
-    "Location",
-    "Spacetime",
     "__version__",
 ]

src/virtualship/cli/_creds.py

@@ -6,13 +6,9 @@
 import pydantic
 import yaml
 
-CREDENTIALS_FILE = "credentials.yaml"
-
+from virtualship.errors import CredentialFileError
 
-class CredentialFileError(Exception):
-    """Exception raised for errors in the input file format."""
-
-    pass
+CREDENTIALS_FILE = "credentials.yaml"
 
 
 class Credentials(pydantic.BaseModel):

src/virtualship/cli/_fetch.py

@@ -8,6 +8,7 @@
 
 from pydantic import BaseModel
 
+from virtualship.errors import IncompleteDownloadError
 from virtualship.utils import (
     _dump_yaml,
     _generic_load_yaml,
@@ -16,7 +17,7 @@
 )
 
 if TYPE_CHECKING:
-    from virtualship.expedition.space_time_region import SpaceTimeRegion
+    from virtualship.models import SpaceTimeRegion
 
 import click
 import copernicusmarine
@@ -38,7 +39,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.ship_config import InstrumentType
+    from virtualship.models import InstrumentType
 
     if sum([username is None, password is None]) == 1:
         raise ValueError("Both username and password must be provided when using CLI.")
@@ -329,12 +330,6 @@ def hash_to_filename(hash: str) -> str:
     return f"{datetime.now().strftime('%Y%m%d_%H%M%S')}_{hash}"
 
 
-class IncompleteDownloadError(Exception):
-    """Exception raised for incomplete downloads."""
-
-    pass
-
-
 class DownloadMetadata(BaseModel):
     """Metadata for a data download."""
 

src/virtualship/errors.py

@@ -0,0 +1,28 @@
+class CredentialFileError(Exception):
+    """Exception raised for errors in the input file format."""
+
+    pass
+
+
+class IncompleteDownloadError(Exception):
+    """Exception raised for incomplete downloads."""
+
+    pass
+
+
+class CheckpointError(RuntimeError):
+    """An error in the checkpoint."""
+
+    pass
+
+
+class ScheduleError(RuntimeError):
+    """An error in the schedule."""
+
+    pass
+
+
+class ConfigError(RuntimeError):
+    """An error in the config."""
+
+    pass

src/virtualship/expedition/__init__.py

@@ -2,31 +2,8 @@
 
 from .do_expedition import do_expedition
 from .input_data import InputData
-from .schedule import Schedule, Waypoint
-from .ship_config import (
-    ADCPConfig,
-    ArgoFloatConfig,
-    CTD_BGCConfig,
-    CTDConfig,
-    DrifterConfig,
-    ShipConfig,
-    ShipUnderwaterSTConfig,
-)
-from .space_time_region import SpaceTimeRegion
 
 __all__ = [
-    "ADCPConfig",
-    "ArgoFloatConfig",
-    "CTDConfig",
-    "CTD_BGCConfig",
-    "DrifterConfig",
     "InputData",
-    "InstrumentType",
-    "Schedule",
-    "ShipConfig",
-    "ShipUnderwaterSTConfig",
-    "SpaceTimeRegion",
-    "Waypoint",
     "do_expedition",
-    "instruments",
 ]

src/virtualship/expedition/checkpoint.py

@@ -7,8 +7,8 @@
 import pydantic
 import yaml
 
-from .schedule import Schedule
-from .ship_config import InstrumentType
+from virtualship.errors import CheckpointError
+from virtualship.models import InstrumentType, Schedule
 
 
 class _YamlDumper(yaml.SafeDumper):
@@ -71,9 +71,3 @@ def verify(self, schedule: Schedule) -> None:
             raise CheckpointError(
                 "Past waypoints in schedule have been changed! Restore past schedule and only change future waypoints."
             )
-
-
-class CheckpointError(RuntimeError):
-    """An error in the checkpoint."""
-
-    pass

src/virtualship/expedition/do_expedition.py

@@ -7,6 +7,7 @@
 import pyproj
 
 from virtualship.cli._fetch import get_existing_download, get_space_time_region_hash
+from virtualship.models import Schedule, ShipConfig
 from virtualship.utils import (
     CHECKPOINT,
     _get_schedule,
@@ -16,8 +17,6 @@
 from .checkpoint import Checkpoint
 from .expedition_cost import expedition_cost
 from .input_data import InputData
-from .schedule import Schedule
-from .ship_config import ShipConfig
 from .simulate_measurements import simulate_measurements
 from .simulate_schedule import ScheduleProblem, simulate_schedule
 

src/virtualship/expedition/simulate_measurements.py

@@ -6,14 +6,15 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from ..instruments.adcp import simulate_adcp
-from ..instruments.argo_float import simulate_argo_floats
-from ..instruments.ctd import simulate_ctd
-from ..instruments.ctd_bgc import simulate_ctd_bgc
-from ..instruments.drifter import simulate_drifters
-from ..instruments.ship_underwater_st import simulate_ship_underwater_st
-from ..instruments.xbt import simulate_xbt
-from .ship_config import ShipConfig
+from virtualship.instruments.adcp import simulate_adcp
+from virtualship.instruments.argo_float import simulate_argo_floats
+from virtualship.instruments.ctd import simulate_ctd
+from virtualship.instruments.ctd_bgc import simulate_ctd_bgc
+from virtualship.instruments.drifter import simulate_drifters
+from virtualship.instruments.ship_underwater_st import simulate_ship_underwater_st
+from virtualship.instruments.xbt import simulate_xbt
+from virtualship.models import ShipConfig
+
 from .simulate_schedule import MeasurementsToSimulate
 
 if TYPE_CHECKING: