API: Ensure mas/pot3d/quantities fetchers return argument ordered filepaths

Author: ryder-davidson

psi_data/_static_assets.py

@@ -209,14 +209,14 @@ def fetch_mas_data(*, domains: Optional[Iterable] = 'cor',
     PosixPath('.../cor/mhd/br002.h5')
     """
     if domains is None:
-        domains = {"cor", "hel"}
+        domains = ("cor", "hel")
     else:
-        domains = set(domains.replace(" ", "").lower().split(",") if isinstance(domains, str) else domains)
+        domains = tuple(domains.replace(" ", "").lower().split(",") if isinstance(domains, str) else domains)
 
     if variables is None:
         variables = set.intersection(*(DOM_VAR_MAP[dom] for dom in domains))
     else:
-        variables = set(variables.replace(" ", "").lower().split(",") if isinstance(variables, str) else variables)
+        variables = tuple(variables.replace(" ", "").lower().split(",") if isinstance(variables, str) else variables)
     req_pairs = product(domains, variables)
 
     ext = HDF_EXT.get(hdf)
@@ -275,7 +275,7 @@ def fetch_mas_quantities(*, quantities: Optional[Iterable] = 'ch_pm', hdf: int =
     if quantities is None:
         quantities = DOM_VAR_MAP["quantities"]
     else:
-        quantities = set(quantities.replace(" ", "").lower().split(",") if isinstance(quantities, str) else quantities)
+        quantities = tuple(quantities.replace(" ", "").lower().split(",") if isinstance(quantities, str) else quantities)
 
     ext = HDF_EXT.get(hdf)
     filepaths = {
@@ -333,7 +333,7 @@ def fetch_pot3d_data(*, variables: Optional[Iterable] = 'br', hdf: int = 5) -> o
     if variables is None:
         variables = DOM_VAR_MAP["pot3d"]
     else:
-        variables = set(variables.replace(" ", "").lower().split(",") if isinstance(variables, str) else variables)
+        variables = tuple(variables.replace(" ", "").lower().split(",") if isinstance(variables, str) else variables)
 
     ext = HDF_EXT.get(hdf)
     filepaths = {

tests/test_static_assets.py

@@ -106,6 +106,23 @@ def test_fetch_mas_data_keys_exist_in_registry(fake_fetch):
         assert key in sa.FETCHER.registry, f"{key} not in registry"
 
 
+def test_fetch_mas_returns_ordered_namedtuple(fake_fetch):
+    paths = sa.fetch_mas_data(domains="cor", variables="br,bt,bp", hdf=5)
+    assert paths._fields == ("cor_br", "cor_bt", "cor_bp")
+    assert paths[0] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/mhd/br002.h5")
+    assert paths[1] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/mhd/bt002.h5")
+    assert paths[2] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/mhd/bp002.h5")
+
+
+def test_fetch_mas_returns_ordered_namedtuple_with_multiple_domains(fake_fetch):
+    paths = sa.fetch_mas_data(domains="cor,hel", variables="br,bt", hdf=5)
+    assert paths._fields == ("cor_br", "cor_bt", "hel_br", "hel_bt")
+    assert paths[0] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/mhd/br002.h5")
+    assert paths[1] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/mhd/bt002.h5")
+    assert paths[2] == Path("H5CR2309_hmi_mast_mas_std_0201/hel/mhd/br002.h5")
+    assert paths[3] == Path("H5CR2309_hmi_mast_mas_std_0201/hel/mhd/bt002.h5")
+
+
 # --- fetch_pot3d_data --------------------------------------------------------
 
 def test_fetch_pot3d_data_default(fake_fetch):
@@ -119,6 +136,14 @@ def test_fetch_pot3d_data_none_fetches_all_components(fake_fetch):
     assert set(paths._fields) == {"br", "bt", "bp"}
 
 
+def test_fetch_pot3d_returns_ordered_namedtuple(fake_fetch):
+    paths = sa.fetch_pot3d_data(variables="br,bt,bp", hdf=5)
+    assert paths._fields == ("br", "bt", "bp")
+    assert paths[0] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/pfss/br.h5")
+    assert paths[1] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/pfss/bt.h5")
+    assert paths[2] == Path("H5CR2309_hmi_mast_mas_std_0201/cor/pfss/bp.h5")
+
+
 # --- fetch_mas_quantities ----------------------------------------------------
 
 def test_fetch_mas_quantities_default(fake_fetch):