digitalhub-runtime-python 0.7.0b5__tar.gz → 0.8.0__tar.gz

{digitalhub_runtime_python-0.7.0b5 → digitalhub_runtime_python-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: digitalhub-runtime-python
-Version: 0.7.0b5
+Version: 0.8.0
 Summary: Python runtime for DHCore
 Author-email: Fondazione Bruno Kessler <dslab@fbk.eu>, Matteo Martini <mmartini@fbk.eu>
 License:                               Apache License
@@ -225,9 +225,10 @@ Keywords: data,dataops,kubernetes
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: digitalhub[ml]<0.8,>=0.7.0b
+Requires-Dist: digitalhub[full]<0.9,>=0.8.0
 
 # SDK for DHCore

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/__init__.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from digitalhub_runtime_python.entities.function.python.builder import FunctionPythonBuilder
+from digitalhub_runtime_python.entities.run.python_run.builder import RunPythonRunBuilder
+from digitalhub_runtime_python.entities.task.python_build.builder import TaskPythonBuildBuilder
+from digitalhub_runtime_python.entities.task.python_job.builder import TaskPythonJobBuilder
+from digitalhub_runtime_python.entities.task.python_serve.builder import TaskPythonServeBuilder
+from digitalhub_runtime_python.utils.utils import handler
+
+entity_builders = (
+    (FunctionPythonBuilder.ENTITY_KIND, FunctionPythonBuilder),
+    (TaskPythonBuildBuilder.ENTITY_KIND, TaskPythonBuildBuilder),
+    (TaskPythonJobBuilder.ENTITY_KIND, TaskPythonJobBuilder),
+    (TaskPythonServeBuilder.ENTITY_KIND, TaskPythonServeBuilder),
+    (RunPythonRunBuilder.ENTITY_KIND, RunPythonRunBuilder),
+)
+
+try:
+    from digitalhub_runtime_python.runtimes.builder import RuntimePythonBuilder
+
+    runtime_builders = ((kind, RuntimePythonBuilder) for kind in FunctionPythonBuilder().get_all_kinds())
+except ImportError:
+    runtime_builders = tuple()

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/_base/runtime_entity/builder.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from digitalhub.entities._base.runtime_entity.builder import RuntimeEntityBuilder
+
+
+class RuntimeEntityBuilderPython(RuntimeEntityBuilder):
+    EXECUTABLE_KIND = "python"
+    TASKS_KINDS = [
+        {
+            "kind": "python+job",
+            "action": "job",
+        },
+        {
+            "kind": "python+build",
+            "action": "build",
+        },
+        {
+            "kind": "python+serve",
+            "action": "serve",
+        },
+    ]
+    RUN_KIND = "python+run"

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/function/python/builder.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from digitalhub_runtime_python.entities._base.runtime_entity.builder import RuntimeEntityBuilderPython
+from digitalhub_runtime_python.entities.function.python.entity import FunctionPython
+from digitalhub_runtime_python.entities.function.python.spec import FunctionSpecPython, FunctionValidatorPython
+from digitalhub_runtime_python.entities.function.python.status import FunctionStatusPython
+
+from digitalhub.entities.function._base.builder import FunctionBuilder
+
+
+class FunctionPythonBuilder(FunctionBuilder, RuntimeEntityBuilderPython):
+    """
+    FunctionPython builder.
+    """
+
+    ENTITY_CLASS = FunctionPython
+    ENTITY_SPEC_CLASS = FunctionSpecPython
+    ENTITY_SPEC_VALIDATOR = FunctionValidatorPython
+    ENTITY_STATUS_CLASS = FunctionStatusPython
+    ENTITY_KIND = "python"

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/function/python/entity.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.function._base.entity import Function
+
+if typing.TYPE_CHECKING:
+    from digitalhub_runtime_python.entities.function.python.spec import FunctionSpecPython
+    from digitalhub_runtime_python.entities.function.python.status import FunctionStatusPython
+
+    from digitalhub.entities._base.entity.metadata import Metadata
+
+
+class FunctionPython(Function):
+    """
+    FunctionPython class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        name: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: FunctionSpecPython,
+        status: FunctionStatusPython,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, name, uuid, kind, metadata, spec, status, user)
+
+        self.spec: FunctionSpecPython
+        self.status: FunctionStatusPython

{digitalhub_runtime_python-0.7.0b5/digitalhub_runtime_python/entities/function → digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/function/python}/models.py

@@ -2,10 +2,10 @@ from __future__ import annotations
 
 from pathlib import Path
 
-from digitalhub_core.entities.function.models import SourceCodeParams, SourceCodeStruct
-from digitalhub_core.utils.exceptions import EntityError
-from digitalhub_core.utils.generic_utils import encode_source, encode_string
-from digitalhub_core.utils.uri_utils import map_uri_scheme
+from digitalhub.entities.function._base.models import SourceCodeStruct, SourceCodeValidator
+from digitalhub.utils.exceptions import EntityError
+from digitalhub.utils.generic_utils import encode_source, encode_string
+from digitalhub.utils.uri_utils import map_uri_scheme
 
 
 class SourceCodeStructPython(SourceCodeStruct):
@@ -92,9 +92,9 @@ class SourceCodeStructPython(SourceCodeStruct):
         return dict_
 
 
-class SourceCodeParamsPython(SourceCodeParams):
+class SourceCodeValidatorPython(SourceCodeValidator):
     """
-    Source code params for python.
+    SourceCodeValidatorPython validator.
     """
 
     init_function: str = None

{digitalhub_runtime_python-0.7.0b5/digitalhub_runtime_python/entities/function → digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/function/python}/spec.py

@@ -2,13 +2,14 @@ from __future__ import annotations
 
 from typing import Literal
 
-from digitalhub_core.entities.function.spec import FunctionParams, FunctionSpec
-from digitalhub_runtime_python.entities.function.models import SourceCodeParamsPython, SourceCodeStructPython
+from digitalhub_runtime_python.entities.function.python.models import SourceCodeStructPython, SourceCodeValidatorPython
+
+from digitalhub.entities.function._base.spec import FunctionSpec, FunctionValidator
 
 
 class FunctionSpecPython(FunctionSpec):
     """
-    Specification for a Function job.
+    FunctionSpecPython specifications.
     """
 
     def __init__(
@@ -90,9 +91,9 @@ class FunctionSpecPython(FunctionSpec):
         return dict_
 
 
-class FunctionParamsPython(FunctionParams, SourceCodeParamsPython):
+class FunctionValidatorPython(FunctionValidator, SourceCodeValidatorPython):
     """
-    Function python parameters model.
+    FunctionValidatorPython validator.
     """
 
     python_version: Literal["PYTHON3_9", "PYTHON3_10", "PYTHON3_11"]

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/function/python/status.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from digitalhub.entities.function._base.status import FunctionStatus
+
+
+class FunctionStatusPython(FunctionStatus):
+    """
+    FunctionStatusPython status.
+    """

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/run/python_run/builder.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from digitalhub_runtime_python.entities._base.runtime_entity.builder import RuntimeEntityBuilderPython
+from digitalhub_runtime_python.entities.run.python_run.entity import RunPythonRun
+from digitalhub_runtime_python.entities.run.python_run.spec import RunSpecPythonRun, RunValidatorPythonRun
+from digitalhub_runtime_python.entities.run.python_run.status import RunStatusPythonRun
+
+from digitalhub.entities.run._base.builder import RunBuilder
+
+
+class RunPythonRunBuilder(RunBuilder, RuntimeEntityBuilderPython):
+    """
+    RunPythonRunBuilder runer.
+    """
+
+    ENTITY_CLASS = RunPythonRun
+    ENTITY_SPEC_CLASS = RunSpecPythonRun
+    ENTITY_SPEC_VALIDATOR = RunValidatorPythonRun
+    ENTITY_STATUS_CLASS = RunStatusPythonRun
+    ENTITY_KIND = "python+run"

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/run/python_run/entity.py

@@ -0,0 +1,251 @@
+from __future__ import annotations
+
+import time
+import typing
+from typing import Any
+
+import requests
+from digitalhub_runtime_python.entities.run.python_run.utils import get_getter_for_material
+
+from digitalhub.entities.run._base.entity import Run
+from digitalhub.entities.utils.state import State
+from digitalhub.entities.utils.utils import get_entity_type_from_key
+from digitalhub.factory.api import get_action_from_task_kind
+from digitalhub.utils.exceptions import EntityError
+from digitalhub.utils.logger import LOGGER
+
+if typing.TYPE_CHECKING:
+    from digitalhub_runtime_python.entities.run.python_run.spec import RunSpecPythonRun
+    from digitalhub_runtime_python.entities.run.python_run.status import RunStatusPythonRun
+
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.material.entity import MaterialEntity
+
+
+class RunPythonRun(Run):
+    """
+    RunPythonRun class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: RunSpecPythonRun,
+        status: RunStatusPythonRun,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, uuid, kind, metadata, spec, status, user)
+
+        self.spec: RunSpecPythonRun
+        self.status: RunStatusPythonRun
+
+    def _setup_execution(self) -> None:
+        """
+        Setup run execution.
+
+        Returns
+        -------
+        None
+        """
+        self.refresh()
+        self.spec.inputs = self.inputs(as_dict=True)
+
+    def wait(self, log_info: bool = True) -> Run:
+        """
+        Wait for run to finish.
+
+        Parameters
+        ----------
+        log_info : bool
+            If True, log information.
+
+        Returns
+        -------
+        Run
+            Run object.
+        """
+        task_kind = self.spec.task.split("://")[0]
+        action = get_action_from_task_kind(self.kind, task_kind)
+
+        if action == "serve":
+            serve_timeout = 300
+            start = time.time()
+
+            while time.time() - start < serve_timeout:
+                if log_info:
+                    LOGGER.info(f"Waiting for run {self.id} to deploy service.")
+
+                self.refresh()
+                if self.status.service is not None:
+                    if log_info:
+                        msg = f"Run {self.id} service deployed."
+                        LOGGER.info(msg)
+                    return self
+
+                elif self.status.state == State.ERROR.value:
+                    if log_info:
+                        msg = f"Run {self.id} serving failed."
+                        LOGGER.info(msg)
+                    return self
+
+                time.sleep(5)
+
+            if log_info:
+                msg = f"Waiting for run {self.id} service timed out. Check logs for more information."
+                LOGGER.info(msg)
+
+            return self
+
+        return super().wait(log_info=log_info)
+
+    def inputs(self, as_dict: bool = False) -> dict:
+        """
+        Get inputs passed in spec as objects or as dictionaries.
+
+        Parameters
+        ----------
+        as_dict : bool
+            If True, return inputs as dictionaries.
+
+        Returns
+        -------
+        dict
+            Inputs.
+        """
+        inputs = {}
+        if self.inputs is None:
+            return inputs
+
+        for parameter, key in self.spec.inputs.items():
+            entity_type = get_entity_type_from_key(key)
+            entity = get_getter_for_material(entity_type)(key)
+            if as_dict:
+                entity = entity.to_dict()
+            inputs[parameter] = entity
+
+        return inputs
+
+    def output(
+        self,
+        output_name: str,
+        as_key: bool = False,
+        as_dict: bool = False,
+    ) -> MaterialEntity | dict | str | None:
+        """
+        Get run's output by name.
+
+        Parameters
+        ----------
+        output_name : str
+            Key of the result.
+        as_key : bool
+            If True, return result as key.
+        as_dict : bool
+            If True, return result as dictionary.
+
+        Returns
+        -------
+        Entity | dict | str | None
+            Result.
+        """
+        return self.outputs(as_key=as_key, as_dict=as_dict).get(output_name)
+
+    def outputs(
+        self,
+        as_key: bool = False,
+        as_dict: bool = False,
+    ) -> MaterialEntity | dict | str | None:
+        """
+        Get run's outputs.
+
+        Parameters
+        ----------
+        as_key : bool
+            If True, return results as keys.
+        as_dict : bool
+            If True, return results as dictionaries.
+
+        Returns
+        -------
+        dict
+            List of output objects.
+        """
+        outputs = {}
+        if self.status.outputs is None:
+            return outputs
+
+        for parameter, key in self.status.outputs.items():
+            entity_type = get_entity_type_from_key(key)
+            entity = get_getter_for_material(entity_type)(key)
+            if as_key:
+                entity = entity.key
+            if as_dict:
+                entity = entity.to_dict()
+            outputs[parameter] = entity
+
+        return outputs
+
+    def result(self, result_name: str) -> Any:
+        """
+        Get result by name.
+
+        Parameters
+        ----------
+        result_name : str
+            Name of the result.
+
+        Returns
+        -------
+        Any
+            The result.
+        """
+        return self.results().get(result_name)
+
+    def results(self) -> dict:
+        """
+        Get results.
+
+        Returns
+        -------
+        dict
+            The results.
+        """
+        if self.status.results is None:
+            return {}
+        return self.status.results
+
+    def invoke(
+        self,
+        method: str = "POST",
+        url: str | None = None,
+        **kwargs,
+    ) -> requests.Response:
+        """
+        Invoke run.
+
+        Parameters
+        ----------
+        method : str
+            Method of the request.
+        url : str
+            URL of the request.
+        **kwargs : dict
+            Keyword arguments to pass to the request.
+
+        Returns
+        -------
+        requests.Response
+            Response from service.
+        """
+        if self._context().local:
+            raise EntityError("Invoke not supported locally.")
+        if url is None:
+            try:
+                url = f"http://{self.status.service.get('url')}"
+            except AttributeError:
+                msg = "Url not specified and service not found on run status. If a service is deploying, use run.wait() or try again later."
+                raise EntityError(msg)
+        return requests.request(method=method, url=url, **kwargs)

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/run/python_run/spec.py

