digitalhub 0.13.4__py3-none-any.whl → 0.14.0__py3-none-any.whl

digitalhub/__init__.py

@@ -95,16 +95,11 @@ from digitalhub.entities.workflow.crud import (
     new_workflow,
     update_workflow,
 )
+from digitalhub.stores.client.dhcore.utils import refresh_token
+from digitalhub.stores.credentials.api import get_current_profile, set_current_profile
+from digitalhub.utils.store_utils import get_s3_client, get_sql_engine
 
 try:
     from digitalhub.entities.model.mlflow.utils import from_mlflow_run, get_mlflow_model_metrics
 except ImportError:
     ...
-
-# Register entities into registry
-from digitalhub.factory.utils import register_entities, register_runtimes_entities
-from digitalhub.stores.client.dhcore.utils import refresh_token, set_dhcore_env
-from digitalhub.stores.credentials.api import get_current_profile, set_current_profile
-
-register_entities()
-register_runtimes_entities()

digitalhub/context/api.py

@@ -24,7 +24,7 @@ def build_context(project: Project, overwrite: bool = False) -> Context:
     ----------
     project : Project
         The project object used to build the context.
-    overwrite : bool, optional
+    overwrite : bool
         If True, overwrites existing context if it exists. Default is False.
 
     Returns
@@ -60,9 +60,5 @@ def delete_context(project: str) -> None:
     ----------
     project : str
         Project name.
-
-    Returns
-    -------
-    None
     """
     context_builder.remove(project)

digitalhub/context/builder.py

@@ -38,7 +38,7 @@ class ContextBuilder:
         ----------
         project : Project
             The project instance to create a context for.
-        overwrite : bool, optional
+        overwrite : bool
             If True, overwrites existing context if project name already exists. Default is False.
 
         Returns
@@ -82,10 +82,6 @@ class ContextBuilder:
         ----------
         project : str
             The name of the project whose context should be removed.
-
-        Returns
-        -------
-        None
             This method does not return anything.
 
         Notes

digitalhub/context/context.py

@@ -8,8 +8,9 @@ import os
 import typing
 from pathlib import Path
 
-from digitalhub.entities._commons.enums import EntityTypes, ApiCategories, BackendOperations
+from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.runtimes.enums import RuntimeEnvVar
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
@@ -81,10 +82,6 @@ class Context:
         ----------
         run_ctx : str
             The run key to set.
-
-        Returns
-        -------
-        None
         """
         self.is_running = True
         self._run_ctx = run_ctx
@@ -92,10 +89,6 @@ class Context:
     def unset_run(self) -> None:
         """
         Clear the current run key and reset running state.
-
-        Returns
-        -------
-        None
         """
         self.is_running = False
         self._run_ctx = None

digitalhub/entities/_base/_base/entity.py

@@ -54,26 +54,11 @@ class Base:
         ----------
         **kwargs : dict
             Keyword arguments to be set as attributes.
-
-        Returns
-        -------
-        None
         """
         for k, v in kwargs.items():
             if k not in self.__dict__:
                 setattr(self, k, v)
 
-    def _get_private_attrs(self) -> dict:
-        """
-        Return all private attributes of the object.
-
-        Returns
-        -------
-        dict
-            A dictionary containing the private attributes of the entity instance.
-        """
-        return {k: v for k, v in self.__dict__.items() if k.startswith("_")}
-
     def __repr__(self) -> str:
         """
         Return string representation of the entity object.

digitalhub/entities/_base/context/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.context.api import get_context
 from digitalhub.entities._base.entity.entity import Entity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
 

digitalhub/entities/_base/entity/builder.py

@@ -7,11 +7,11 @@ from __future__ import annotations
 import typing
 from abc import abstractmethod
 
-from digitalhub.entities._base.entity._constructors.metadata import build_metadata
-from digitalhub.entities._base.entity._constructors.name import build_name
-from digitalhub.entities._base.entity._constructors.spec import build_spec
-from digitalhub.entities._base.entity._constructors.status import build_status
-from digitalhub.entities._base.entity._constructors.uuid import build_uuid
+from digitalhub.entities._constructors.metadata import build_metadata
+from digitalhub.entities._constructors.name import build_name
+from digitalhub.entities._constructors.spec import build_spec
+from digitalhub.entities._constructors.status import build_status
+from digitalhub.entities._constructors.uuid import build_uuid
 from digitalhub.utils.exceptions import BuilderError
 
 if typing.TYPE_CHECKING:

