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

digitalhub/entities/run/_base/entity.py

@@ -11,7 +11,8 @@ 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.factory.factory import factory
+from digitalhub.factory.entity import entity_factory
+from digitalhub.factory.runtime import runtime_factory
 from digitalhub.utils.exceptions import EntityError
 from digitalhub.utils.logger import LOGGER
 
@@ -59,7 +60,7 @@ class Run(UnversionedEntity):
         executable = self._get_executable()
         task = self._get_task()
         new_spec = self._get_runtime().build(executable, task, self.to_dict())
-        self.spec = factory.build_spec(self.kind, **new_spec)
+        self.spec = entity_factory.build_spec(self.kind, **new_spec)
         self._set_state(State.BUILT.value)
         self.save(update=True)
 
@@ -191,19 +192,37 @@ class Run(UnversionedEntity):
         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("loss", [0.0018, 0.0015])
+        >>> entity.log_metric(
+        ...     "loss",
+        ...     [
+        ...         0.0018,
+        ...         0.0015,
+        ...     ],
+        ... )
 
         Log a single value (not represented as list):
-        >>> entity.log_metric("accuracy", 0.9, single_value=True)
+        >>> entity.log_metric(
+        ...     "accuracy",
+        ...     0.9,
+        ...     single_value=True,
+        ... )
 
         Log a list of values and overwrite existing metric:
-        >>> entity.log_metric("accuracy", [0.8, 0.9], overwrite=True)
+        >>> entity.log_metric(
+        ...     "accuracy",
+        ...     [0.8, 0.9],
+        ...     overwrite=True,
+        ... )
         """
         self._set_metrics(key, value, overwrite, single_value)
         context_processor.update_metric(self.project, self.ENTITY_TYPE, self.id, key, self.status.metrics[key])
@@ -231,16 +250,40 @@ class Run(UnversionedEntity):
         Examples
         --------
         Log multiple metrics at once
-        >>> entity.log_metrics({"loss": 0.002, "accuracy": 0.95})
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.002,
+        ...         "accuracy": 0.95,
+        ...     }
+        ... )
 
         Log metrics with lists and single values
-        >>> entity.log_metrics({"loss": [0.1, 0.05], "epoch": 10})
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": [
+        ...             0.1,
+        ...             0.05,
+        ...         ],
+        ...         "epoch": 10,
+        ...     }
+        ... )
 
         Append to existing metrics (default behavior)
-        >>> entity.log_metrics({"loss": 0.001, "accuracy": 0.96})  # Appends to existing
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.001,
+        ...         "accuracy": 0.96,
+        ...     }
+        ... )  # Appends to existing
 
         Overwrite existing metrics
-        >>> entity.log_metrics({"loss": 0.0005, "accuracy": 0.98}, overwrite=True)
+        >>> entity.log_metrics(
+        ...     {
+        ...         "loss": 0.0005,
+        ...         "accuracy": 0.98,
+        ...     },
+        ...     overwrite=True,
+        ... )
 
         See also
         --------
@@ -320,7 +363,7 @@ class Run(UnversionedEntity):
         -------
         None
         """
-        self.status: RunStatus = factory.build_status(self.kind, **status)
+        self.status: RunStatus = entity_factory.build_status(self.kind, **status)
 
     def _set_state(self, state: str) -> None:
         """
@@ -361,7 +404,7 @@ class Run(UnversionedEntity):
         Runtime
             Runtime object.
         """
-        return factory.build_runtime(self.kind, self.project)
+        return runtime_factory.build_runtime(self.kind, self.project)
 
     def _get_executable(self) -> dict:
         """
@@ -373,8 +416,8 @@ class Run(UnversionedEntity):
         dict
             Executable (function or workflow) from backend.
         """
