digitalhub 0.10.0b2__py3-none-any.whl → 0.10.0b4__py3-none-any.whl

digitalhub/entities/project/_base/spec.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 
 
@@ -31,20 +33,20 @@ class ProjectValidator(SpecValidator):
     ProjectValidator validator.
     """
 
-    context: str = None
+    context: Optional[str] = None
     """The project's context."""
 
-    functions: list = None
+    functions: Optional[list] = None
     """List of project's functions."""
 
-    artifacts: list = None
+    artifacts: Optional[list] = None
     """List of project's artifacts."""
 
-    workflows: list = None
+    workflows: Optional[list] = None
     """List of project's workflows."""
 
-    dataitems: list = None
+    dataitems: Optional[list] = None
     """List of project's dataitems."""
 
-    models: list = None
+    models: Optional[list] = None
     """List of project's models."""

digitalhub/entities/project/crud.py

@@ -272,7 +272,7 @@ def update_project(entity: Project, **kwargs) -> Project:
         entity_type=entity.ENTITY_TYPE,
         entity_name=entity.name,
         entity_dict=entity.to_dict(),
-        local=entity.local,
+        local=entity._client.is_local(),
         **kwargs,
     )
 
@@ -283,7 +283,7 @@ def delete_project(
     clean_context: bool = True,
     local: bool = False,
     **kwargs,
-) -> list[dict]:
+) -> dict:
     """
     Delete a project.
 

digitalhub/entities/run/_base/spec.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 from digitalhub.entities.task._base.models import K8s
 
@@ -47,8 +49,8 @@ class RunValidator(SpecValidator, K8s):
     """
 
     # Task parameters
-    function: str = None
-    workflow: str = None
+    function: Optional[str] = None
+    workflow: Optional[str] = None
 
     # Run parameters
     task: str

digitalhub/entities/secret/_base/spec.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Optional
+
 from digitalhub.entities._base.entity.spec import Spec, SpecValidator
 
 
@@ -28,8 +30,8 @@ class SecretValidator(SpecValidator):
     SecretValidator validator.
     """
 
-    path: str = None
+    path: Optional[str] = None
     """Path to the secret."""
 
-    provider: str = None
+    provider: Optional[str] = None
     """Provider of the secret."""

digitalhub/entities/secret/crud.py

@@ -108,6 +108,8 @@ def get_secret(
     >>>                  entity_id="my-secret-id")
     """
     if not identifier.startswith("store://"):
+        if project is None:
+            raise ValueError("Project must be provided.")
         secrets = list_secrets(project=project, **kwargs)
         for secret in secrets:
             if secret.name == identifier:

digitalhub/entities/task/_base/models.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
@@ -30,7 +31,7 @@ class Volume(BaseModel):
     mount_path: str
     """Volume mount path inside the container."""
 
-    spec: dict[str, str] = None
+    spec: Optional[dict[str, str]] = None
     """Volume spec."""
 
 
@@ -63,13 +64,13 @@ class Resource(BaseModel):
     Resource model.
     """
 
-    cpu: ResourceItem = None
+    cpu: Optional[ResourceItem] = None
     """CPU resource model."""
 
-    mem: ResourceItem = None
+    mem: Optional[ResourceItem] = None
     """Memory resource model."""
 
-    gpu: ResourceItem = None
+    gpu: Optional[ResourceItem] = None
     """GPU resource model."""
 
 
@@ -90,31 +91,31 @@ class Toleration(BaseModel):
     Toleration model.
     """
 
-    key: str = None
+    key: Optional[str] = None
     """Toleration key."""
 
-    operator: str = None
+    operator: Optional[str] = None
     """Toleration operator."""
 
-    value: str = None
+    value: Optional[str] = None
     """Toleration value."""
 
-    effect: str = None
+    effect: Optional[str] = None
     """Toleration effect."""
 
-    toleration_seconds: int = None
+    toleration_seconds: Optional[int] = None
     """Toleration seconds."""
 
 
 class V1NodeSelectorRequirement(BaseModel):
     key: str
     operator: str
-    values: list[str] = None
+    values: Optional[list[str]] = None
 
 
 class V1NodeSelectorTerm(BaseModel):
-    match_expressions: list[V1NodeSelectorRequirement] = None
-    match_fields: list[V1NodeSelectorRequirement] = None
+    match_expressions: Optional[list[V1NodeSelectorRequirement]] = None
+    match_fields: Optional[list[V1NodeSelectorRequirement]] = None
 
 
 class V1NodeSelector(BaseModel):
