digitalhub 0.8.0b2__py3-none-any.whl → 0.8.0b3__py3-none-any.whl

digitalhub/__init__.py

@@ -68,13 +68,13 @@ from digitalhub.entities.workflow.crud import (
 )
 
 try:
-    from digitalhub.entities.model.entity.mlflow import from_mlflow_run
+    from digitalhub.entities.model.mlflow.utils import from_mlflow_run
 except ImportError:
     ...
 
+from digitalhub.client.dhcore.utils import refresh_token, set_dhcore_env
 from digitalhub.registry.utils import register_entities, register_runtimes_entities
 from digitalhub.stores.builder import set_store
-from digitalhub.utils.env_utils import refresh_token, set_dhcore_env
 
 # Register entities into registry
 register_entities()

digitalhub/client/builder.py

@@ -2,11 +2,11 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.client.objects.dhcore import ClientDHCore
-from digitalhub.client.objects.local import ClientLocal
+from digitalhub.client.dhcore.client import ClientDHCore
+from digitalhub.client.local.client import ClientLocal
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.objects.base import Client
+    from digitalhub.client._base.client import Client
 
 
 class ClientBuilder:

digitalhub/client/{objects/dhcore.py → dhcore/client.py}

@@ -5,11 +5,12 @@ import typing
 from urllib.parse import urlparse
 
 from dotenv import load_dotenv, set_key
-from pydantic import BaseModel
 from requests import request
 from requests.exceptions import HTTPError, JSONDecodeError, RequestException
 
