Update function names

Author: VeckoTheGecko

src/parcels/_datasets/remote.py

@@ -11,8 +11,6 @@
 
 from parcels._v3to4 import patch_dataset_v4_compat
 
-__all__ = ["list_datasets", "open_dataset"]
-
 # When modifying existing datasets in a backwards incompatible way,
 # make a new release in the repo and update the DATA_REPO_TAG to the new tag
 _DATA_REPO_TAG = "main"
@@ -220,7 +218,7 @@ class _Purpose(enum.Enum):
 # fmt: on
 
 
-def list_datasets(purpose: _TPurpose | Literal["any"] = "any") -> list[str]:
+def list_remote_datasets(purpose: _TPurpose | Literal["any"] = "any") -> list[str]:
     """List the available remote datasets.
 
     Use :func:`open_dataset` to download and open one of the datasets.
@@ -244,7 +242,7 @@ def list_datasets(purpose: _TPurpose | Literal["any"] = "any") -> list[str]:
     return [k for (k, (_, p)) in _DATASET_KEYS_AND_CONFIGS.items() if p == purpose_enum]
 
 
-def open_dataset(name: str, purpose: _TPurpose | Literal["any"] = "any"):
+def open_remote_dataset(name: str, purpose: _TPurpose | Literal["any"] = "any"):
     """Download and open a remote dataset as an :class:`xarray.Dataset`.
 
     Use :func:`list_datasets` to see the available dataset names.
@@ -267,7 +265,7 @@ def open_dataset(name: str, purpose: _TPurpose | Literal["any"] = "any"):
         dataset_config = _DATASET_KEYS_AND_CONFIGS[name][0]
     except KeyError as e:
         raise ValueError(
-            f"Dataset {name!r} not found. Available datasets are: " + ", ".join(list_datasets(purpose=purpose))
+            f"Dataset {name!r} not found. Available datasets are: " + ", ".join(list_remote_datasets(purpose=purpose))
         ) from e
 
     return dataset_config.open_dataset()

src/parcels/tutorial.py

@@ -1,5 +1,5 @@
-from parcels._datasets.remote import list_datasets as _remote_list_datasets
-from parcels._datasets.remote import open_dataset as _remote_open_dataset
+from parcels._datasets.remote import list_remote_datasets as _list_remote_datasets
+from parcels._datasets.remote import open_remote_dataset as _open_remote_dataset
 
 __all__ = ["list_datasets", "open_dataset"]
 
@@ -14,7 +14,7 @@ def list_datasets() -> list[str]:
     datasets : list of str
         The names of the available datasets matching the given purpose.
     """
-    return _remote_list_datasets(purpose="tutorial")
+    return _list_remote_datasets(purpose="tutorial")
 
 
 def open_dataset(name: str):
@@ -33,4 +33,4 @@ def open_dataset(name: str):
     xarray.Dataset
         The requested dataset.
     """
-    return _remote_open_dataset(name, purpose="tutorial")
+    return _open_remote_dataset(name, purpose="tutorial")

tests/datasets/test_remote.py

@@ -19,24 +19,24 @@ def test_pooch_registry_url_reponse(url):
 
 def test_open_dataset_non_existing():
     with pytest.raises(ValueError, match="Dataset.*not found"):
-        remote.open_dataset("non_existing_dataset")
+        remote.open_remote_dataset("non_existing_dataset")
 
 
-@pytest.mark.parametrize("name", remote.list_datasets())
+@pytest.mark.parametrize("name", remote.list_remote_datasets())
 def test_open_dataset(name):
-    ds = remote.open_dataset(name)
+    ds = remote.open_remote_dataset(name)
     assert isinstance(ds, xr.Dataset)
 
 
-@pytest.mark.parametrize("name", remote.list_datasets())
+@pytest.mark.parametrize("name", remote.list_remote_datasets())
 def test_dataset_keys(name):
     assert not name.endswith((".zarr", ".zip", ".nc")), "Dataset name should not have suffix"
 
 
 def test_list_datasets():
-    tutorial_datasets = set(remote.list_datasets("tutorial"))
-    testing_datasets = set(remote.list_datasets("testing"))
-    all_datasets = set(remote.list_datasets("any"))
+    tutorial_datasets = set(remote.list_remote_datasets("tutorial"))
+    testing_datasets = set(remote.list_remote_datasets("testing"))
+    all_datasets = set(remote.list_remote_datasets("any"))
     assert tutorial_datasets.issubset(all_datasets)
     assert testing_datasets.issubset(all_datasets)
     assert tutorial_datasets | testing_datasets == all_datasets