digitalhub/entities/_base/entity/entity.py

@@ -67,10 +67,6 @@ class Entity(Base):
         ----------
         obj : dict
             Mapping representation of object.
-
-        Returns
-        -------
-        None
         """
         self.metadata = obj.metadata
         self.spec = obj.spec
@@ -95,10 +91,6 @@ class Entity(Base):
             The target entity.
         source : str
             The source entity.
-
-        Returns
-        -------
-        None
         """
         if self.metadata.relationships is None:
             self.metadata.relationships = []

digitalhub/entities/_base/executable/entity.py

@@ -9,11 +9,11 @@ from abc import abstractmethod
 
 from digitalhub.entities._base.versioned.entity import VersionedEntity
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.entities.run.crud import list_runs
 from digitalhub.entities.task.crud import delete_task, list_tasks
 from digitalhub.entities.trigger.crud import list_triggers
-from digitalhub.factory.factory import factory
+from digitalhub.factory.entity import entity_factory
 from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError
 
 if typing.TYPE_CHECKING:
@@ -94,10 +94,6 @@ class ExecutableEntity(VersionedEntity):
         ----------
         tasks : list[dict]
             List of tasks to import.
-
-        Returns
-        -------
-        None
         """
         # Loop over tasks list, in the case where the function
         # is imported from local file.
@@ -109,7 +105,7 @@ class ExecutableEntity(VersionedEntity):
             # Create a new object from dictionary.
             # the form in which tasks are stored in function
             # status
-            task_obj: Task = factory.build_entity_from_dict(task)
+            task_obj: Task = entity_factory.build_entity_from_dict(task)
 
             # Try to save it in backend to been able to use
             # it for launching runs. In fact, tasks must be
@@ -149,7 +145,7 @@ class ExecutableEntity(VersionedEntity):
         kwargs["kind"] = kind
 
         # Create object instance
-        task: Task = factory.build_entity_from_params(**kwargs)
+        task: Task = entity_factory.build_entity_from_params(**kwargs)
         task.save()
 
         self._tasks[kind] = task
@@ -183,21 +179,62 @@ class ExecutableEntity(VersionedEntity):
             self._tasks[kind] = resp[0]
             return self._tasks[kind]
 
-    def list_task(self, **kwargs) -> list[Task]:
+    def list_task(
+        self,
+        q: str | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        user: str | None = None,
+        state: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+    ) -> list[Task]:
         """
-        List tasks.
+        List tasks of the executable entity from backend.
 
         Parameters
         ----------
-        **kwargs : dict
-            Keyword arguments.
+        q : str
+            Query string to filter objects.
+        name : str
+            Object name.
+        kind : str
+            Kind of the object.
+        user : str
+            User that created the object.
+        state : str
+            Object state.
+        created : str
+            Creation date filter.
+        updated : str
+            Update date filter.
 
         Returns
         -------
-        list
-            List of tasks.
+        list[Task]
+            List of object instances.
+        """
+        return self._list_tasks(
+            self.project,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+        )
+
+    def _list_tasks(self, **kwargs) -> list[Task]:
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        List all tasks of the executable entity from backend.
+
+        Returns
+        -------
+        list[Task]
+            List of object instances.
+        """
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_tasks(self.project, **kwargs)
 
     def update_task(self, kind: str, **kwargs) -> Task:
@@ -225,7 +262,7 @@ class ExecutableEntity(VersionedEntity):
         kwargs["uuid"] = self._tasks[kind].id
 
         # Update task
-        task: Task = factory.build_entity_from_params(**kwargs)
+        task: Task = entity_factory.build_entity_from_params(**kwargs)
         task.save(update=True)
         self._tasks[kind] = task
         return task
@@ -265,7 +302,7 @@ class ExecutableEntity(VersionedEntity):
             Response from backend.
         """
         params = {self.ENTITY_TYPE: self._get_executable_string(), "kind": kind}
-        return context_processor.list_context_entities(self.project, EntityTypes.TASK.value, params=params)
+        return context_processor.list_context_entities(self.project, EntityTypes.TASK.value, **params)
 
     def _check_task_in_backend(self, kind: str) -> bool:
         """
@@ -295,10 +332,6 @@ class ExecutableEntity(VersionedEntity):
         kind : str
             Kind the object.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         EntityError
@@ -316,10 +349,6 @@ class ExecutableEntity(VersionedEntity):
         kind : str
             Kind the object.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         EntityError
