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

digitalhub/entities/function/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.function._base.entity import Function
@@ -100,9 +100,7 @@ def get_function(
     Examples
     --------
     Using entity key:
-    >>> obj = get_function(
-    ...     "store://my-function-key"
-    ... )
+    >>> obj = get_function("store://my-function-key")
 
     Using entity name:
     >>> obj = get_function("my-function-name"
@@ -143,9 +141,7 @@ def get_function_versions(
     Examples
     --------
     Using entity key:
-    >>> obj = get_function_versions(
-    ...     "store://my-function-key"
-    ... )
+    >>> obj = get_function_versions("store://my-function-key")
 
     Using entity name:
     >>> obj = get_function_versions("my-function-name"
@@ -177,9 +173,7 @@ def list_functions(project: str, **kwargs) -> list[Function]:
 
     Examples
     --------
-    >>> objs = list_functions(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_functions(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
@@ -215,9 +209,7 @@ def import_function(
 
     Examples
     --------
-    >>> obj = import_function(
-    ...     "my-function.yaml"
-    ... )
+    >>> obj = import_function("my-function.yaml")
     """
     return context_processor.import_executable_entity(file, key, reset_id, context)
 
@@ -238,9 +230,7 @@ def load_function(file: str) -> Function:
 
     Examples
     --------
-    >>> obj = load_function(
-    ...     "my-function.yaml"
-    ... )
+    >>> obj = load_function("my-function.yaml")
     """
     return context_processor.load_executable_entity(file)
 
@@ -261,11 +251,7 @@ def update_function(entity: Function) -> Function:
 
     Examples
     --------
-    >>> obj = (
-    ...     update_function(
-    ...         obj
-    ...     )
-    ... )
+    >>> obj = update_function(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -309,9 +295,7 @@ def delete_function(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_function(
-    ...     "store://my-function-key"
-    ... )
+    >>> obj = delete_function("store://my-function-key")
 
     Otherwise:
     >>> obj = delete_function("function-name",

digitalhub/entities/model/_base/entity.py

@@ -9,7 +9,7 @@ import typing
 from digitalhub.entities._base.material.entity import MaterialEntity
 from digitalhub.entities._commons.enums import EntityTypes
 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
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -81,21 +81,13 @@ class Model(MaterialEntity):
         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(
@@ -139,10 +131,6 @@ class Model(MaterialEntity):
         overwrite : bool
             If True, overwrite existing metrics.
 
-        Returns
-        -------
-        None
-
         Examples
         --------
         Log multiple metrics at once
@@ -204,10 +192,6 @@ class Model(MaterialEntity):
     def _get_metrics(self) -> None:
         """
         Get model metrics from backend.
-
-        Returns
-        -------
-        None
         """
         self.status.metrics = context_processor.read_metrics(
             project=self.project,
@@ -235,10 +219,6 @@ class Model(MaterialEntity):
             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/model/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
 from digitalhub.entities.model.utils import eval_source, process_kwargs
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -155,9 +155,7 @@ def get_model(
     Examples
     --------
     Using entity key:
-    >>> obj = get_model(
-    ...     "store://my-model-key"
-    ... )
+    >>> obj = get_model("store://my-model-key")
 
     Using entity name:
     >>> obj = get_model("my-model-name"
@@ -198,9 +196,7 @@ def get_model_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_model_versions(
-    ...     "store://my-model-key"
-    ... )
+    >>> objs = get_model_versions("store://my-model-key")
 
     Using entity name:
     >>> objs = get_model_versions("my-model-name",
@@ -232,9 +228,7 @@ def list_models(project: str, **kwargs) -> list[Model]:
 
     Examples
     --------
-    >>> objs = list_models(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_models(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
@@ -270,9 +264,7 @@ def import_model(
 
     Examples
     --------
-    >>> obj = import_model(
-    ...     "my-model.yaml"
-    ... )
+    >>> obj = import_model("my-model.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -298,9 +290,7 @@ def load_model(file: str) -> Model:
 
     Examples
     --------
-    >>> obj = load_model(
-    ...     "my-model.yaml"
-    ... )
+    >>> obj = load_model("my-model.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -321,9 +311,7 @@ def update_model(entity: Model) -> Model:
 
     Examples
     --------
-    >>> obj = get_model(
-    ...     "store://my-model-key"
-    ... )
+    >>> obj = get_model("store://my-model-key")
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -367,9 +355,7 @@ def delete_model(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_model(
-    ...     "store://my-model-key"
-    ... )
+    >>> obj = delete_model("store://my-model-key")
 
     Otherwise:
     >>> obj = delete_model("my-model-name",

digitalhub/entities/project/_base/entity.py

@@ -12,8 +12,7 @@ from digitalhub.context.api import build_context
 from digitalhub.entities._base.entity.entity import Entity
 from digitalhub.entities._commons.enums import EntityTypes
 from digitalhub.entities._constructors.uuid import build_uuid
-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.artifact.crud import (
     delete_artifact,
     get_artifact,
@@ -299,10 +298,6 @@ class Project(Entity):
         ----------
         obj : dict
             Project object in dictionary format.
-
-        Returns
-        -------
-        None
         """
         entity_types = self._get_entity_types()
 
@@ -362,10 +357,6 @@ class Project(Entity):
         ----------
         obj : dict
             Project object in dictionary format.
-
-        Returns
-        -------
-        None
         """
         entity_types = self._get_entity_types()
 
@@ -563,9 +554,7 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_artifact(
-        ...     "store://my-artifact-key"
-        ... )
+        >>> obj = project.get_artifact("store://my-artifact-key")
 
         Using entity name:
         >>> obj = project.get_artifact("my-artifact-name"
@@ -603,14 +592,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_artifact_versions(
-        ...     "store://my-artifact-key"
-        ... )
+        >>> obj = project.get_artifact_versions("store://my-artifact-key")
 
         Using entity name:
-        >>> obj = project.get_artifact_versions(
-        ...     "my-artifact-name"
-        ... )
+        >>> obj = project.get_artifact_versions("my-artifact-name")
         """
         return get_artifact_versions(identifier, project=self.name, **kwargs)
 
@@ -659,9 +644,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_artifact(
-        ...     "my-artifact.yaml"
-        ... )
+        >>> obj = project.import_artifact("my-artifact.yaml")
         """
         return import_artifact(file, key, reset_id, self.name)
 
@@ -681,9 +664,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_artifact(
-        ...     obj
-        ... )
+        >>> obj = project.update_artifact(obj)
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -718,9 +699,7 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_artifact(
-        ...     "store://my-artifact-key"
-        ... )
+        >>> project.delete_artifact("store://my-artifact-key")
 
         Otherwise:
         >>> project.delete_artifact("my-artifact-name",
@@ -881,9 +860,7 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_dataitem(
-        ...     "store://my-dataitem-key"
-        ... )
+        >>> obj = project.get_dataitem("store://my-dataitem-key")
 
         Using entity name:
         >>> obj = project.get_dataitem("my-dataitem-name"
@@ -921,14 +898,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_dataitem_versions(
-        ...     "store://my-dataitem-key"
-        ... )
+        >>> obj = project.get_dataitem_versions("store://my-dataitem-key")
 
         Using entity name:
-        >>> obj = project.get_dataitem_versions(
-        ...     "my-dataitem-name"
-        ... )
+        >>> obj = project.get_dataitem_versions("my-dataitem-name")
         """
         return get_dataitem_versions(identifier, project=self.name, **kwargs)
 
@@ -977,9 +950,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_dataitem(
-        ...     "my-dataitem.yaml"
-        ... )
+        >>> obj = project.import_dataitem("my-dataitem.yaml")
         """
         return import_dataitem(file, key, reset_id, self.name)
 
@@ -999,9 +970,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_dataitem(
-        ...     obj
-        ... )
+        >>> obj = project.update_dataitem(obj)
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1036,9 +1005,7 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_dataitem(
-        ...     "store://my-dataitem-key"
-        ... )
+        >>> project.delete_dataitem("store://my-dataitem-key")
 
         Otherwise:
         >>> project.delete_dataitem("my-dataitem-name",
@@ -1188,9 +1155,7 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_model(
-        ...     "store://my-model-key"
-        ... )
+        >>> obj = project.get_model("store://my-model-key")
 
         Using entity name:
         >>> obj = project.get_model("my-model-name"
@@ -1228,14 +1193,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_model_versions(
-        ...     "store://my-model-key"
-        ... )
+        >>> obj = project.get_model_versions("store://my-model-key")
 
         Using entity name:
-        >>> obj = project.get_model_versions(
-        ...     "my-model-name"
-        ... )
+        >>> obj = project.get_model_versions("my-model-name")
         """
         return get_model_versions(identifier, project=self.name, **kwargs)
 
@@ -1284,9 +1245,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_model(
-        ...     "my-model.yaml"
-        ... )
+        >>> obj = project.import_model("my-model.yaml")
         """
         return import_model(file, key, reset_id, self.name)
 
@@ -1306,9 +1265,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_model(
-        ...     obj
-        ... )
+        >>> obj = project.update_model(obj)
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1343,9 +1300,7 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_model(
-        ...     "store://my-model-key"
-        ... )
+        >>> project.delete_model("store://my-model-key")
 
         Otherwise:
         >>> project.delete_model("my-model-name",
@@ -1446,9 +1401,7 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_function(
-        ...     "store://my-function-key"
-        ... )
+        >>> obj = project.get_function("store://my-function-key")
 
         Using entity name:
         >>> obj = project.get_function("my-function-name"
@@ -1486,14 +1439,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_function_versions(
-        ...     "store://my-function-key"
-        ... )
+        >>> obj = project.get_function_versions("store://my-function-key")
 
         Using entity name:
-        >>> obj = project.get_function_versions(
-        ...     "my-function-name"
-        ... )
+        >>> obj = project.get_function_versions("my-function-name")
         """
         return get_function_versions(identifier, project=self.name, **kwargs)
 
@@ -1542,9 +1491,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_function(
-        ...     "my-function.yaml"
-        ... )
+        >>> obj = project.import_function("my-function.yaml")
         """
         return import_function(file, key, reset_id, self.name)
 
@@ -1564,9 +1511,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_function(
-        ...     obj
-        ... )
+        >>> obj = project.update_function(obj)
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1604,9 +1549,7 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_function(
-        ...     "store://my-function-key"
-        ... )
+        >>> project.delete_function("store://my-function-key")
 
         Otherwise:
         >>> project.delete_function("my-function-name",
@@ -1707,9 +1650,7 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_workflow(
-        ...     "store://my-workflow-key"
-        ... )
+        >>> obj = project.get_workflow("store://my-workflow-key")
 
         Using entity name:
         >>> obj = project.get_workflow("my-workflow-name"
@@ -1747,14 +1688,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_workflow_versions(
-        ...     "store://my-workflow-key"
-        ... )
+        >>> obj = project.get_workflow_versions("store://my-workflow-key")
 
         Using entity name:
-        >>> obj = project.get_workflow_versions(
-        ...     "my-workflow-name"
-        ... )
+        >>> obj = project.get_workflow_versions("my-workflow-name")
         """
         return get_workflow_versions(identifier, project=self.name, **kwargs)
 
@@ -1803,9 +1740,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_workflow(
-        ...     "my-workflow.yaml"
-        ... )
+        >>> obj = project.import_workflow("my-workflow.yaml")
         """
         return import_workflow(file, key, reset_id, self.name)
 
@@ -1825,9 +1760,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_workflow(
-        ...     obj
-        ... )
+        >>> obj = project.update_workflow(obj)
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -1865,9 +1798,7 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_workflow(
-        ...     "store://my-workflow-key"
-        ... )
+        >>> project.delete_workflow("store://my-workflow-key")
 
         Otherwise:
         >>> project.delete_workflow("my-workflow-name",
@@ -1966,9 +1897,7 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_secret(
-        ...     "store://my-secret-key"
-        ... )
+        >>> obj = project.get_secret("store://my-secret-key")
 
         Using entity name:
         >>> obj = project.get_secret("my-secret-name"
@@ -2006,14 +1935,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_secret_versions(
-        ...     "store://my-secret-key"
-        ... )
+        >>> obj = project.get_secret_versions("store://my-secret-key")
 
         Using entity name:
-        >>> obj = project.get_secret_versions(
-        ...     "my-secret-name"
-        ... )
+        >>> obj = project.get_secret_versions("my-secret-name")
         """
         return get_secret_versions(identifier, project=self.name, **kwargs)
 
@@ -2062,9 +1987,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.import_secret(
-        ...     "my-secret.yaml"
-        ... )
+        >>> obj = project.import_secret("my-secret.yaml")
         """
         return import_secret(file, key, reset_id, self.name)
 
@@ -2084,9 +2007,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> obj = project.update_secret(
-        ...     obj
-        ... )
+        >>> obj = project.update_secret(obj)
         """
         if entity.project != self.name:
             raise ValueError(f"Entity {entity.name} is not in project {self.name}.")
@@ -2121,9 +2042,7 @@ class Project(Entity):
         Examples
         --------
         If delete_all_versions is False:
-        >>> project.delete_secret(
-        ...     "store://my-secret-key"
-        ... )
+        >>> project.delete_secret("store://my-secret-key")
 
         Otherwise:
         >>> project.delete_secret("my-secret-name",
@@ -2165,16 +2084,10 @@ class Project(Entity):
         Examples
         --------
         Using entity key:
-        >>> obj = project.get_run(
-        ...     "store://my-secret-key"
-        ... )
+        >>> obj = project.get_run("store://my-secret-key")
 
         Using entity ID:
-        >>> obj = (
-        ...     project.get_run(
-        ...         "123"
-        ...     )
-        ... )
+        >>> obj = project.get_run("123")
         """
         obj = get_run(
             identifier=identifier,
@@ -2226,9 +2139,7 @@ class Project(Entity):
 
         Examples
         --------
-        >>> project.delete_run(
-        ...     "store://my-run-key"
-        ... )
+        >>> project.delete_run("store://my-run-key")
 
         """
         delete_run(