[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Author: pre-commit-ci[bot]

src/virtualship/cli/_fetch.py

@@ -8,7 +8,12 @@
 
 from pydantic import BaseModel
 
-from virtualship.utils import _dump_yaml, _generic_load_yaml, _get_schedule, _get_ship_config
+from virtualship.utils import (
+    _dump_yaml,
+    _generic_load_yaml,
+    _get_schedule,
+    _get_ship_config,
+)
 
 if TYPE_CHECKING:
     from virtualship.expedition.space_time_region import SpaceTimeRegion
@@ -18,7 +23,6 @@
 from copernicusmarine.core_functions.credentials_utils import InvalidUsernameOrPassword
 
 import virtualship.cli._creds as creds
-
 from virtualship.utils import SCHEDULE
 
 DOWNLOAD_METADATA = "download_metadata.yaml"
@@ -49,7 +53,7 @@ def _fetch(path: str | Path, username: str | None, password: str | None) -> None
         ship_config.ship_speed_knots,
         input_data=None,
         check_space_time_region=True,
-        ignore_missing_fieldsets=True
+        ignore_missing_fieldsets=True,
     )
 
     space_time_region_hash = get_space_time_region_hash(schedule.space_time_region)
@@ -80,7 +84,10 @@ def _fetch(path: str | Path, username: str | None, password: str | None) -> None
     shutil.copyfile(path / SCHEDULE, download_folder / SCHEDULE)
 
     if (
-        ({"XBT", "CTD", "SHIP_UNDERWATER_ST"} & set(instrument.name for instrument in instruments_in_schedule))
+        (
+            {"XBT", "CTD", "SHIP_UNDERWATER_ST"}
+            & set(instrument.name for instrument in instruments_in_schedule)
+        )
         or hasattr(ship_config, "ship_underwater_st_config")
         or hasattr(ship_config, "adcp_config")
     ):

src/virtualship/cli/commands.py

@@ -8,11 +8,8 @@
 from virtualship.utils import (
     SCHEDULE,
     SHIP_CONFIG,
-    _get_schedule,
-    _get_ship_config,
     mfp_to_yaml,
 )
-from virtualship.utils import SCHEDULE, SHIP_CONFIG, mfp_to_yaml
 
 
 @click.command()