@@ -338,35 +367,21 @@ class ExecutableEntity(VersionedEntity):
         Create and execute a new run.
         """
 
-    def get_run(
-        self,
-        identifier: str,
-        **kwargs,
-    ) -> Run:
+    def get_run(self, identifier: str) -> Run:
         """
-        Get object from backend.
+        Get specific run object of the executable from backend.
 
         Parameters
         ----------
         identifier : str
             Entity key (store://...) or entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
         Run
             Object instance.
-
-        Examples
-        --------
-        Using entity key:
-        >>> obj = executable.get_run("store://my-secret-key")
-
-        Using entity ID:
-        >>> obj = executable.get_run("123")
         """
-        entities = self.list_runs(**kwargs)
+        entities = self._list_runs()
         for entity in entities:
             if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
                 if entity.id == identifier:
@@ -375,25 +390,69 @@ class ExecutableEntity(VersionedEntity):
                     return entity
         raise EntityError(f"Run '{identifier}' does not exist or does not belong to this executable.")
 
-    def list_runs(self, **kwargs) -> list[Run]:
+    def list_runs(
+        self,
+        q: str | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        user: str | None = None,
+        state: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+        task: str | None = None,
+        action: str | None = None,
+    ) -> list[Run]:
         """
-        List all runs from backend.
+        List runs of the executable entity from backend.
 
         Parameters
         ----------
-        **kwargs : dict
-            Parameters to pass to the API call.
+        q : str
+            Query string to filter objects.
+        name : str
+            Object name.
+        kind : str
+            Kind of the object.
+        user : str
+            User that created the object.
+        state : str
+            Object state.
+        created : str
+            Creation date filter.
+        updated : str
+            Update date filter.
+        task : str
+            Task string filter.
+        action : str
+            Action name filter.
 
         Returns
         -------
         list[Run]
             List of object instances.
+        """
+        return self._list_runs(
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            task=task,
+            action=action,
+        )
 
-        Examples
-        --------
-        >>> objs = executable.list_runs()
+    def _list_runs(self, **kwargs) -> list[Run]:
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        List all runs of the executable entity from backend.
+
+        Returns
+        -------
+        list[Run]
+            List of object instances.
+        """
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_runs(self.project, **kwargs)
 
     ##############################
@@ -421,17 +480,17 @@ class ExecutableEntity(VersionedEntity):
 
         Returns
         -------
-        Run
-            Run instance.
+        Trigger
+            Object instance.
         """
         # Get task
-        task_kind = factory.get_task_kind_from_action(self.kind, action)
+        task_kind = entity_factory.get_task_kind_from_action(self.kind, action)
         task = self._get_or_create_task(task_kind)
         task_string = task._get_task_string()
 
         # Get run validator for building trigger template
-        run_kind = factory.get_run_kind(self.kind)
-        run_validator: SpecValidator = factory.get_spec_validator(run_kind)
+        run_kind = entity_factory.get_run_kind_from_action(self.kind, action)
+        run_validator: SpecValidator = entity_factory.get_spec_validator(run_kind)
         # Override kwargs
         kwargs["project"] = self.project
         kwargs["kind"] = trigger_kind
@@ -441,15 +500,11 @@ class ExecutableEntity(VersionedEntity):
         kwargs["template"] = run_validator(**kwargs).to_dict()
 
         # Create object instance
-        trigger: Trigger = factory.build_entity_from_params(**kwargs)
+        trigger: Trigger = entity_factory.build_entity_from_params(**kwargs)
         trigger.save()
         return trigger
 
-    def get_trigger(
-        self,
-        identifier: str,
-        **kwargs,
-    ) -> Trigger:
+    def get_trigger(self, identifier: str) -> Trigger:
         """
         Get object from backend.
 
@@ -457,23 +512,13 @@ class ExecutableEntity(VersionedEntity):
         ----------
         identifier : str
             Entity key (store://...) or entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
         Trigger
             Object instance.
-
-        Examples
-        --------
-        Using entity key:
-        >>> obj = executable.get_trigger("store://my-trigger-key")
-
-        Using entity ID:
-        >>> obj = executable.get_trigger("123")
         """
-        entities = self.list_triggers(**kwargs)
+        entities = self._list_triggers()
         for entity in entities:
             if getattr(entity.spec, self.ENTITY_TYPE) == self._get_executable_string():
                 if entity.id == identifier:
@@ -482,9 +527,58 @@ class ExecutableEntity(VersionedEntity):
                     return entity
         raise EntityError(f"Trigger '{identifier}' does not exist or does not belong to this executable.")
 
-    def list_triggers(self, **kwargs) -> list[Trigger]:
+    def list_triggers(
+        self,
+        q: str | None = None,
+        name: str | None = None,
+        kind: str | None = None,
+        user: str | None = None,
+        created: str | None = None,
+        updated: str | None = None,
+        version: str | None = None,
+        task: str | None = None,
+    ) -> list[Trigger]:
         """
-        List all triggers from backend.
+        List triggers of the executable entity from backend.
+
+        Parameters
+        ----------
+        q : str
+            Query string to filter objects.
+        name : str
+            Object name.
+        kind : str
+            Kind of the object.
+        user : str
+            User that created the object.
+        created : str
+            Creation date filter.
+        updated : str
+            Update date filter.
+        version : str
+            Object version, default is latest.
+        task : str
+            Task string filter.
+
+        Returns
+        -------
+        list[Trigger]
+            List of object instances.
+        """
+        return self._list_triggers(
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            created=created,
+            updated=updated,
+            version=version,
+            task=task,
+        )
+
+    def _list_triggers(self, **kwargs) -> list[Trigger]:
+        """
+        List triggers of the executable from backend.
 
         Parameters
         ----------
@@ -495,10 +589,6 @@ class ExecutableEntity(VersionedEntity):
         -------
         list[Trigger]
             List of object instances.
-
-        Examples
-        --------
-        >>> objs = executable.list_triggers()
         """
-        kwargs["params"] = {self.ENTITY_TYPE: self._get_executable_string()}
+        kwargs[self.ENTITY_TYPE] = self._get_executable_string()
         return list_triggers(self.project, **kwargs)

digitalhub/entities/_base/material/entity.py

@@ -9,7 +9,7 @@ from pathlib import Path
 
 from digitalhub.entities._base.material.utils import refresh_decorator
 from digitalhub.entities._base.versioned.entity import VersionedEntity
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.stores.data.api import get_store
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -146,20 +146,16 @@ class MaterialEntity(VersionedEntity):
         source : str | list[str]
             Local filepath, directory or list of filepaths.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Upload a single file:
 
-        >>> entity.spec.path = 's3://bucket/data.csv'
-        >>> entity.upload('./data.csv')
+        >>> entity.spec.path = "s3://bucket/data.csv"
+        >>> entity.upload("./data.csv")
 
         Upload a folder:
-        >>> entity.spec.path = 's3://bucket/data/'
-        >>> entity.upload('./data')
+        >>> entity.spec.path = "s3://bucket/data/"
+        >>> entity.upload("./data")
         """
         # Get store and upload object
         store = get_store(self.spec.path)
@@ -181,10 +177,6 @@ class MaterialEntity(VersionedEntity):
         ----------
         files : list[dict]
             Files to add.
-
-        Returns
-        -------
-        None
         """
         available = 100 - len(self.status.files)
         if len(files) > available:
@@ -204,7 +196,7 @@ class MaterialEntity(VersionedEntity):
         list
             Paths of the files in the status.
         """
-        return [f.get("path") if f.get("path") is not None else f.get("name") for f in self.status.files]
+        return [f.get("path") for f in self.status.files]
 
     ##############################
     #  Private Helpers
@@ -218,10 +210,6 @@ class MaterialEntity(VersionedEntity):
         ----------
         files_info : list[dict] | None
             Files info.
-
-        Returns
-        -------
-        None
         """
         if files_info is None:
             return
@@ -233,10 +221,6 @@ class MaterialEntity(VersionedEntity):
     def _get_files_info(self) -> None:
         """
         Get files info from backend.
-
-        Returns
-        -------
-        None
         """
         if not self._context().local and not self.status.files:
             files = context_processor.read_files_info(

digitalhub/entities/_base/material/utils.py

@@ -21,10 +21,6 @@ def eval_local_source(source: str | list[str]) -> None:
     ----------
     source : str | list[str]
         Source(s).
-
-    Returns
-    -------
-    None
     """
     if isinstance(source, list):
         if not source:
@@ -111,6 +107,7 @@ def build_log_path_from_source(
 
     return path
 
+
 def refresh_decorator(fn: typing.Callable) -> typing.Callable:
     """
     Refresh decorator.