♻️ Maintenance/function services (cont.) (ITISFoundation#2989)

Author: pcrespov

packages/models-library/src/models_library/function_services_catalog/_key_labels.py

@@ -1,21 +1,15 @@
 from typing import Final
 
+from ..services import ServiceKey
+
 # NOTE: due to legacy reasons, the name remains with 'frontend' in it but
 # it now refers to a more general group: function sections that contains front-end services as well
 FUNCTION_SERVICE_KEY_PREFIX: Final[str] = "simcore/services/frontend"
 
 
-def is_function_service(service_key: str) -> bool:
+def is_function_service(service_key: ServiceKey) -> bool:
     return service_key.startswith(f"{FUNCTION_SERVICE_KEY_PREFIX}/")
 
 
-def is_parameter_service(service_key: str) -> bool:
-    return service_key.startswith(f"{FUNCTION_SERVICE_KEY_PREFIX}/parameter/")
-
-
-def is_iterator_service(service_key: str) -> bool:
+def is_iterator_service(service_key: ServiceKey) -> bool:
     return service_key.startswith(f"{FUNCTION_SERVICE_KEY_PREFIX}/data-iterator/")
-
-
-def is_iterator_consumer_service(service_key: str) -> bool:
-    return service_key.startswith(f"{FUNCTION_SERVICE_KEY_PREFIX}/iterator-consumer/")

packages/models-library/src/models_library/function_services_catalog/_registry.py

@@ -8,8 +8,7 @@
 
 import logging
 
-from models_library.function_services_catalog.services import nodes_group
-
+from ..function_services_catalog.services import nodes_group
 from ._settings import FunctionServiceSettings
 from ._utils import FunctionServices
 from .services import (

packages/models-library/src/models_library/function_services_catalog/_utils.py

@@ -1,13 +1,9 @@
 import logging
 from dataclasses import dataclass
-from typing import Callable, Dict, Iterable, Optional, Tuple
+from typing import Callable, Dict, Iterator, Optional, Tuple
 from urllib.parse import quote
 
-from models_library.basic_regex import VERSION_RE
-from models_library.services import SERVICE_KEY_RE
-from pydantic import constr
-
-from ..services import Author, ServiceDockerData
+from ..services import Author, ServiceDockerData, ServiceKey, ServiceVersion
 from ._settings import AUTHORS, FunctionServiceSettings
 
 log = logging.getLogger(__name__)
@@ -27,8 +23,8 @@ def create_fake_thumbnail_url(label: str) -> str:
     return f"https://fakeimg.pl/100x100/ff0000%2C128/000%2C255/?text={quote(label)}"
 
 
-ServiceKey = constr(regex=SERVICE_KEY_RE)
-ServiceVersion = constr(regex=VERSION_RE)
+class ServiceNotFound(KeyError):
+    pass
 
 
 @dataclass
@@ -45,13 +41,15 @@ def __init__(self, settings: Optional[FunctionServiceSettings] = None):
         self._functions: Dict[Tuple[ServiceKey, ServiceVersion], _Record] = {}
         self.settings = settings
 
-    def add_function_service(
+    def add(
         self,
         meta: ServiceDockerData,
         implementation: Optional[Callable] = None,
         is_under_development: bool = False,
     ):
-
+        """
+        raises ValueError
+        """
         if not isinstance(meta, ServiceDockerData):
             raise ValueError(f"Expected ServiceDockerData, got {type(meta)}")
 
@@ -71,42 +69,52 @@ def add_function_service(
     def extend(self, other: "FunctionServices"):
         # pylint: disable=protected-access
         for f in other._functions.values():
-            self.add_function_service(f.meta, f.implementation, f.is_under_development)
+            self.add(f.meta, f.implementation, f.is_under_development)
 
-    def skip_dev(self):
+    def _skip_dev(self):
         skip = True
         if self.settings:
             skip = not self.settings.is_dev_feature_enabled()
         return skip
 
-    def iter_items(self):
-        skip_dev = self.skip_dev()
+    def _items(self) -> Iterator[Tuple[Tuple[ServiceKey, ServiceVersion], _Record]]:
+        skip_dev = self._skip_dev()
         for key, value in self._functions.items():
             if value.is_under_development and skip_dev:
                 continue
             yield key, value
 
-    def iter_metadata(self) -> Iterable[ServiceDockerData]:
-        for _, f in self.iter_items():
+    def iter_metadata(self) -> Iterator[ServiceDockerData]:
+        for _, f in self._items():
             yield f.meta
 
-    def iter_services_key_version(self) -> Iterable[Tuple[ServiceKey, ServiceVersion]]:
-        for kv, f in self.iter_items():
+    def iter_services_key_version(self) -> Iterator[Tuple[ServiceKey, ServiceVersion]]:
+        for kv, f in self._items():
             assert kv == (f.meta.key, f.meta.version)  # nosec
             yield kv
 
     def get_implementation(
         self, service_key: ServiceKey, service_version: ServiceVersion
     ) -> Optional[Callable]:
-        # raises KeyError if not found
-        func = self._functions[(service_key, service_version)]
+        """raises ServiceNotFound"""
+        try:
+            func = self._functions[(service_key, service_version)]
+        except KeyError as err:
+            raise ServiceNotFound(
+                f"{service_key}:{service_version} not found in registry"
+            ) from err
         return func.implementation
 
     def get_metadata(
         self, service_key: ServiceKey, service_version: ServiceVersion
     ) -> ServiceDockerData:
-        # raises KeyError if not found
-        func = self._functions[(service_key, service_version)]
+        """raises ServiceNotFound"""
+        try:
+            func = self._functions[(service_key, service_version)]
+        except KeyError as err:
+            raise ServiceNotFound(
+                f"{service_key}:{service_version} not found in registry"
+            ) from err
         return func.meta
 
     def __len__(self):

packages/models-library/src/models_library/function_services_catalog/services/demo_units.py

@@ -15,6 +15,11 @@ def build_input(schema):
 
 
 # SEE https://github.com/hgrecco/pint/blob/master/pint/default_en.txt
+#
+# NOTE: this service is also used as fixture in test_catalog_utils.py::test_can_connect_with_units
+#       and assumes for convenience that matching 'Titles' correspond to compatible units.
+#       If this assumption cannot be guaranteed anymore the test must be updated.
+#
 
 META = ServiceDockerData.parse_obj(
     {
@@ -25,7 +30,8 @@ def build_input(schema):
         # - 0.2.0: reverted order of first 5 outputs
         "type": ServiceType.BACKEND,
         "name": "Demo Units",
-        "description": "Demo that takes base units as inputs and transform them in the outputs",
+        "description": "This service is for demo purposes."
+        "It takes base units as inputs and transform them in the outputs.",
         "authors": [PC, OM],
         "contact": PC.email,
         "thumbnail": create_fake_thumbnail_url("demo-units"),
@@ -111,7 +117,7 @@ def build_input(schema):
             "radiation": build_input(
                 {
                     "title": "Radiation",
-                    "x_unit": "roentgen",
+                    "x_unit": "rutherford",
                     "type": "number",
                 }
             ),
@@ -187,7 +193,7 @@ def build_input(schema):
             ),
             "radiation": build_input(
                 {
-                    "title": "Radiati0n",  # it's not a typo
+                    "title": "Radiation",
                     "x_unit": "curie",
                     "type": "number",
                 }
@@ -198,7 +204,7 @@ def build_input(schema):
 
 
 services = FunctionServices()
-services.add_function_service(
+services.add(
     meta=META,
     is_under_development=True,
 )

packages/models-library/src/models_library/function_services_catalog/services/file_picker.py

@@ -30,6 +30,6 @@
 
 
 services = FunctionServices()
-services.add_function_service(
+services.add(
     meta=META,
 )

packages/models-library/src/models_library/function_services_catalog/services/iter_range.py

@@ -1,7 +1,6 @@
 from typing import Iterator, Optional
 
-from models_library.projects_nodes import Outputs
-
+from ...projects_nodes import Outputs
 from ...services import LATEST_INTEGRATION_VERSION, ServiceDockerData, ServiceType
 from .._key_labels import FUNCTION_SERVICE_KEY_PREFIX
 from .._utils import OM, FunctionServices, create_fake_thumbnail_url
@@ -69,7 +68,7 @@ def _linspace_generator(**kwargs) -> Iterator[Outputs]:
 
 
 services = FunctionServices()
-services.add_function_service(
+services.add(
     meta=create_metadata("integer", prefix="int"),
     implementation=_linspace_generator,
     is_under_development=True,

packages/models-library/src/models_library/function_services_catalog/services/iter_sensitivity.py

@@ -1,9 +1,9 @@
 from copy import deepcopy
 from typing import Any, Dict, Iterator, List, Tuple
 
-from models_library.projects_nodes import Outputs
 from pydantic import schema_of
 
+from ...projects_nodes import Outputs
 from ...services import LATEST_INTEGRATION_VERSION, ServiceDockerData, ServiceType
 from .._key_labels import FUNCTION_SERVICE_KEY_PREFIX
 from .._utils import EN, OM, FunctionServices, create_fake_thumbnail_url
@@ -104,7 +104,7 @@ def _sensitivity_generator(
 
 
 services = FunctionServices()
-services.add_function_service(
+services.add(
     meta=META,
     implementation=_sensitivity_generator,
     is_under_development=True,

packages/models-library/src/models_library/function_services_catalog/services/nodes_group.py

@@ -36,4 +36,4 @@
 
 
 services = FunctionServices()
-services.add_function_service(meta=META, is_under_development=True)
+services.add(meta=META, is_under_development=True)

packages/models-library/src/models_library/function_services_catalog/services/parameters.py

@@ -82,4 +82,4 @@ def create_metadata(
 
 services = FunctionServices()
 for m in (META_NUMBER, META_BOOL, META_INT, META_STR, META_ARRAY):
-    services.add_function_service(meta=m)
+    services.add(meta=m)

packages/models-library/src/models_library/function_services_catalog/services/probes.py

@@ -71,4 +71,4 @@ def create_metadata(type_name: str, prefix: Optional[str] = None) -> ServiceDock
 
 services = FunctionServices()
 for m in (META_NUMBER, META_BOOL, META_INT, META_STR, META_ARRAY):
-    services.add_function_service(meta=m)
+    services.add(meta=m)