@@ -96,7 +93,6 @@ 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 a expedition for more info.
     """
-
     _fetch(path, username, password)
 
 

tests/cli/test_cli.py

@@ -14,9 +14,7 @@ def copernicus_subset_no_download(monkeypatch):
     def fake_download(output_filename, output_directory, **_):
         Path(output_directory).joinpath(output_filename).touch()
 
-    monkeypatch.setattr(
-        "virtualship.cli._fetch.copernicusmarine.subset", fake_download
-    )
+    monkeypatch.setattr("virtualship.cli._fetch.copernicusmarine.subset", fake_download)
     yield
 
 

tests/cli/test_fetch.py

@@ -7,6 +7,7 @@
     DOWNLOAD_METADATA,
     DownloadMetadata,
     IncompleteDownloadError,
+    _fetch,
     assert_complete_download,
     complete_download,
     create_hash,
@@ -15,17 +16,9 @@
     hash_model,
     hash_to_filename,
 )
-
-
-from pathlib import Path
-
-import pytest
-
-from virtualship.cli._fetch import _fetch
-from virtualship.expedition.ship_config import ShipConfig
 from virtualship.expedition.schedule import Schedule
-from virtualship.utils import get_example_schedule, get_example_config
-
+from virtualship.expedition.ship_config import ShipConfig
+from virtualship.utils import get_example_config, get_example_schedule
 
 
 @pytest.fixture
@@ -35,9 +28,7 @@ def copernicus_subset_no_download(monkeypatch):
     def fake_download(output_filename, output_directory, **_):
         Path(output_directory).joinpath(output_filename).touch()
 
-    monkeypatch.setattr(
-        "virtualship.cli._fetch.copernicusmarine.subset", fake_download
-    )
+    monkeypatch.setattr("virtualship.cli._fetch.copernicusmarine.subset", fake_download)
     yield
 
 

tests/expedition/test_schedule.py

@@ -7,9 +7,8 @@
 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.utils import _get_ship_config
-from virtualship.expedition.schedule import ScheduleError, Schedule
-
 
 projection = pyproj.Geod(ellps="WGS84")
 
@@ -56,81 +55,107 @@ def test_get_instruments() -> None:
         waypoints=[
             Waypoint(location=Location(0, 0), instrument=["CTD"]),
             Waypoint(location=Location(1, 0), instrument=["XBT", "ARGO_FLOAT"]),
-            Waypoint(location=Location(1, 0), instrument=["CTD"])
+            Waypoint(location=Location(1, 0), instrument=["CTD"]),
         ]
     )
 
-    assert set(instrument.name for instrument in schedule.get_instruments()) == {"CTD", "XBT", "ARGO_FLOAT"}
+    assert set(instrument.name for instrument in schedule.get_instruments()) == {
+        "CTD",
+        "XBT",
+        "ARGO_FLOAT",
+    }
 
 
 @pytest.mark.parametrize(
     "schedule,check_space_time_region,error,match",
     [
         pytest.param(
-            Schedule(
-                waypoints=[]
-            ),
+            Schedule(waypoints=[]),
             False,
             ScheduleError,
             "At least one waypoint must be provided.",
-            id="NoWaypoints"
+            id="NoWaypoints",
         ),
         pytest.param(
             Schedule(
                 waypoints=[
                     Waypoint(location=Location(0, 0)),
-                    Waypoint(location=Location(1, 0), time=datetime(2022, 1, 1, 1, 0, 0)),
+                    Waypoint(
+                        location=Location(1, 0), time=datetime(2022, 1, 1, 1, 0, 0)
+                    ),
                 ]
             ),
             False,
             ScheduleError,
             "First waypoint must have a specified time.",
-            id="FirstWaypointHasTime"
+            id="FirstWaypointHasTime",
         ),
         pytest.param(
             Schedule(
                 waypoints=[
-                    Waypoint(location=Location(0, 0), time=datetime(2022, 1, 2, 1, 0, 0)),
+                    Waypoint(
+                        location=Location(0, 0), time=datetime(2022, 1, 2, 1, 0, 0)
+                    ),
                     Waypoint(location=Location(0, 0)),
-                    Waypoint(location=Location(1, 0), time=datetime(2022, 1, 1, 1, 0, 0)),
+                    Waypoint(
+                        location=Location(1, 0), time=datetime(2022, 1, 1, 1, 0, 0)
+                    ),
                 ]
             ),
             False,
             ScheduleError,
             "Each waypoint should be timed after all previous waypoints",
-            id="SequentialWaypoints"
+            id="SequentialWaypoints",
         ),
         pytest.param(
             Schedule(
                 waypoints=[
-                    Waypoint(location=Location(0, 0), time=datetime(2022, 1, 1, 1, 0, 0)),
-                    Waypoint(location=Location(1, 0), time=datetime(2022, 1, 1, 1, 1, 0)),
+                    Waypoint(
+                        location=Location(0, 0), time=datetime(2022, 1, 1, 1, 0, 0)
+                    ),
+                    Waypoint(
+                        location=Location(1, 0), time=datetime(2022, 1, 1, 1, 1, 0)
+                    ),
                 ]
             ),
             False,
             ScheduleError,
             "Waypoint planning is not valid: would arrive too late at waypoint number 2...",
-            id="NotEnoughTime"
+            id="NotEnoughTime",
         ),
         pytest.param(
             Schedule(
                 waypoints=[
-                    Waypoint(location=Location(0, 0), time=datetime(2022, 1, 1, 1, 0, 0)),
-                    Waypoint(location=Location(1, 0), time=datetime(2022, 1, 2, 1, 1, 0)),
+                    Waypoint(
+                        location=Location(0, 0), time=datetime(2022, 1, 1, 1, 0, 0)
+                    ),
+                    Waypoint(
+                        location=Location(1, 0), time=datetime(2022, 1, 2, 1, 1, 0)
+                    ),
                 ]
             ),
             True,
             ScheduleError,
             "space_time_region not found in schedule, please define it to fetch the data.",
-            id="NoSpaceTimeRegion"
+            id="NoSpaceTimeRegion",
         ),
-    ]
+    ],
 )
-def test_verify_schedule_errors(schedule: Schedule, check_space_time_region: bool, error, match) -> None:
-
+def test_verify_schedule_errors(
+    schedule: Schedule, check_space_time_region: bool, error, match
+) -> None:
     ship_config = _get_ship_config(expedition_dir)
 
-    input_data = _load_input_data(expedition_dir, schedule, ship_config, input_data=Path("expedition_dir/input_data"))
+    input_data = _load_input_data(
+        expedition_dir,
+        schedule,
+        ship_config,
+        input_data=Path("expedition_dir/input_data"),
+    )
 
     with pytest.raises(error, match=match):
-        schedule.verify(ship_config.ship_speed_knots, input_data, check_space_time_region=check_space_time_region)
+        schedule.verify(
+            ship_config.ship_speed_knots,
+            input_data,
+            check_space_time_region=check_space_time_region,
+        )

tests/expedition/test_ship_config.py

@@ -4,10 +4,8 @@
 
 from virtualship.expedition.schedule import Schedule
 from virtualship.expedition.ship_config import ConfigError, ShipConfig
-
 from virtualship.utils import get_example_config, get_example_schedule
 
-
 expedition_dir = Path("expedition_dir")
 
 
@@ -21,8 +19,14 @@ def schedule(tmp_file):
 @pytest.fixture
 def schedule_no_xbt(schedule):
     for waypoint in schedule.waypoints:
-        if waypoint.instrument and any(instrument.name == "XBT" for instrument in waypoint.instrument):
-            waypoint.instrument = [instrument for instrument in waypoint.instrument if instrument.name != 'XBT']
+        if waypoint.instrument and any(
+            instrument.name == "XBT" for instrument in waypoint.instrument
+        ):
+            waypoint.instrument = [
+                instrument
+                for instrument in waypoint.instrument
+                if instrument.name != "XBT"
+            ]
 
     return schedule
 
@@ -36,25 +40,25 @@ def ship_config(tmp_file):
 
 @pytest.fixture
 def ship_config_no_xbt(ship_config):
-    delattr(ship_config, 'xbt_config')
+    delattr(ship_config, "xbt_config")
     return ship_config
 
 
 @pytest.fixture
 def ship_config_no_ctd(ship_config):
-    delattr(ship_config, 'ctd_config')
+    delattr(ship_config, "ctd_config")
     return ship_config
 
 
 @pytest.fixture
 def ship_config_no_argo_float(ship_config):
-    delattr(ship_config, 'argo_float_config')
+    delattr(ship_config, "argo_float_config")
     return ship_config
 
 
 @pytest.fixture
 def ship_config_no_drifter(ship_config):
-    delattr(ship_config, 'drifter_config')
+    delattr(ship_config, "drifter_config")
     return ship_config
 
 
@@ -65,12 +69,10 @@ def test_import_export_ship_config(ship_config, tmp_file) -> None:
 
 
 def test_verify_ship_config(ship_config, schedule) -> None:
-
     ship_config.verify(schedule)
 
 
 def test_verify_ship_config_no_instrument(ship_config, schedule_no_xbt) -> None:
-
     ship_config.verify(schedule_no_xbt)
 
 
@@ -81,29 +83,31 @@ def test_verify_ship_config_no_instrument(ship_config, schedule_no_xbt) -> None:
             "ship_config_no_xbt",
             ConfigError,
             "Planning has a waypoint with XBT instrument, but configuration does not configure XBT.",
-            id="ShipConfigNoXBT"
+            id="ShipConfigNoXBT",
         ),
         pytest.param(
             "ship_config_no_ctd",
             ConfigError,
             "Planning has a waypoint with CTD instrument, but configuration does not configure CTD.",
-            id="ShipConfigNoCTD"
+            id="ShipConfigNoCTD",
         ),
         pytest.param(
             "ship_config_no_argo_float",
             ConfigError,
             "Planning has a waypoint with Argo float instrument, but configuration does not configure Argo floats.",
-            id="ShipConfigNoARGO_FLOAT"
+            id="ShipConfigNoARGO_FLOAT",
         ),
         pytest.param(
             "ship_config_no_drifter",
             ConfigError,
             "Planning has a waypoint with drifter instrument, but configuration does not configure drifters.",
-            id="ShipConfigNoDRIFTER"
+            id="ShipConfigNoDRIFTER",
         ),
-    ]
+    ],
 )
-def test_verify_ship_config_errors(request, schedule, ship_config_fixture, error, match) -> None:
+def test_verify_ship_config_errors(
+    request, schedule, ship_config_fixture, error, match
+) -> None:
     ship_config = request.getfixturevalue(ship_config_fixture)
 
     with pytest.raises(error, match=match):