@@ -129,21 +130,21 @@ class V1PreferredSchedulingTerm(BaseModel):
 class V1LabelSelectorRequirement(BaseModel):
     key: str
     operator: str
-    values: list[str] = None
+    values: Optional[list[str]] = None
 
 
 class V1LabelSelector(BaseModel):
-    match_expressions: list[V1LabelSelectorRequirement] = None
-    match_labels: dict[str, str] = None
+    match_expressions: Optional[list[V1LabelSelectorRequirement]] = None
+    match_labels: Optional[dict[str, str]] = None
 
 
 class V1PodAffinityTerm(BaseModel):
-    label_selector: V1LabelSelector = None
-    match_label_keys: list[str] = None
-    mismatch_label_keys: list[str] = None
-    namespace_selector: V1LabelSelector = None
-    namespaces: list[str] = None
-    topology_key: str
+    label_selector: Optional[V1LabelSelector] = None
+    match_label_keys: Optional[list[str]] = None
+    mismatch_label_keys: Optional[list[str]] = None
+    namespace_selector: Optional[V1LabelSelector] = None
+    namespaces: Optional[list[str]] = None
+    topology_key: Optional[str] = None
 
 
 class V1WeightedPodAffinityTerm(BaseModel):
@@ -152,18 +153,18 @@ class V1WeightedPodAffinityTerm(BaseModel):
 
 
 class V1NodeAffinity(BaseModel):
-    preferred_during_scheduling_ignored_during_execution: list[V1PreferredSchedulingTerm] = None
-    required_during_scheduling_ignored_during_execution: V1NodeSelector = None
+    preferred_during_scheduling_ignored_during_execution: Optional[list[V1PreferredSchedulingTerm]] = None
+    required_during_scheduling_ignored_during_execution: Optional[V1NodeSelector] = None
 
 
 class V1PodAffinity(BaseModel):
-    preferred_during_scheduling_ignored_during_execution: list[V1WeightedPodAffinityTerm] = None
-    required_during_scheduling_ignored_during_execution: list[V1PodAffinityTerm] = None
+    preferred_during_scheduling_ignored_during_execution: Optional[list[V1WeightedPodAffinityTerm]] = None
+    required_during_scheduling_ignored_during_execution: Optional[list[V1PodAffinityTerm]] = None
 
 
 class V1PodAntiAffinity(BaseModel):
-    preferred_during_scheduling_ignored_during_execution: list[V1WeightedPodAffinityTerm] = None
-    required_during_scheduling_ignored_during_execution: list[V1PodAffinityTerm] = None
+    preferred_during_scheduling_ignored_during_execution: Optional[list[V1WeightedPodAffinityTerm]] = None
+    required_during_scheduling_ignored_during_execution: Optional[list[V1PodAffinityTerm]] = None
 
 
 class Affinity(BaseModel):
@@ -171,13 +172,13 @@ class Affinity(BaseModel):
     Affinity model.
     """
 
-    node_affinity: V1NodeAffinity = None
+    node_affinity: Optional[V1NodeAffinity] = None
     """Node affinity."""
 
-    pod_affinity: V1PodAffinity = None
+    pod_affinity: Optional[V1PodAffinity] = None
     """Pod affinity."""
 
-    pod_anti_affinity: V1PodAntiAffinity = None
+    pod_anti_affinity: Optional[V1PodAntiAffinity] = None
     """Pod anti affinity."""
 
 
@@ -186,34 +187,34 @@ class K8s(BaseModel):
     Kubernetes resource model.
     """
 
-    node_selector: list[NodeSelector] = None
+    node_selector: Optional[list[NodeSelector]] = None
     """Node selector."""
 
-    volumes: list[Volume] = None
+    volumes: Optional[list[Volume]] = None
     """List of volumes."""
 
-    resources: Resource = None
+    resources: Optional[Resource] = None
     """Resources restrictions."""
 
-    affinity: Affinity = None
+    affinity: Optional[Affinity] = None
     """Affinity."""
 
-    tolerations: list[Toleration] = None
+    tolerations: Optional[list[Toleration]] = None
     """Tolerations."""
 
-    envs: list[Env] = None
+    envs: Optional[list[Env]] = None
     """Env variables."""
 
-    secrets: list[str] = None
+    secrets: Optional[list[str]] = None
     """List of secret names."""
 
