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

digitalhub/entities/project/crud.py

@@ -7,8 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.base import base_processor
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import base_processor, context_processor
 from digitalhub.entities.project.utils import setup_project
 from digitalhub.utils.exceptions import BackendError
 
@@ -59,9 +58,7 @@ def new_project(
 
     Examples
     --------
-    >>> obj = new_project(
-    ...     "my-project"
-    ... )
+    >>> obj = new_project("my-project")
     """
     if context is None:
         context = "./"
@@ -105,9 +102,7 @@ def get_project(
 
     Examples
     --------
-    >>> obj = get_project(
-    ...     "my-project"
-    ... )
+    >>> obj = get_project("my-project")
     """
     obj = base_processor.read_project_entity(
         entity_type=ENTITY_TYPE,
@@ -145,9 +140,7 @@ def import_project(
 
     Examples
     --------
-    >>> obj = import_project(
-    ...     "my-project.yaml"
-    ... )
+    >>> obj = import_project("my-project.yaml")
     """
     obj = base_processor.import_project_entity(
         file=file,
@@ -181,9 +174,7 @@ def load_project(
 
     Examples
     --------
-    >>> obj = load_project(
-    ...     "my-project.yaml"
-    ... )
+    >>> obj = load_project("my-project.yaml")
     """
     obj = base_processor.load_project_entity(file=file, local=local)
     return setup_project(obj, setup_kwargs)
@@ -275,11 +266,7 @@ def update_project(entity: Project, **kwargs) -> Project:
 
     Examples
     --------
-    >>> obj = (
-    ...     update_project(
-    ...         obj
-    ...     )
-    ... )
+    >>> obj = update_project(obj)
     """
     return base_processor.update_project_entity(
         entity_type=entity.ENTITY_TYPE,
@@ -320,9 +307,7 @@ def delete_project(
 
     Examples
     --------
-    >>> delete_project(
-    ...     "my-project"
-    ... )
+    >>> delete_project("my-project")
     """
     return base_processor.delete_project_entity(
         entity_type=ENTITY_TYPE,

digitalhub/entities/run/_base/builder.py

@@ -90,10 +90,6 @@ class RunBuilder(UnversionedBuilder, RuntimeEntityBuilder):
         ----------
         task : str
             Task string.
-
-        Returns
-        -------
-        None
         """
         task_kind = task.split("://")[0]
         if task_kind not in self.get_all_kinds():

digitalhub/entities/run/_base/entity.py

@@ -10,7 +10,7 @@ import typing
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 from digitalhub.entities._commons.enums import EntityTypes, State
 from digitalhub.entities._commons.metrics import MetricType, set_metrics, validate_metric_value
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.factory.entity import entity_factory
 from digitalhub.factory.runtime import runtime_factory
 from digitalhub.utils.exceptions import EntityError
@@ -52,10 +52,6 @@ class Run(UnversionedEntity):
     def build(self) -> None:
         """
         Build run.
-
-        Returns
-        -------
-        None
         """
         executable = self._get_executable()
         task = self._get_task()
@@ -142,10 +138,6 @@ class Run(UnversionedEntity):
     def stop(self) -> None:
         """
         Stop run.
-
-        Returns
-        -------
-        None
         """
         if not self.spec.local_execution:
             return context_processor.stop_entity(self.project, self.ENTITY_TYPE, self.id)
@@ -153,10 +145,6 @@ class Run(UnversionedEntity):
     def resume(self) -> None:
         """
         Resume run.
-
-        Returns
-        -------
-        None
         """
         if not self.spec.local_execution:
             return context_processor.resume_entity(self.project, self.ENTITY_TYPE, self.id)
@@ -185,21 +173,13 @@ class Run(UnversionedEntity):
         single_value : bool
             If True, value is a single value.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Log a new value in a list
-        >>> entity.log_metric(
-        ...     "loss", 0.002
-        ... )
+        >>> entity.log_metric("loss", 0.002)
 
         Append a new value in a list
-        >>> entity.log_metric(
-        ...     "loss", 0.0019
-        ... )
+        >>> entity.log_metric("loss", 0.0019)
 
         Log a list of values and append them to existing metric:
         >>> entity.log_metric(
@@ -243,10 +223,6 @@ class Run(UnversionedEntity):
         overwrite : bool
             If True, overwrite existing metrics.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Log multiple metrics at once
@@ -308,19 +284,11 @@ class Run(UnversionedEntity):
     def _setup_execution(self) -> None:
         """
         Setup run execution.
-
-        Returns
-        -------
-        None
         """
 
     def _start_execution(self) -> None:
         """
         Start run execution.
-
-        Returns
-        -------
-        None
         """
         self._context().set_run(f"{self.key}:{self.id}")
         if self.spec.local_execution:
@@ -332,10 +300,6 @@ class Run(UnversionedEntity):
     def _finish_execution(self) -> None:
         """
         Finish run execution.
-
-        Returns
-        -------
-        None
         """
         self._context().unset_run()
 
@@ -358,10 +322,6 @@ class Run(UnversionedEntity):
         ----------
         status : dict
             Status to set.
-
-        Returns
-        -------
-        None
         """
         self.status: RunStatus = entity_factory.build_status(self.kind, **status)
 
@@ -373,10 +333,6 @@ class Run(UnversionedEntity):
         ----------
         state : str
             State to set.
-
-        Returns
-        -------
-        None
         """
         self.status.state = state
 
@@ -388,10 +344,6 @@ class Run(UnversionedEntity):
         ----------
         message : str
             Message to set.
-
-        Returns
-        -------
-        None
         """
         self.status.message = message
 
@@ -447,10 +399,6 @@ class Run(UnversionedEntity):
     def _get_metrics(self) -> None:
         """
         Get model metrics from backend.
-
-        Returns
-        -------
-        None
         """
         self.status.metrics = context_processor.read_metrics(
             project=self.project,
@@ -478,10 +426,6 @@ class Run(UnversionedEntity):
             If True, overwrite existing metric.
         single_value : bool
             If True, value is a single value.
-
-        Returns
-        -------
-        None
         """
         value = validate_metric_value(value)
         self.status.metrics = set_metrics(

digitalhub/entities/run/crud.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._commons.utils import is_valid_key
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
@@ -94,9 +94,7 @@ def get_run(
     Examples
     --------
     Using entity key:
-    >>> obj = get_run(
-    ...     "store://my-run-key"
-    ... )
+    >>> obj = get_run("store://my-run-key")
 
     Using entity ID:
     >>> obj = get_run("my-run-id"
@@ -128,9 +126,7 @@ def list_runs(project: str, **kwargs) -> list[Run]:
 
     Examples
     --------
-    >>> objs = list_runs(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_runs(project="my-project")
     """
     # TODO more examples: search by function, latest for task and function
     return context_processor.list_context_entities(
@@ -167,9 +163,7 @@ def import_run(
 
     Example
     -------
-    >>> obj = import_run(
-    ...     "my-run.yaml"
-    ... )
+    >>> obj = import_run("my-run.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -195,9 +189,7 @@ def load_run(file: str) -> Run:
 
     Examples
     --------
-    >>> obj = load_run(
-    ...     "my-run.yaml"
-    ... )
+    >>> obj = load_run("my-run.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -218,9 +210,7 @@ def update_run(entity: Run) -> Run:
 
     Examples
     --------
-    >>> obj = update_run(
-    ...     obj
-    ... )
+    >>> obj = update_run(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -254,9 +244,7 @@ def delete_run(
 
     Examples
     --------
-    >>> obj = delete_run(
-    ...     "store://my-run-key"
-    ... )
+    >>> obj = delete_run("store://my-run-key")
     >>> obj = delete_run(
     ...     "my-run-id",
     ...     project="my-project",

digitalhub/entities/secret/_base/entity.py

@@ -8,7 +8,7 @@ import typing
 
 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
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -50,10 +50,6 @@ class Secret(VersionedEntity):
         ----------
         value : str
             Value of the secret.
-
-        Returns
-        -------
-        None
         """
         obj = {self.name: value}
         context_processor.update_secret_data(self.project, self.ENTITY_TYPE, obj)

digitalhub/entities/secret/crud.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._commons.utils import is_valid_key
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.exceptions import EntityNotExistsError
 
 if typing.TYPE_CHECKING:
@@ -105,9 +105,7 @@ def get_secret(
     Examples
     --------
     Using entity key:
-    >>> obj = get_secret(
-    ...     "store://my-secret-key"
-    ... )
+    >>> obj = get_secret("store://my-secret-key")
 
     Using entity name:
     >>> obj = get_secret("my-secret-name"
@@ -157,9 +155,7 @@ def get_secret_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_secret_versions(
-    ...     "store://my-secret-key"
-    ... )
+    >>> objs = get_secret_versions("store://my-secret-key")
 
     Using entity name:
     >>> objs = get_secret_versions("my-secret-name",
@@ -191,9 +187,7 @@ def list_secrets(project: str, **kwargs) -> list[Secret]:
 
     Examples
     --------
-    >>> objs = list_secrets(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_secrets(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
@@ -229,9 +223,7 @@ def import_secret(
 
     Examples
     --------
-    >>> obj = import_secret(
-    ...     "my-secret.yaml"
-    ... )
+    >>> obj = import_secret("my-secret.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -257,9 +249,7 @@ def load_secret(file: str) -> Secret:
 
     Examples
     --------
-    >>> obj = load_secret(
-    ...     "my-secret.yaml"
-    ... )
+    >>> obj = load_secret("my-secret.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -280,9 +270,7 @@ def update_secret(entity: Secret) -> Secret:
 
     Examples
     --------
-    >>> obj = update_secret(
-    ...     obj
-    ... )
+    >>> obj = update_secret(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -323,9 +311,7 @@ def delete_secret(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_secret(
-    ...     "store://my-secret-key"
-    ... )
+    >>> obj = delete_secret("store://my-secret-key")
 
     Otherwise:
     >>> obj = delete_secret("my-secret-name"

digitalhub/entities/task/_base/builder.py

@@ -85,10 +85,6 @@ class TaskBuilder(UnversionedBuilder, RuntimeEntityBuilder):
         ----------
         executable : str
             Executable string.
-
-        Returns
-        -------
-        None
         """
         exec_kind = executable.split("://")[0]
         if self.EXECUTABLE_KIND != exec_kind:

digitalhub/entities/task/_base/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._base.unversioned.entity import UnversionedEntity
 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.factory.entity import entity_factory
 
 if typing.TYPE_CHECKING:

digitalhub/entities/task/crud.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._commons.utils import is_valid_key
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 from digitalhub.utils.exceptions import EntityError
 
 if typing.TYPE_CHECKING:
@@ -94,9 +94,7 @@ def get_task(
     Examples
     --------
     Using entity key:
-    >>> obj = get_task(
-    ...     "store://my-task-key"
-    ... )
+    >>> obj = get_task("store://my-task-key")
 
     Using entity ID:
     >>> obj = get_task("my-task-id"
@@ -128,9 +126,7 @@ def list_tasks(project: str, **kwargs) -> list[Task]:
 
     Examples
     --------
-    >>> objs = list_tasks(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_tasks(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
@@ -166,9 +162,7 @@ def import_task(
 
     Example
     -------
-    >>> obj = import_task(
-    ...     "my-task.yaml"
-    ... )
+    >>> obj = import_task("my-task.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -194,9 +188,7 @@ def load_task(file: str) -> Task:
 
     Examples
     --------
-    >>> obj = load_task(
-    ...     "my-task.yaml"
-    ... )
+    >>> obj = load_task("my-task.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -217,9 +209,7 @@ def update_task(entity: Task) -> Task:
 
     Examples
     --------
-    >>> obj = update_task(
-    ...     obj
-    ... )
+    >>> obj = update_task(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -263,9 +253,7 @@ def delete_task(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_task(
-    ...     "store://my-task-key"
-    ... )
+    >>> obj = delete_task("store://my-task-key")
 
     Otherwise:
     >>> obj = delete_task("task-name",

digitalhub/entities/trigger/_base/entity.py

@@ -8,7 +8,7 @@ import typing
 
 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
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -41,9 +41,5 @@ class Trigger(VersionedEntity):
     def stop(self) -> None:
         """
         Stop trigger.
-
-        Returns
-        -------
-        None
         """
         return context_processor.stop_entity(self.project, self.ENTITY_TYPE, self.id)

digitalhub/entities/trigger/crud.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import typing
 
 from digitalhub.entities._commons.enums import EntityTypes
-from digitalhub.entities._processors.context import context_processor
+from digitalhub.entities._processors.processors import context_processor
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities.trigger._base.entity import Trigger
@@ -115,9 +115,7 @@ def get_trigger(
     Examples
     --------
     Using entity key:
-    >>> obj = get_trigger(
-    ...     "store://my-trigger-key"
-    ... )
+    >>> obj = get_trigger("store://my-trigger-key")
 
     Using entity name:
     >>> obj = get_trigger("my-trigger-name"
@@ -158,9 +156,7 @@ def get_trigger_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_trigger_versions(
-    ...     "store://my-trigger-key"
-    ... )
+    >>> objs = get_trigger_versions("store://my-trigger-key")
 
     Using entity name:
     >>> objs = get_trigger_versions("my-trigger-name",
@@ -192,9 +188,7 @@ def list_triggers(project: str, **kwargs) -> list[Trigger]:
 
     Examples
     --------
-    >>> objs = list_triggers(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_triggers(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
@@ -230,9 +224,7 @@ def import_trigger(
 
     Examples
     --------
-    >>> obj = import_trigger(
-    ...     "my-trigger.yaml"
-    ... )
+    >>> obj = import_trigger("my-trigger.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -258,9 +250,7 @@ def load_trigger(file: str) -> Trigger:
 
     Examples
     --------
-    >>> obj = load_trigger(
-    ...     "my-trigger.yaml"
-    ... )
+    >>> obj = load_trigger("my-trigger.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -281,11 +271,7 @@ def update_trigger(entity: Trigger) -> Trigger:
 
     Examples
     --------
-    >>> obj = (
-    ...     update_trigger(
-    ...         obj
-    ...     )
-    ... )
+    >>> obj = update_trigger(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -326,9 +312,7 @@ def delete_trigger(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_trigger(
-    ...     "store://my-trigger-key"
-    ... )
+    >>> obj = delete_trigger("store://my-trigger-key")
 
     Otherwise:
     >>> obj = delete_trigger("my-trigger-name"