-from digitalhub.client.objects.base import Client
+from digitalhub.client._base.client import Client
+from digitalhub.client.dhcore.env import ENV_FILE, FALLBACK_USER, MAX_API_LEVEL, MIN_API_LEVEL
+from digitalhub.client.dhcore.models import BasicAuth, OAuth2TokenAuth
 from digitalhub.utils.exceptions import (
     BackendError,
     BadRequestError,
@@ -24,52 +25,6 @@ if typing.TYPE_CHECKING:
     from requests import Response
 
 
-# Use env user as fallback in the API calls
-try:
-    FALLBACK_USER = os.getlogin()
-except Exception:
-    FALLBACK_USER = None
-
-# File where to write DHCORE_ACCESS_TOKEN and DHCORE_REFRESH_TOKEN
-# It's used because we inject the variables in jupyter env,
-# but refresh token is only available once. Is it's used, we cannot
-# overwrite it with coder, so we need to store the new one in a file,
-# preserved for jupyter restart
-ENV_FILE = ".dhcore"
-
-
-# API levels that are supported
-MAX_API_LEVEL = 20
-MIN_API_LEVEL = 8
-
-
-class AuthConfig(BaseModel):
-    """Client configuration model."""
-
-    user: str = FALLBACK_USER
-    """Username."""
-
-
-class OAuth2TokenAuth(AuthConfig):
-    """OAuth2 token authentication model."""
-
-    access_token: str
-    """OAuth2 token."""
-
-    refresh_token: str = None
-    """OAuth2 refresh token."""
-
-    client_id: str = None
-    """OAuth2 client id."""
-
-
-class BasicAuth(AuthConfig):
-    """Basic authentication model."""
-
-    password: str
-    """Basic authentication password."""
-
-
 class ClientDHCore(Client):
     """
     DHCore client.

digitalhub/client/dhcore/env.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+import os
+
+# Use env user as fallback in the API calls
+try:
+    FALLBACK_USER = os.getlogin()
+except Exception:
+    FALLBACK_USER = None
+
+# File where to write DHCORE_ACCESS_TOKEN and DHCORE_REFRESH_TOKEN
+# It's used because we inject the variables in jupyter env,
+# but refresh token is only available once. Is it's used, we cannot
+# overwrite it with coder, so we need to store the new one in a file,
+# preserved for jupyter restart
+ENV_FILE = ".dhcore"
+
+
+# API levels that are supported
+MAX_API_LEVEL = 20
+MIN_API_LEVEL = 8

digitalhub/client/dhcore/models.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+from digitalhub.client.dhcore.env import FALLBACK_USER
+
+
+class AuthConfig(BaseModel):
+    """Client configuration model."""
+
+    user: str = FALLBACK_USER
+    """Username."""
+
+
+class BasicAuth(AuthConfig):
+    """Basic authentication model."""
+
+    password: str
+    """Basic authentication password."""
+
+
+class ClientParams(AuthConfig):
+    """Client id authentication model."""
+
+    client_id: str = None
+    """OAuth2 client id."""
+
+    client_scecret: str = None
+    """OAuth2 client secret."""
+
+
+class OAuth2TokenAuth(ClientParams):
+    """OAuth2 token authentication model."""
+
+    access_token: str
+    """OAuth2 token."""
+
+    refresh_token: str = None
+    """OAuth2 refresh token."""
+
+
+class TokenExchangeAuth(ClientParams):
+    """Token exchange authentication model."""
+
+    exchange_token: str
+    """Exchange token."""

digitalhub/{utils/env_utils.py → client/dhcore/utils.py}

@@ -6,7 +6,7 @@ import typing
 from digitalhub.client.builder import check_client_exists, get_client
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.objects.dhcore import ClientDHCore
+    from digitalhub.client.dhcore.client import ClientDHCore
 
 
 def set_dhcore_env(
@@ -109,15 +109,3 @@ def refresh_token() -> None:
     """
     client: ClientDHCore = get_client(local=False)
     client._get_new_access_token()
-
-
-def get_s3_bucket() -> str | None:
-    """
-    Function to get S3 bucket name.
-
-    Returns
-    -------
-    str
-        The S3 bucket name.
-    """
-    return os.getenv("S3_BUCKET_NAME", "datalake")

digitalhub/client/{objects/local.py → local/client.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 from copy import deepcopy
 from datetime import datetime, timezone
 
-from digitalhub.client.objects.base import Client
+from digitalhub.client._base.client import Client
 from digitalhub.utils.exceptions import BackendError
 
 

digitalhub/context/builder.py

@@ -5,7 +5,7 @@ import typing
 from digitalhub.context.context import Context
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project.entity._base import Project
+    from digitalhub.entities.project.project.entity import Project
 
 
 class ContextBuilder:

digitalhub/context/context.py

@@ -4,7 +4,7 @@ import typing
 from pathlib import Path
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities.project.entity._base import Project
+    from digitalhub.entities.project.project.entity import Project
 
 
 class Context:

digitalhub/datastores/{objects/base.py → _base/datastore.py}

@@ -7,7 +7,7 @@ from typing import Any
 from digitalhub.readers.builder import get_reader_by_engine
 
 if typing.TYPE_CHECKING:
-    from digitalhub.stores.objects.base import Store
+    from digitalhub.stores._base.store import Store
 
 
 class Datastore(metaclass=ABCMeta):

digitalhub/datastores/builder.py

@@ -2,16 +2,16 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.datastores.objects.local import LocalDatastore
-from digitalhub.datastores.objects.remote import RemoteDatastore
-from digitalhub.datastores.objects.s3 import S3Datastore
-from digitalhub.datastores.objects.sql import SqlDatastore
+from digitalhub.datastores.local.datastore import LocalDatastore
+from digitalhub.datastores.remote.datastore import RemoteDatastore
+from digitalhub.datastores.s3.datastore import S3Datastore
+from digitalhub.datastores.sql.datastore import SqlDatastore
 from digitalhub.stores.builder import get_default_store, get_store
 from digitalhub.utils.uri_utils import map_uri_scheme
 
 if typing.TYPE_CHECKING:
-    from digitalhub.datastores.objects.base import Datastore
-    from digitalhub.stores.objects.base import Store
+    from digitalhub.datastores._base.datastore import Datastore
+    from digitalhub.stores._base.store import Store
 
 
 REGISTRY_DATASTORES = {"local": LocalDatastore, "remote": RemoteDatastore, "s3": S3Datastore, "sql": SqlDatastore}

digitalhub/datastores/{objects/local.py → local/datastore.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 from pathlib import Path
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 from digitalhub.readers.builder import get_reader_by_object
 
 

digitalhub/datastores/{objects/remote.py → remote/datastore.py}

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 
 
 class RemoteDatastore(Datastore):

digitalhub/datastores/{objects/s3.py → s3/datastore.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 from io import BytesIO
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 from digitalhub.readers.builder import get_reader_by_object
 
 

digitalhub/datastores/{objects/sql.py → sql/datastore.py}

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import Any
 
-from digitalhub.datastores.objects.base import Datastore
+from digitalhub.datastores._base.datastore import Datastore
 from digitalhub.readers.builder import get_reader_by_object
 
 

digitalhub/entities/_base/{base.py → _base/entity.py}

@@ -3,7 +3,7 @@ from __future__ import annotations
 from digitalhub.utils.generic_utils import dict_to_json
 
 
-class ModelObj:
+class Base:
     """
     Base class for all entities.
     It implements to_dict abd to_json method to represent

digitalhub/entities/_base/{entity/context.py → context/entity.py}

@@ -4,14 +4,14 @@ import typing
 
 from digitalhub.context.builder import get_context
 from digitalhub.entities._base.crud import create_entity_api_ctx, read_entity_api_ctx, update_entity_api_ctx
-from digitalhub.entities._base.entity.base import Entity
+from digitalhub.entities._base.entity.entity import Entity
 from digitalhub.utils.generic_utils import get_timestamp
 
 if typing.TYPE_CHECKING:
     from digitalhub.context.context import Context
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
 
 
 class ContextEntity(Entity):

digitalhub/entities/_base/crud.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.context.builder import get_context
-from digitalhub.entities._base.api import (
+from digitalhub.entities.utils.api import (
     api_base_create,
     api_base_delete,
     api_base_list,
@@ -20,10 +20,10 @@ from digitalhub.entities._base.api import (
     api_ctx_stop,
     api_ctx_update,
 )
-from digitalhub.entities.utils import parse_entity_key
+from digitalhub.entities.utils.utils import parse_entity_key
 
 if typing.TYPE_CHECKING:
-    from digitalhub.client.objects.base import Client
+    from digitalhub.client._base.client import Client
 
 
 def create_entity_api_base(

digitalhub/entities/_base/entity/{base.py → entity.py}

@@ -3,19 +3,19 @@ from __future__ import annotations
 import typing
 from abc import ABCMeta, abstractmethod
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
 
 
-class Entity(ModelObj, metaclass=ABCMeta):
+class Entity(Base, metaclass=ABCMeta):
     """
     Abstract class for entities.
 
-    An entity is a collection of metadata, specification and status
+    An entity is a collection of metadata, specifications.and status
     representing a variety of objects handled by Digitalhub.
     """
 

digitalhub/entities/_base/{metadata.py → entity/metadata.py}

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 
-class Metadata(ModelObj):
+class Metadata(Base):
     """
     A class representing the metadata of an entity.
     Metadata is a collection of information about an entity thought

digitalhub/entities/_base/{spec/base.py → entity/spec.py}

@@ -2,46 +2,46 @@ from __future__ import annotations
 
 from pydantic import BaseModel
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 
-class Spec(ModelObj):
+class Spec(Base):
     """
-    A class representing the specification of an entity.
-    Specification is a collection of information about an entity
+    A class representing the specifications.of an entity.
+    specifications.is a collection of information about an entity
     thought to be immutable by the user.
     """
 
     @classmethod
     def from_dict(cls, obj: dict) -> Spec:
         """
-        Return entity specification object from dictionary.
+        Return entity specifications.object from dictionary.
 
         Parameters
         ----------
         obj : dict
-            A dictionary containing the attributes of the entity specification.
+            A dictionary containing the attributes of the entity specifications.
 
         Returns
         -------
         EntitySpec
-            An entity specification object.
+            An entity specifications.object.
         """
         return cls(**obj)
 
 
-class SpecParams(BaseModel, extra="ignore"):
+class SpecValidator(BaseModel, extra="ignore"):
     """
     A class representing the parameters of an entity.
     This base class is used to define the parameters of an entity
-    specification and is used to validate the parameters passed
+    specifications.and is used to validate the parameters passed
     to the constructor.
     """
 
 
 class MaterialSpec(Spec):
     """
-    Material specification class.
+    Material specifications.class.
     """
 
     def __init__(self, path: str, **kwargs) -> None:
@@ -49,7 +49,7 @@ class MaterialSpec(Spec):
         self.path = path
 
 
-class MaterialParams(SpecParams):
+class MaterialValidator(SpecValidator):
     """
     Material parameters class.
     """

digitalhub/entities/_base/{status/base.py → entity/status.py}

@@ -1,9 +1,9 @@
 from __future__ import annotations
 
-from digitalhub.entities._base.base import ModelObj
+from digitalhub.entities._base._base.entity import Base
 
 
-class Status(ModelObj):
+class Status(Base):
     """
     Base Status class.
     The status class contains information about the state of an entity,

digitalhub/entities/_base/{entity/executable.py → executable/entity.py}

@@ -3,18 +3,18 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._base.crud import list_entity_api_ctx
-from digitalhub.entities._base.entity.versioned import VersionedEntity
-from digitalhub.entities.entity_types import EntityTypes
+from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities.run.crud import delete_run, get_run, list_runs
 from digitalhub.entities.task.crud import delete_task, task_from_dict, task_from_parameters
+from digitalhub.entities.utils.entity_types import EntityTypes
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.base import Spec
-    from digitalhub.entities._base.status.base import Status
-    from digitalhub.entities.run.entity import Run
-    from digitalhub.entities.task.entity import Task
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.entity.spec import Spec
+    from digitalhub.entities._base.entity.status import Status
+    from digitalhub.entities.run._base.entity import Run
+    from digitalhub.entities.task._base.entity import Task
 
 
 class ExecutableEntity(VersionedEntity):
@@ -57,7 +57,7 @@ class ExecutableEntity(VersionedEntity):
     #  Tasks
     ##############################
 
-    def _get_or_create_task(self, kind: str, **kwargs) -> Task:
+    def _get_or_create_task(self, kind: str) -> Task:
         """
         Get or create task.
 
@@ -72,7 +72,10 @@ class ExecutableEntity(VersionedEntity):
             Task.
         """
         if self._tasks.get(kind) is None:
-            return self.new_task(kind)
+            try:
+                self._tasks[kind] = self.get_task(kind)
+            except EntityError:
+                self._tasks[kind] = self.new_task(kind)
         return self._tasks[kind]
 
     def import_tasks(self, tasks: list[dict]) -> None:
@@ -147,6 +150,34 @@ class ExecutableEntity(VersionedEntity):
         self._tasks[task_kind] = task
         return task
 
+    def get_task(self, kind: str) -> Task:
+        """
+        Get task.
+
+        Parameters
+        ----------
+        kind : str
+            Kind the object.
+
+        Returns
+        -------
+        Task
+            Task.
+
+        Raises
+        ------
+        EntityError
+            If task is not created.
+        """
+        try:
+            return self._tasks[kind]
+        except KeyError:
+            resp = self._get_task_from_backend(kind)
+            if not resp:
+                raise EntityError(f"Task {kind} is not created")
+            self._tasks[kind] = task_from_dict(resp[0])
+            return self._tasks[kind]
+
     def update_task(self, kind: str, **kwargs) -> Task:
         """
         Update task.
@@ -180,47 +211,42 @@ class ExecutableEntity(VersionedEntity):
         self._tasks[kind] = task
         return task
 
-    def get_task(self, kind: str) -> Task:
+    def delete_task(self, kind: str, cascade: bool = True) -> dict:
         """
-        Get task.
+        Delete task.
 
         Parameters
         ----------
         kind : str
             Kind the object.
+        cascade : bool
+            Flag to determine if cascade deletion must be performed.
 
         Returns
         -------
-        Task
-            Task.
-
-        Raises
-        ------
-        EntityError
-            If task is not created.
+        dict
+            Response from backend.
         """
-        self._raise_if_not_exists(kind)
-        return self._tasks[kind]
+        resp = delete_task(self._tasks[kind].key, cascade=cascade)
+        self._tasks.pop(kind, None)
+        return resp
 
-    def delete_task(self, kind: str, cascade: bool = True) -> dict:
+    def _get_task_from_backend(self, kind: str) -> list:
         """
-        Delete task.
+        List tasks from backend filtered by function and kind.
 
         Parameters
         ----------
         kind : str
             Kind the object.
-        cascade : bool
-            Flag to determine if cascade deletion must be performed.
 
         Returns
         -------
-        dict
+        list
             Response from backend.
         """
-        resp = delete_task(self._tasks[kind].key, cascade=cascade)
-        self._tasks.pop(kind, None)
-        return resp
+        params = {"function": self._get_executable_string(), "kind": kind}
+        return list_entity_api_ctx(self.project, EntityTypes.TASK.value, params=params)
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """
@@ -236,9 +262,7 @@ class ExecutableEntity(VersionedEntity):
         bool
             Flag to determine if task exists in backend.
         """
-        # List tasks from backend filtered by function and kind
-        params = {"function": self._get_executable_string(), "kind": kind}
-        resp = list_entity_api_ctx(self.project, EntityTypes.TASK.value, params=params)
+        resp = self._get_task_from_backend(kind)
         if not resp:
             return False
         return True

digitalhub/entities/_base/{entity/material.py → material/entity.py}

@@ -4,13 +4,13 @@ import typing
 from pathlib import Path
 
 from digitalhub.entities._base.crud import files_info_get_api, files_info_put_api
-from digitalhub.entities._base.entity.versioned import VersionedEntity
+from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.stores.builder import get_store
 
 if typing.TYPE_CHECKING:
-    from digitalhub.entities._base.metadata import Metadata
-    from digitalhub.entities._base.spec.material import MaterialSpec
-    from digitalhub.entities._base.status.material import MaterialStatus
+    from digitalhub.entities._base.entity.metadata import Metadata
+    from digitalhub.entities._base.material.spec import MaterialSpec
+    from digitalhub.entities._base.material.status import MaterialStatus
 
 
 class MaterialEntity(VersionedEntity):