introduce _base.py and refactor

Author: bisgaard-itis

services/api-server/src/simcore_service_api_server/models/schemas/_base.py

@@ -0,0 +1,71 @@
+import urllib.parse
+from typing import Annotated
+
+import packaging.version
+from models_library.utils.change_case import camel_to_snake
+from pydantic import BaseModel, ConfigDict, Field, HttpUrl, StringConstraints
+
+from ...models._utils_pydantic import UriSchema
+from ..basic_types import VersionStr
+
+
+class ApiServerOutputSchema(BaseModel):
+    model_config = ConfigDict(
+        alias_generator=camel_to_snake,
+        populate_by_name=True,
+        extra="ignore",  # Used to prune extra fields from internal data
+        frozen=True,
+    )
+
+
+class ApiServerInputSchema(BaseModel):
+    model_config = ConfigDict(
+        alias_generator=camel_to_snake,
+        populate_by_name=True,
+        extra="ignore",  # Used to prune extra fields from internal data
+        frozen=True,
+    )
+
+
+class BaseService(BaseModel):
+    id: Annotated[str, Field(..., description="Resource identifier")]
+    version: Annotated[
+        VersionStr, Field(..., description="Semantic version number of the resource")
+    ]
+    title: Annotated[
+        str,
+        StringConstraints(max_length=100),
+        Field(..., description="Human readable name"),
+    ]
+    description: Annotated[
+        str | None,
+        StringConstraints(max_length=500),
+        Field(default=None, description="Description of the resource"),
+    ]
+    url: Annotated[
+        HttpUrl | None, UriSchema(), Field(..., description="Link to get this resource")
+    ]
+
+    @property
+    def pep404_version(self) -> packaging.version.Version:
+        """Rich version type that can be used e.g. to compare"""
+        return packaging.version.parse(self.version)
+
+    @property
+    def url_friendly_id(self) -> str:
+        """Use to pass id as parameter in URLs"""
+        return urllib.parse.quote_plus(self.id)
+
+    @property
+    def resource_name(self) -> str:
+        """Relative resource name"""
+        return self.compose_resource_name(self.id, self.version)
+
+    @property
+    def name(self) -> str:
+        """API standards notation (see api_resources.py)"""
+        return self.resource_name
+
+    @classmethod
+    def compose_resource_name(cls, key: str, version: str) -> str:
+        raise NotImplementedError("Subclasses must implement this method")

services/api-server/src/simcore_service_api_server/models/schemas/_utils.py

@@ -18,7 +18,7 @@
 from .._utils_pydantic import UriSchema
 from ..domain.files import File as DomainFile
 from ..domain.files import FileName
-from ._utils import ApiServerInputSchema, ApiServerOutputSchema
+from ._base import ApiServerInputSchema, ApiServerOutputSchema
 
 
 class UserFile(ApiServerInputSchema):

services/api-server/src/simcore_service_api_server/models/schemas/files.py

@@ -41,7 +41,7 @@
 from ..domain.files import File as DomainFile
 from ..domain.files import FileInProgramJobData
 from ..schemas.files import UserFile
-from ._utils import ApiServerInputSchema
+from ._base import ApiServerInputSchema
 
 # JOB SUB-RESOURCES  ----------
 #

services/api-server/src/simcore_service_api_server/models/schemas/jobs.py

@@ -6,7 +6,10 @@
 from models_library.services_regex import DYNAMIC_SERVICE_KEY_RE
 from packaging.version import Version
 from pydantic import BaseModel, ConfigDict, Field, HttpUrl, StringConstraints
-from simcore_service_api_server.models.schemas._utils import ApiServerOutputSchema
+from simcore_service_api_server.models.schemas._base import (
+    ApiServerOutputSchema,
+    BaseService,
+)
 
 from ...models._utils_pydantic import UriSchema
 from ..api_resources import compose_resource_name
@@ -27,7 +30,7 @@
 ]
 
 
-class BaseResource(BaseModel):
+class BaseService(BaseModel):
     id: Annotated[str, Field(..., description="Resource identifier")]
     version: Annotated[
         VersionStr, Field(..., description="Semantic version number of the resource")
@@ -71,7 +74,7 @@ def compose_resource_name(cls, key: str, version: str) -> str:
         raise NotImplementedError("Subclasses must implement this method")
 
 
-class Program(BaseResource, ApiServerOutputSchema):
+class Program(BaseService, ApiServerOutputSchema):
     """A released program with a specific version"""
 
     model_config = ConfigDict(

services/api-server/src/simcore_service_api_server/models/schemas/programs.py

@@ -5,7 +5,7 @@
 from models_library.services_regex import COMPUTATIONAL_SERVICE_KEY_RE
 from pydantic import BaseModel, ConfigDict, Field, StringConstraints
 
-from ...models.schemas.programs import BaseResource
+from ...models.schemas._base import BaseService
 from ..api_resources import compose_resource_name
 
 # NOTE:
@@ -32,7 +32,7 @@
 ]
 
 
-class Solver(BaseResource):
+class Solver(BaseService):
     """A released solver with a specific version"""
 
     maintainer: str = Field(..., description="Maintainer of the solver")