Skip to content

♻️Maintenance: remove circular dependency #8245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 21, 2025
Merged

♻️Maintenance: remove circular dependency #8245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
647c798
remove circular dependency
sanderegg Aug 21, 2025
21bd3f4
missing
sanderegg Aug 21, 2025
1aba58b
missing change
sanderegg Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 37 additions & 32 deletions packages/models-library/src/models_library/boot_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from pydantic import BaseModel, ConfigDict, ValidationInfo, field_validator
from pydantic.config import JsonDict
from typing_extensions import ( # https://docs.pydantic.dev/latest/api/standard_library_types/#typeddict
TypedDict,
)
Expand Down Expand Up @@ -26,42 +27,46 @@ def ensure_default_included(cls, v, info: ValidationInfo):
raise ValueError(msg)
return v

model_config = ConfigDict(
json_schema_extra={
"examples": [
{
"label": "Boot mode",
"description": "Start it in web page mode",
"default": "0",
"items": {
"0": {
"label": "Non Voila",
"description": "Tooltip for non Voila boot mode",
},
"1": {
"label": "Voila",
"description": "Tooltip for Voila boot mode",
@staticmethod
def _update_json_schema_extra(schema: JsonDict) -> None:
schema.update(
{
"examples": [
{
"label": "Boot mode",
"description": "Start it in web page mode",
"default": "0",
"items": {
"0": {
"label": "Non Voila",
"description": "Tooltip for non Voila boot mode",
},
"1": {
"label": "Voila",
"description": "Tooltip for Voila boot mode",
},
},
},
},
{
"label": "Application theme",
"description": "Select a theme for the application",
"default": "b",
"items": {
"a": {
"label": "Clear",
"description": "Using white background",
},
"b": {
"label": "Dark",
"description": "Using black and gray tones",
{
"label": "Application theme",
"description": "Select a theme for the application",
"default": "b",
"items": {
"a": {
"label": "Clear",
"description": "Using white background",
},
"b": {
"label": "Dark",
"description": "Using black and gray tones",
},
},
},
},
]
}
)
]
}
)

model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)


BootOptions = dict[EnvVarKey, BootOption]
201 changes: 1 addition & 200 deletions packages/models-library/src/models_library/docker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,12 @@
import contextlib
import re
from typing import Annotated, Any, Final, TypeAlias
from typing import Annotated, TypeAlias

from pydantic import (
BaseModel,
ByteSize,
ConfigDict,
Field,
StringConstraints,
TypeAdapter,
ValidationError,
model_validator,
)

from .basic_regex import DOCKER_GENERIC_TAG_KEY_RE, DOCKER_LABEL_KEY_REGEX
from .basic_types import ConstrainedStr
from .generated_models.docker_rest_api import Task
from .products import ProductName
from .projects import ProjectID
from .projects_nodes_io import NodeID
from .users import UserID


class DockerLabelKey(ConstrainedStr):
Expand Down Expand Up @@ -47,192 +34,6 @@ def from_key(cls, key: str) -> "DockerLabelKey":
),
]

_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX: Final[str] = "io.simcore.runtime."
_BACKWARDS_COMPATIBILITY_SIMCORE_RUNTIME_DOCKER_LABELS_MAP: Final[dict[str, str]] = {
"node_id": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}node-id",
"product_name": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}product-name",
"project_id": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}project-id",
"simcore_user_agent": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}simcore-user-agent",
"study_id": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}project-id",
"user_id": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}user-id",
"uuid": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}node-id",
"mem_limit": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}memory-limit",
"swarm_stack_name": f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}swarm-stack-name",
}
_UNDEFINED_LABEL_VALUE_STR: Final[str] = "undefined"
_UNDEFINED_LABEL_VALUE_INT: Final[str] = "0"


DOCKER_TASK_EC2_INSTANCE_TYPE_PLACEMENT_CONSTRAINT_KEY: Final[DockerLabelKey] = (
TypeAdapter(DockerLabelKey).validate_python("ec2-instance-type")
)


def to_simcore_runtime_docker_label_key(key: str) -> DockerLabelKey:
return DockerLabelKey(
f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}{key.replace('_', '-').lower()}"
)


class StandardSimcoreDockerLabels(BaseModel):
"""
Represents the standard label on oSparc created containers (not yet services)
In order to create this object in code, please use model_construct() method!
"""

user_id: UserID = Field(..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}user-id") # type: ignore[literal-required]
project_id: ProjectID = Field( # type: ignore[literal-required]
..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}project-id"
)
node_id: NodeID = Field(..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}node-id") # type: ignore[literal-required]

product_name: ProductName = Field( # type: ignore[literal-required]
..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}product-name"
)
simcore_user_agent: str = Field( # type: ignore[literal-required]
..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}simcore-user-agent"
)

swarm_stack_name: str = Field( # type: ignore[literal-required]
..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}swarm-stack-name"
)

memory_limit: ByteSize = Field( # type: ignore[literal-required]
..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}memory-limit"
)
cpu_limit: float = Field( # type: ignore[literal-required]
..., alias=f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}cpu-limit"
)

