@bisgaard-itis review: tuples

Author: pcrespov

services/api-server/src/simcore_service_api_server/models/api_resources.py

@@ -53,26 +53,31 @@ def compose_resource_name(*collection_or_resource_ids) -> RelativeResourceName:
     return TypeAdapter(RelativeResourceName).validate_python("/".join(quoted_parts))
 
 
-def split_resource_name(resource_name: RelativeResourceName) -> list[str]:
+def split_resource_name(resource_name: RelativeResourceName) -> tuple[str, ...]:
+    """
+    Example:
+        resource_name = "solvers/simcore%2Fservices%2Fcomp%2Fisolve/releases/1.3.4/jobs/f622946d-fd29-35b9-a193-abdd1095167c/outputs/output+22"
+        returns ("solvers", "simcore/services/comp/isolve", "releases", "1.3.4", "jobs", "f622946d-fd29-35b9-a193-abdd1095167c", "outputs", "output 22")
+    """
     quoted_parts = resource_name.split("/")
-    return [f"{urllib.parse.unquote_plus(p)}" for p in quoted_parts]
+    return tuple(f"{urllib.parse.unquote_plus(p)}" for p in quoted_parts)
 
 
-def parse_collections_ids(resource_name: RelativeResourceName) -> list[str]:
+def parse_collections_ids(resource_name: RelativeResourceName) -> tuple[str, ...]:
     """
     Example:
         resource_name = "solvers/simcore%2Fservices%2Fcomp%2Fisolve/releases/1.3.4/jobs/f622946d-fd29-35b9-a193-abdd1095167c/outputs/output+22"
-        returns ["solvers", "releases", "jobs", "outputs"]
+        returns ("solvers", "releases", "jobs", "outputs")
     """
     parts = split_resource_name(resource_name)
     return parts[::2]
 
 
-def parse_resources_ids(resource_name: RelativeResourceName) -> list[str]:
+def parse_resources_ids(resource_name: RelativeResourceName) -> tuple[str, ...]:
     """
     Example:
         resource_name = "solvers/simcore%2Fservices%2Fcomp%2Fisolve/releases/1.3.4/jobs/f622946d-fd29-35b9-a193-abdd1095167c/outputs/output+22"
-        returns ["simcore/services/comp/isolve", "1.3.4", "f622946d-fd29-35b9-a193-abdd1095167c", "output 22"]
+        returns ("simcore/services/comp/isolve", "1.3.4", "f622946d-fd29-35b9-a193-abdd1095167c", "output 22")
     """
     parts = split_resource_name(resource_name)
     return parts[1::2]

services/api-server/tests/unit/test_models_api_resources.py

@@ -17,7 +17,7 @@
 
 def test_parse_resource_id():
     resource_name = "solvers/simcore%2Fservices%2Fcomp%2Fisolve/releases/1.3.4/jobs/f622946d-fd29-35b9-a193-abdd1095167c/outputs/output+22"
-    parts = [
+    parts = (
         "solvers",
         "simcore/services/comp/isolve",
         "releases",
@@ -26,7 +26,7 @@ def test_parse_resource_id():
         "f622946d-fd29-35b9-a193-abdd1095167c",
         "outputs",
         "output 22",
-    ]
+    )
 
     # cannot use this because cannot convert into URL? except {:path} in starlette ???
     assert str(Path(*parts)) == urllib.parse.unquote_plus(resource_name)
@@ -44,10 +44,10 @@ def test_parse_resource_id():
 
     collection_to_resource_id_map = split_resource_name_as_dict(resource_name)
     # Collection-ID -> Resource-ID
-    assert list(collection_to_resource_id_map.keys()) == parse_collections_ids(
+    assert tuple(collection_to_resource_id_map.keys()) == parse_collections_ids(
         resource_name
     )
-    assert list(collection_to_resource_id_map.values()) == parse_resources_ids(
+    assert tuple(collection_to_resource_id_map.values()) == parse_resources_ids(
         resource_name
     )