-    profile: str = None
+    profile: Optional[str] = None
     """Profile template."""
 
-    runtime_class: str = None
+    runtime_class: Optional[str] = None
     """Runtime class name."""
 
-    priority_class: str = None
+    priority_class: Optional[str] = None
     """Priority class."""
 
 

digitalhub/entities/task/_base/utils.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 
-def build_task_actions(kind_action_list: list[tuple[str, str]]) -> dict[str, str]:
+def build_task_actions(kind_action_list: list[tuple[str, str]]) -> list[dict[str, str]]:
     """
     Build task actions.
 
@@ -12,7 +12,7 @@ def build_task_actions(kind_action_list: list[tuple[str, str]]) -> dict[str, str
 
     Returns
     -------
-    dict[str, str]
+    list[dict[str, str]]
         Returns the task actions.
     """
     return [{"kind": kind, "action": action} for (kind, action) in kind_action_list]

digitalhub/stores/_base/store.py

@@ -8,6 +8,7 @@ from typing import Any
 
 from digitalhub.readers.data.api import get_reader_by_engine
 from digitalhub.utils.exceptions import StoreError
+from digitalhub.utils.types import SourcesOrListOfSources
 from digitalhub.utils.uri_utils import has_local_scheme
 
 if typing.TYPE_CHECKING:
@@ -36,7 +37,7 @@ class Store:
         """
 
     @abstractmethod
-    def upload(self, src: str | list[str], dst: str) -> list[tuple[str, str]]:
+    def upload(self, src: SourcesOrListOfSources, dst: str) -> list[tuple[str, str]]:
         """
         Method to upload artifact to storage.
         """
@@ -58,8 +59,8 @@ class Store:
     @abstractmethod
     def read_df(
         self,
-        path: str | list[str],
-        extension: str,
+        path: SourcesOrListOfSources,
+        file_format: str | None = None,
         engine: str | None = None,
         **kwargs,
     ) -> Any:
@@ -159,7 +160,7 @@ class Store:
 
         Parameters
         ----------
-        path : str
+        path : str | Path
             The path to build.
 
         Returns

digitalhub/stores/local/store.py

@@ -8,6 +8,7 @@ from digitalhub.readers.data.api import get_reader_by_object
 from digitalhub.stores._base.store import Store
 from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.file_utils import get_file_info_from_local
+from digitalhub.utils.types import SourcesOrListOfSources
 
 
 class LocalStore(Store):
@@ -51,7 +52,7 @@ class LocalStore(Store):
         """
         raise StoreError("Local store does not support download.")
 
-    def upload(self, src: str | list[str], dst: str) -> list[tuple[str, str]]:
+    def upload(self, src: SourcesOrListOfSources, dst: str) -> list[tuple[str, str]]:
         """
         Upload an artifact to storage.
 
@@ -88,7 +89,7 @@ class LocalStore(Store):
 
     def read_df(
         self,
-        path: str | list[str],
+        path: SourcesOrListOfSources,
         file_format: str | None = None,
         engine: str | None = None,
         **kwargs,
@@ -98,7 +99,7 @@ class LocalStore(Store):
 
         Parameters
         ----------
-        path : str | list[str]
+        path : SourcesOrListOfSources
             Path(s) to read DataFrame from.
         file_format : str
             Extension of the file.

digitalhub/stores/remote/store.py

@@ -7,6 +7,7 @@ import requests
 
 from digitalhub.stores._base.store import Store
 from digitalhub.utils.exceptions import StoreError
+from digitalhub.utils.types import SourcesOrListOfSources
 
 
 class RemoteStore(Store):
@@ -62,7 +63,7 @@ class RemoteStore(Store):
 
         return self._download_file(root, dst, overwrite)
 
-    def upload(self, src: str | list[str], dst: str) -> list[tuple[str, str]]:
+    def upload(self, src: SourcesOrListOfSources, dst: str) -> list[tuple[str, str]]:
         """
         Upload an artifact to storage.
 