@model_validator(mode="before")
@classmethod
def _backwards_compatibility(cls, values: dict[str, Any]) -> dict[str, Any]:
# NOTE: this is necessary for dy-sidecar and legacy service until they are adjusted
if mapped_values := {
_BACKWARDS_COMPATIBILITY_SIMCORE_RUNTIME_DOCKER_LABELS_MAP[k]: v
for k, v in values.items()
if k in _BACKWARDS_COMPATIBILITY_SIMCORE_RUNTIME_DOCKER_LABELS_MAP
}:
# these values were sometimes omitted, so let's provide some defaults
for key in ["product-name", "simcore-user-agent", "swarm-stack-name"]:
mapped_values.setdefault(
f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}{key}",
_UNDEFINED_LABEL_VALUE_STR,
)

mapped_values.setdefault(
f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}memory-limit",
values.get("memory_limit", _UNDEFINED_LABEL_VALUE_INT),
)

def _convert_nano_cpus_to_cpus(nano_cpu: str) -> str:
with contextlib.suppress(ValidationError):
return f"{TypeAdapter(float).validate_python(nano_cpu) / (1.0 * 10**9):.2f}"
return _UNDEFINED_LABEL_VALUE_INT

mapped_values.setdefault(
f"{_SIMCORE_RUNTIME_DOCKER_LABEL_PREFIX}cpu-limit",
values.get(
"cpu_limit",
_convert_nano_cpus_to_cpus(
values.get(
"nano_cpus_limit",
_UNDEFINED_LABEL_VALUE_INT,
)
),
),
)
return mapped_values
return values

def to_simcore_runtime_docker_labels(self) -> dict[DockerLabelKey, str]:
"""returns a dictionary of strings as required by docker"""
return {
to_simcore_runtime_docker_label_key(k): f"{v}"
for k, v in sorted(self.model_dump().items())
}

@classmethod
def from_docker_task(cls, docker_task: Task) -> "StandardSimcoreDockerLabels":
assert docker_task.spec # nosec
assert docker_task.spec.container_spec # nosec
task_labels = docker_task.spec.container_spec.labels or {}
return cls.model_validate(task_labels)

model_config = ConfigDict(
populate_by_name=True,
json_schema_extra={
"examples": [
# legacy service labels
{
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"swarm_stack_name": "devel-simcore",
"user_id": "5",
"uuid": "1f963626-66e1-43f1-a777-33955c08b909",
},
# legacy container labels
{
"mem_limit": "1073741824",
"nano_cpus_limit": "4000000000",
"node_id": "1f963626-66e1-43f1-a777-33955c08b909",
"simcore_user_agent": "puppeteer",
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"swarm_stack_name": "devel-simcore",
"user_id": "5",
},
# dy-sidecar service labels
{
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"swarm_stack_name": "devel-simcore",
"user_id": "5",
"uuid": "1f963626-66e1-43f1-a777-33955c08b909",
},
# dy-sidecar container labels
{
"mem_limit": "1073741824",
"nano_cpus_limit": "4000000000",
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"user_id": "5",
"uuid": "1f963626-66e1-43f1-a777-33955c08b909",
},
# dy-proxy service labels
{
"dynamic-type": "dynamic-sidecar",
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"swarm_stack_name": "devel-simcore",
"type": "dependency-v2",
"user_id": "5",
"uuid": "1f963626-66e1-43f1-a777-33955c08b909",
},
# dy-proxy container labels
{
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"user_id": "5",
"uuid": "1f963626-66e1-43f1-a777-33955c08b909",
},
# dy-sidecar user-services labels
{
"product_name": "osparc",
"simcore_user_agent": "puppeteer",
"study_id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"user_id": "5",
"uuid": "1f963626-66e1-43f1-a777-33955c08b909",
},
# modern both dynamic-sidecar services and computational services
{
"io.simcore.runtime.cpu-limit": "2.4",
"io.simcore.runtime.memory-limit": "1073741824",
"io.simcore.runtime.node-id": "1f963626-66e1-43f1-a777-33955c08b909",
"io.simcore.runtime.product-name": "osparc",
"io.simcore.runtime.project-id": "29f393fc-1410-47b3-b4b9-61dfce21a2a6",
"io.simcore.runtime.simcore-user-agent": "puppeteer",
"io.simcore.runtime.swarm-stack-name": "devel-osparc",
"io.simcore.runtime.user-id": "5",
},
]
},
)


DockerNodeID: TypeAlias = Annotated[
str, StringConstraints(strip_whitespace=True, pattern=re.compile(r"[a-zA-Z0-9]"))
Expand Down
8 changes: 6 additions & 2 deletions packages/models-library/src/models_library/services_metadata_published.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,12 @@
}
},
"boot-options": {
"example_service_defined_boot_mode": BootOption.model_config["json_schema_extra"]["examples"][0], # type: ignore [index]
"example_service_defined_theme_selection": BootOption.model_config["json_schema_extra"]["examples"][1], # type: ignore [index]
"example_service_defined_boot_mode": BootOption.model_json_schema()["examples"][
0
],
"example_service_defined_theme_selection": BootOption.model_json_schema()[
"examples"
][1],
},
"min-visible-inputs": 2,
}
Expand Down
Loading
Loading