@@ -0,0 +1,90 @@
+from __future__ import annotations
+
+from digitalhub.entities.run._base.spec import RunSpec, RunValidator
+
+
+class RunSpecPythonRun(RunSpec):
+    """RunSpecPythonRun specifications."""
+
+    def __init__(
+        self,
+        task: str,
+        local_execution: bool = False,
+        function: str | None = None,
+        node_selector: dict | None = None,
+        volumes: list | None = None,
+        resources: dict | None = None,
+        affinity: dict | None = None,
+        tolerations: list | None = None,
+        envs: list | None = None,
+        secrets: list | None = None,
+        profile: str | None = None,
+        source: dict | None = None,
+        image: str | None = None,
+        base_image: str | None = None,
+        python_version: str | None = None,
+        requirements: list | None = None,
+        backoff_limit: int | None = None,
+        schedule: str | None = None,
+        service_type: str | None = None,
+        replicas: int | None = None,
+        instructions: dict | None = None,
+        inputs: dict | None = None,
+        outputs: dict | None = None,
+        parameters: dict | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(
+            task,
+            local_execution,
+            function,
+            node_selector,
+            volumes,
+            resources,
+            affinity,
+            tolerations,
+            envs,
+            secrets,
+            profile,
+            **kwargs,
+        )
+        self.source = source
+        self.image = image
+        self.base_image = base_image
+        self.python_version = python_version
+        self.requirements = requirements
+        self.backoff_limit = backoff_limit
+        self.schedule = schedule
+        self.service_type = service_type
+        self.replicas = replicas
+        self.instructions = instructions
+        self.inputs = inputs
+        self.outputs = outputs
+        self.parameters = parameters
+
+
+class RunValidatorPythonRun(RunValidator):
+    """RunValidatorPythonRun validator."""
+
+    # Function parameters
+    source: dict = None
+    image: str = None
+    base_image: str = None
+    python_version: str = None
+    requirements: list = None
+
+    # Task job
+    backoff_limit: int = None
+    schedule: str = None
+
+    # Task serve
+    service_type: str = None
+    replicas: int = None
+
+    # Task build
+    instructions: list[str] = None
+
+    # Run parameters
+    inputs: dict = None
+    outputs: dict = None
+    parameters: dict = None

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/run/python_run/status.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from digitalhub.entities.run._base.status import RunStatus
+
+
+class RunStatusPythonRun(RunStatus):
+    """
+    RunStatusPythonRun status.
+    """
+
+    def __init__(
+        self,
+        state: str,
+        message: str | None = None,
+        transitions: list[dict] | None = None,
+        k8s: dict | None = None,
+        outputs: dict | None = None,
+        results: dict | None = None,
+        service: dict | None = None,
+        **kwargs,
+    ) -> None:
+        super().__init__(state, message, transitions, k8s, **kwargs)
+        self.outputs = outputs
+        self.results = results
+        self.service = service

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/run/python_run/utils.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from typing import Callable
+
+from digitalhub.entities.artifact.crud import get_artifact
+from digitalhub.entities.dataitem.crud import get_dataitem
+from digitalhub.entities.model.crud import get_model
+from digitalhub.entities.utils.entity_types import EntityTypes
+
+
+def get_getter_for_material(entity_type: str) -> Callable:
+    """
+    Return appropriate getter function.
+
+    Parameters
+    ----------
+    entity_type : str
+        The entity type.
+
+    Returns
+    -------
+    Callable
+        The getter function.
+    """
+    if entity_type == EntityTypes.ARTIFACT.value:
+        return get_artifact
+
+    if entity_type == EntityTypes.DATAITEM.value:
+        return get_dataitem
+
+    if entity_type == EntityTypes.MODEL.value:
+        return get_model
+
+    raise ValueError(f"Unhandled entity type: {entity_type}")

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/task/python_build/builder.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from digitalhub_runtime_python.entities._base.runtime_entity.builder import RuntimeEntityBuilderPython
+from digitalhub_runtime_python.entities.task.python_build.entity import TaskPythonBuild
+from digitalhub_runtime_python.entities.task.python_build.spec import TaskSpecPythonBuild, TaskValidatorPythonBuild
+from digitalhub_runtime_python.entities.task.python_build.status import TaskStatusPythonBuild
+
+from digitalhub.entities.task._base.builder import TaskBuilder
+
+
+class TaskPythonBuildBuilder(TaskBuilder, RuntimeEntityBuilderPython):
+    """
+    TaskPythonBuild builder.
+    """
+
+    ENTITY_CLASS = TaskPythonBuild
+    ENTITY_SPEC_CLASS = TaskSpecPythonBuild
+    ENTITY_SPEC_VALIDATOR = TaskValidatorPythonBuild
+    ENTITY_STATUS_CLASS = TaskStatusPythonBuild
+    ENTITY_KIND = "python+build"

digitalhub_runtime_python-0.8.0/digitalhub_runtime_python/entities/task/python_build/entity.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities.task._base.entity import Task
+
+if typing.TYPE_CHECKING:
+    from digitalhub_runtime_python.entities.task.python_build.spec import TaskSpecPythonBuild
+    from digitalhub_runtime_python.entities.task.python_build.status import TaskStatusPythonBuild
+
+    from digitalhub.entities._base.entity.metadata import Metadata
+
+
+class TaskPythonBuild(Task):
+    """
+    TaskPythonBuild class.
+    """
+
+    def __init__(
+        self,
+        project: str,
+        uuid: str,
+        kind: str,
+        metadata: Metadata,
+        spec: TaskSpecPythonBuild,
+        status: TaskStatusPythonBuild,
+        user: str | None = None,
+    ) -> None:
+        super().__init__(project, uuid, kind, metadata, spec, status, user)
+
+        self.spec: TaskSpecPythonBuild
+        self.status: TaskStatusPythonBuild