@@ -99,7 +100,7 @@ class RemoteStore(Store):
 
     def read_df(
         self,
-        path: str | list[str],
+        path: SourcesOrListOfSources,
         file_format: str | None = None,
         engine: str | None = None,
         **kwargs,
@@ -109,7 +110,7 @@ class RemoteStore(Store):
 
         Parameters
         ----------
-        path : str | list[str]
+        path : SourcesOrListOfSources
             Path(s) to read DataFrame from.
         file_format : str
             Extension of the file.

digitalhub/stores/s3/store.py

@@ -16,6 +16,7 @@ from digitalhub.stores.s3.configurator import S3StoreConfigurator
 from digitalhub.stores.s3.utils import get_bucket_name
 from digitalhub.utils.exceptions import StoreError
 from digitalhub.utils.file_utils import get_file_info_from_s3, get_file_mime_type
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     pass
@@ -117,7 +118,7 @@ class S3Store(Store):
 
     def upload(
         self,
-        src: str | list[str],
+        src: SourcesOrListOfSources,
         dst: str,
     ) -> list[tuple[str, str]]:
         """
@@ -125,7 +126,7 @@ class S3Store(Store):
 
         Parameters
         ----------
-        src : str | list[str]
+        src : SourcesOrListOfSources
             Source(s).
         dst : str
             The destination of the artifact on storage.
@@ -238,7 +239,7 @@ class S3Store(Store):
 
     def read_df(
         self,
-        path: str | list[str],
+        path: SourcesOrListOfSources,
         file_format: str | None = None,
         engine: str | None = None,
         **kwargs,
@@ -248,7 +249,7 @@ class S3Store(Store):
 
         Parameters
         ----------
-        path : str | list[str]
+        path : SourcesOrListOfSources
             Path(s) to read DataFrame from.
         file_format : str
             Extension of the file.

digitalhub/stores/sql/configurator.py

@@ -38,7 +38,7 @@ class SqlStoreConfigurator:
         else:
             config: SqlStoreConfig = SqlStoreConfig(**config)
             for pair in [
-                (SqlStoreEnv.USER.value, config.user),
+                (SqlStoreEnv.USERNAME.value, config.user),
                 (SqlStoreEnv.PASSWORD.value, config.password),
                 (SqlStoreEnv.HOST.value, config.host),
                 (SqlStoreEnv.PORT.value, config.port),
@@ -57,7 +57,7 @@ class SqlStoreConfigurator:
         """
         creds = configurator.get_all_cred()
         try:
-            user = creds[SqlStoreEnv.USER.value]
+            user = creds[SqlStoreEnv.USERNAME.value]
             password = creds[SqlStoreEnv.PASSWORD.value]
             host = creds[SqlStoreEnv.HOST.value]
             port = creds[SqlStoreEnv.PORT.value]
@@ -74,14 +74,14 @@ class SqlStoreConfigurator:
         -------
         None
         """
-        user = configurator.load_var(SqlStoreEnv.USER.value)
+        user = configurator.load_var(SqlStoreEnv.USERNAME.value)
         password = configurator.load_var(SqlStoreEnv.PASSWORD.value)
         host = configurator.load_var(SqlStoreEnv.HOST.value)
         port = configurator.load_var(SqlStoreEnv.PORT.value)
         database = configurator.load_var(SqlStoreEnv.DATABASE.value)
         if user is None or password is None or host is None or port is None or database is None:
             raise StoreError("Missing credentials for SQL store.")
-        configurator.set_credential(SqlStoreEnv.USER.value, user)
+        configurator.set_credential(SqlStoreEnv.USERNAME.value, user)
         configurator.set_credential(SqlStoreEnv.PASSWORD.value, password)
         configurator.set_credential(SqlStoreEnv.HOST.value, host)
         configurator.set_credential(SqlStoreEnv.PORT.value, port)

digitalhub/stores/sql/enums.py

@@ -10,7 +10,7 @@ class SqlStoreEnv(Enum):
 
     HOST = "DB_HOST"
     PORT = "DB_PORT"
-    USER = "DB_USER"
+    USERNAME = "DB_USERNAME"
     PASSWORD = "DB_PASSWORD"
     DATABASE = "DB_DATABASE"
     PG_SCHEMA = "DB_SCHEMA"

digitalhub/stores/sql/store.py

@@ -14,6 +14,7 @@ from digitalhub.readers.data.api import get_reader_by_object
 from digitalhub.stores._base.store import Store
 from digitalhub.stores.sql.configurator import SqlStoreConfigurator
 from digitalhub.utils.exceptions import StoreError
+from digitalhub.utils.types import SourcesOrListOfSources
 
 if typing.TYPE_CHECKING:
     from sqlalchemy.engine.row import Row
@@ -85,7 +86,7 @@ class SqlStore(Store):
 
     def upload(
         self,
-        src: str | list[str],
+        src: SourcesOrListOfSources,
         dst: str,
     ) -> list[tuple[str, str]]:
         """
@@ -124,7 +125,7 @@ class SqlStore(Store):
 
     def read_df(
         self,
-        path: str | list[str],
+        path: SourcesOrListOfSources,
         file_format: str | None = None,
         engine: str | None = None,
         **kwargs,
@@ -134,7 +135,7 @@ class SqlStore(Store):
 
         Parameters
         ----------
-        path : str | list[str]
+        path : SourcesOrListOfSources
             Path(s) to read DataFrame from.
         file_format : str
             Extension of the file.
@@ -148,6 +149,9 @@ class SqlStore(Store):
         Any
             DataFrame.
         """
+        if isinstance(path, list):
+            raise StoreError("SQL store can only read a single DataFrame at a time.")
+
         reader = self._get_reader(engine)
         schema = self._get_schema(path)
         table = self._get_table_name(path)

digitalhub/utils/file_utils.py

@@ -4,6 +4,7 @@ from datetime import datetime
 from hashlib import sha256
 from mimetypes import guess_type
 from pathlib import Path
+from typing import Optional
 
 from pydantic import BaseModel
 
@@ -13,12 +14,12 @@ class FileInfo(BaseModel):
     File info class.
     """
 
-    path: str = None
-    name: str = None
-    content_type: str = None
-    size: int = None
-    hash: str = None
-    last_modified: str = None
+    path: Optional[str] = None
+    name: Optional[str] = None
+    content_type: Optional[str] = None
+    size: Optional[int] = None
+    hash: Optional[str] = None
+    last_modified: Optional[str] = None
 
     def to_dict(self):
         return self.model_dump()
@@ -60,7 +61,7 @@ def get_file_size(data_path: str) -> int:
     return Path(data_path).stat().st_size
 
 
-def get_file_mime_type(data_path: str) -> str:
+def get_file_mime_type(data_path: str) -> str | None:
     """
     Get the mime type of a file.
 

digitalhub/utils/generic_utils.py

@@ -4,8 +4,9 @@ import base64
 import importlib.util as imputil
 import json
 from datetime import date, datetime, time
-from enum import Enum
+from enum import Enum, EnumMeta
 from pathlib import Path
+from types import MappingProxyType
 from typing import Any, Callable
 from zipfile import ZipFile
 
@@ -166,7 +167,7 @@ def dump_json(struct: Any) -> str:
     str
         The json string.
     """
-    return json.dumps(struct, cls=CustomJsonEncoder).encode("utf-8")
+    return json.dumps(struct, cls=CustomJsonEncoder)
 
 
 def slugify_string(filename: str) -> str:
@@ -203,23 +204,34 @@ def import_function(path: Path, handler: str) -> Callable:
         Function.
     """
     spec = imputil.spec_from_file_location(path.stem, path)
+    if spec is None:
+        raise RuntimeError(f"Error loading function source from {str(path)}.")
+
     mod = imputil.module_from_spec(spec)
+    if spec.loader is None:
+        raise RuntimeError(f"Error getting module loader from {str(path)}.")
+
     spec.loader.exec_module(mod)
-    return getattr(mod, handler)
+    func = getattr(mod, handler)
+    if not callable(func):
+        raise RuntimeError(f"Handler '{handler}' is not a callable.")
+
+    return func
 
 
-def list_enum(enum: Enum) -> list:
+def list_enum(enum: EnumMeta) -> list[Any]:
     """
     Get all values of an enum.
 
     Parameters
     ----------
-    enum : Enum
-        Enum to get values from.
+    enum : EnumMeta
+        Enum class to get values from.
 
     Returns
     -------
-    list
+    list[Any]
         List of enum values.
     """
-    return [e.value for e in enum]
+    vals: MappingProxyType[str, Enum] = enum.__members__
+    return [member.value for member in vals.values()]

digitalhub/utils/types.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from typing import Union
+
+MetricType = Union[float, int, list[Union[float, int]]]
+SourcesOrListOfSources = Union[str, list[str]]

digitalhub/utils/uri_utils.py

@@ -93,7 +93,7 @@ def map_uri_scheme(uri: str) -> str:
     Raises
     ------
     ValueError
-        If the scheme is unknown.
+        If the scheme is unknown or invalid.
     """
     scheme = urlparse(uri).scheme
     if scheme in list_enum(LocalSchemes):