-        exec_kind = factory.get_executable_kind(self.kind)
-        exec_type = factory.get_entity_type_from_kind(exec_kind)
+        exec_kind = entity_factory.get_executable_kind(self.kind)
+        exec_type = entity_factory.get_entity_type_from_kind(exec_kind)
         string_to_split = getattr(self.spec, exec_type)
         exec_name, exec_id = string_to_split.split("://")[-1].split("/")[-1].split(":")
         return context_processor.read_context_entity(

digitalhub/entities/run/crud.py

@@ -94,7 +94,9 @@ 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"
@@ -126,7 +128,9 @@ 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(
@@ -163,7 +167,9 @@ def import_run(
 
     Example
     -------
-    >>> obj = import_run("my-run.yaml")
+    >>> obj = import_run(
+    ...     "my-run.yaml"
+    ... )
     """
     return context_processor.import_context_entity(
         file,
@@ -189,7 +195,9 @@ 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)
 
@@ -210,7 +218,9 @@ def update_run(entity: Run) -> Run:
 
     Examples
     --------
-    >>> obj = update_run(obj)
+    >>> obj = update_run(
+    ...     obj
+    ... )
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -244,8 +254,13 @@ def delete_run(
 
     Examples
     --------
-    >>> obj = delete_run("store://my-run-key")
-    >>> obj = delete_run("my-run-id", project="my-project")
+    >>> obj = delete_run(
+    ...     "store://my-run-key"
+    ... )
+    >>> obj = delete_run(
+    ...     "my-run-id",
+    ...     project="my-project",
+    ... )
     """
     if not is_valid_key(identifier) and project is None:
         raise EntityError("Specify entity key or entity ID combined with project")

digitalhub/entities/secret/crud.py

@@ -105,7 +105,9 @@ 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"
@@ -155,7 +157,9 @@ 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",
@@ -187,7 +191,9 @@ 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,
@@ -223,7 +229,9 @@ def import_secret(
 
     Examples
     --------
-    >>> obj = import_secret("my-secret.yaml")
+    >>> obj = import_secret(
+    ...     "my-secret.yaml"
+    ... )
     """
     return context_processor.import_context_entity(
         file,
@@ -249,7 +257,9 @@ 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)
 
@@ -270,7 +280,9 @@ def update_secret(entity: Secret) -> Secret:
 
     Examples
     --------
-    >>> obj = update_secret(obj)
+    >>> obj = update_secret(
+    ...     obj
+    ... )
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -311,7 +323,9 @@ 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/entity.py

@@ -9,7 +9,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.factory.factory import factory
+from digitalhub.factory.entity import entity_factory
 
 if typing.TYPE_CHECKING:
     from digitalhub.entities._base.entity.metadata import Metadata
@@ -67,8 +67,8 @@ class Task(UnversionedEntity):
         Run
             Run object.
         """
-        exec_kind = factory.get_executable_kind(self.kind)
-        exec_type = factory.get_entity_type_from_kind(exec_kind)
+        exec_kind = entity_factory.get_executable_kind(self.kind)
+        exec_type = entity_factory.get_entity_type_from_kind(exec_kind)
         kwargs[exec_type] = getattr(self.spec, exec_type)
         return self.new_run(
             save=save,
@@ -112,7 +112,7 @@ class Task(UnversionedEntity):
         """
         if save:
             return context_processor.create_context_entity(**kwargs)
-        return factory.build_entity_from_params(**kwargs)
+        return entity_factory.build_entity_from_params(**kwargs)
 
     def get_run(self, entity_key: str) -> Run:
         """

digitalhub/entities/task/crud.py

@@ -94,7 +94,9 @@ 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"
@@ -126,7 +128,9 @@ 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,
@@ -162,7 +166,9 @@ def import_task(
 
     Example
     -------
-    >>> obj = import_task("my-task.yaml")
+    >>> obj = import_task(
+    ...     "my-task.yaml"
+    ... )
     """
     return context_processor.import_context_entity(
         file,
@@ -188,7 +194,9 @@ 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)
 
@@ -209,7 +217,9 @@ def update_task(entity: Task) -> Task:
 
     Examples
     --------
-    >>> obj = update_task(obj)
+    >>> obj = update_task(
+    ...     obj
+    ... )
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -253,7 +263,9 @@ 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/crud.py

@@ -115,7 +115,9 @@ 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"
@@ -156,7 +158,9 @@ 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",
@@ -188,7 +192,9 @@ 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,
@@ -224,7 +230,9 @@ def import_trigger(
 
     Examples
     --------
-    >>> obj = import_trigger("my-trigger.yaml")
+    >>> obj = import_trigger(
+    ...     "my-trigger.yaml"
+    ... )
     """
     return context_processor.import_context_entity(
         file,
@@ -250,7 +258,9 @@ 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)
 
@@ -271,7 +281,11 @@ def update_trigger(entity: Trigger) -> Trigger:
 
     Examples
     --------
-    >>> obj = update_trigger(obj)
+    >>> obj = (
+    ...     update_trigger(
+    ...         obj
+    ...     )
+    ... )
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -312,7 +326,9 @@ 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"

digitalhub/entities/workflow/_base/entity.py

@@ -8,7 +8,7 @@ import typing
 
 from digitalhub.entities._base.executable.entity import ExecutableEntity
 from digitalhub.entities._commons.enums import EntityTypes, Relationship
-from digitalhub.factory.factory import factory
+from digitalhub.factory.entity import entity_factory
 from digitalhub.utils.exceptions import BackendError
 
 if typing.TYPE_CHECKING:
@@ -72,8 +72,8 @@ class Workflow(ExecutableEntity):
             Run instance.
         """
         # Get task and run kind
-        task_kind = factory.get_task_kind_from_action(self.kind, action)
-        run_kind = factory.get_run_kind_from_action(self.kind, action)
+        task_kind = entity_factory.get_task_kind_from_action(self.kind, action)
+        run_kind = entity_factory.get_run_kind_from_action(self.kind, action)
 
         # Create or update new task
         task = self._get_or_create_task(task_kind)

digitalhub/entities/workflow/crud.py

@@ -99,7 +99,9 @@ def get_workflow(
     Examples
     --------
     Using entity key:
-    >>> obj = get_workflow("store://my-workflow-key")
+    >>> obj = get_workflow(
+    ...     "store://my-workflow-key"
+    ... )
 
     Using entity name:
     >>> obj = get_workflow("my-workflow-name"
@@ -140,7 +142,9 @@ def get_workflow_versions(
     Examples
     --------
     Using entity key:
-    >>> obj = get_workflow_versions("store://my-workflow-key")
+    >>> obj = get_workflow_versions(
+    ...     "store://my-workflow-key"
+    ... )
 
     Using entity name:
     >>> obj = get_workflow_versions("my-workflow-name"
@@ -172,7 +176,9 @@ def list_workflows(project: str, **kwargs) -> list[Workflow]:
 
     Examples
     --------
-    >>> objs = list_workflows(project="my-project")
+    >>> objs = list_workflows(
+    ...     project="my-project"
+    ... )
     """
     return context_processor.list_context_entities(
         project=project,
@@ -208,7 +214,9 @@ def import_workflow(
 
     Examples
     --------
-    >>> obj = import_workflow("my-workflow.yaml")
+    >>> obj = import_workflow(
+    ...     "my-workflow.yaml"
+    ... )
     """
     return context_processor.import_executable_entity(file, key, reset_id, context)
 
@@ -229,7 +237,9 @@ def load_workflow(file: str) -> Workflow:
 
     Examples
     --------
-    >>> obj = load_workflow("my-workflow.yaml")
+    >>> obj = load_workflow(
+    ...     "my-workflow.yaml"
+    ... )
     """
     return context_processor.load_executable_entity(file)
 
@@ -250,7 +260,11 @@ def update_workflow(entity: Workflow) -> Workflow:
 
     Examples
     --------
-    >>> obj = update_workflow(obj)
+    >>> obj = (
+    ...     update_workflow(
+    ...         obj
+    ...     )
+    ... )
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -294,7 +308,9 @@ def delete_workflow(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_workflow("store://my-workflow-key")
+    >>> obj = delete_workflow(
+    ...     "store://my-workflow-key"
+    ... )
 
     Otherwise:
     >>> obj = delete_workflow("workflow-name",