digitalhub 0.14.0b5__py3-none-any.whl → 0.14.0b7__py3-none-any.whl

digitalhub/__init__.py

@@ -95,7 +95,7 @@ from digitalhub.entities.workflow.crud import (
     new_workflow,
     update_workflow,
 )
-from digitalhub.stores.client.dhcore.utils import refresh_token, set_dhcore_env
+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
 

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

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:

digitalhub/entities/_commons/enums.py

@@ -32,6 +32,7 @@ class Relationship(Enum):
     PRODUCEDBY = "produced_by"
     CONSUMES = "consumes"
     RUN_OF = "run_of"
+    STEP_OF = "step_of"
 
 
 class State(Enum):

digitalhub/entities/_commons/utils.py

@@ -33,6 +33,25 @@ def is_valid_key(key: str) -> bool:
     return bool(re.fullmatch(KEY_PATTERN_WITH_ID, key) or re.fullmatch(KEY_PATTERN_NO_ID, key))
 
 
+def sanitize_unversioned_key(key: str) -> str:
+    """
+    Sanitize an unversioned entity key (from name:id to id).
+
+    Parameters
+    ----------
+    key : str
+        The unversioned entity key.
+
+    Returns
+    -------
+    str
+        The sanitized entity key with version.
+    """
+    splt = key.split("/")[2:]
+    ent_id = splt[-1].split(":")[0]
+    return "store://" + "/".join(splt[:-1] + [ent_id])
+
+
 def parse_entity_key(key: str) -> tuple[str, str, str, str | None, str]:
     """
     Parse an entity key into its constituent components.

digitalhub/entities/_processors/base/crud.py

@@ -74,7 +74,7 @@ class BaseEntityCRUDProcessor:
 
         Parameters
         ----------
-        _entity : Project, optional
+        _entity : Project
             An existing project entity object to create. If None,
             a new entity will be built from kwargs.
         **kwargs : dict

digitalhub/entities/_processors/base/import_export.py

@@ -13,6 +13,7 @@ from digitalhub.utils.exceptions import EntityAlreadyExistsError, EntityError, E
 from digitalhub.utils.io_utils import read_yaml
 
 if typing.TYPE_CHECKING:
+    from digitalhub.entities._processors.base.crud import BaseEntityCRUDProcessor
     from digitalhub.entities.project._base.entity import Project
 
 
@@ -26,7 +27,7 @@ class BaseEntityImportExportProcessor:
 
     def import_project_entity(
         self,
-        crud_processor,
+        crud_processor: BaseEntityCRUDProcessor,
         file: str,
         **kwargs,
     ) -> Project:
@@ -81,7 +82,7 @@ class BaseEntityImportExportProcessor:
 
     def load_project_entity(
         self,
-        crud_processor,
+        crud_processor: BaseEntityCRUDProcessor,
         file: str,
         **kwargs,
     ) -> Project:

digitalhub/entities/_processors/base/processor.py

@@ -49,7 +49,7 @@ class BaseEntityOperationsProcessor:
 
         Parameters
         ----------
-        _entity : Project, optional
+        _entity : Project
             An existing project entity object to create. If None,
             a new entity will be built from kwargs.
         **kwargs : dict
@@ -212,7 +212,7 @@ class BaseEntityOperationsProcessor:
         EntityError
             If the project already exists in the backend.
         """
-        return self.import_export_processor.import_project_entity(file, **kwargs)
+        return self.import_export_processor.import_project_entity(self.crud_processor, file, **kwargs)
 
     def load_project_entity(
         self,
@@ -238,7 +238,7 @@ class BaseEntityOperationsProcessor:
         Project
             The loaded and updated project entity.
         """
-        return self.import_export_processor.load_project_entity(file, **kwargs)
+        return self.import_export_processor.load_project_entity(self.crud_processor, file, **kwargs)
 
     ##############################
     # Base entity operations

digitalhub/entities/_processors/context/crud.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 import typing
 
-from digitalhub.entities._commons.utils import is_valid_key
+from digitalhub.entities._commons.utils import is_valid_key, sanitize_unversioned_key
 from digitalhub.entities._processors.utils import (
     get_context_from_identifier,
     get_context_from_project,
@@ -77,7 +77,7 @@ class ContextEntityCRUDProcessor:
 
         Parameters
         ----------
-        _entity : ContextEntity, optional
+        _entity : ContextEntity
             An existing context entity object to create. If None,
             a new entity will be built from kwargs.
         **kwargs : dict
@@ -120,11 +120,11 @@ class ContextEntityCRUDProcessor:
             The project context instance.
         identifier : str
             Entity key (store://...) or entity name identifier.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to read.
-        project : str, optional
+        project : str
             Project name (used for identifier parsing).
-        entity_id : str, optional
+        entity_id : str
             Specific entity ID to read.
         **kwargs : dict
             Additional parameters to pass to the API call.
@@ -185,11 +185,11 @@ class ContextEntityCRUDProcessor:
         ----------
         identifier : str
             Entity key (store://...) or entity name identifier.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to read.
-        project : str, optional
+        project : str
             Project name for context resolution.
-        entity_id : str, optional
+        entity_id : str
             Specific entity ID to read.
         **kwargs : dict
             Additional parameters to pass to the API call.
@@ -230,11 +230,11 @@ class ContextEntityCRUDProcessor:
         ----------
         identifier : str
             Entity key (store://...) or entity ID.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to read.
-        project : str, optional
+        project : str
             Project name for context resolution.
-        entity_id : str, optional
+        entity_id : str
             Specific entity ID to read.
         **kwargs : dict
             Additional parameters to pass to the API call.
@@ -247,9 +247,7 @@ class ContextEntityCRUDProcessor:
         if not is_valid_key(identifier):
             entity_id = identifier
         else:
-            splt = identifier.split(":")
-            if len(splt) == 3:
-                identifier = f"{splt[0]}:{splt[1]}"
+            identifier = sanitize_unversioned_key(identifier)
         return self.read_context_entity(
             identifier,
             entity_type=entity_type,
@@ -278,9 +276,9 @@ class ContextEntityCRUDProcessor:
             The project context instance.
         identifier : str
             Entity key (store://...) or entity name identifier.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to read versions for.
-        project : str, optional
+        project : str
             Project name (used for identifier parsing).
         **kwargs : dict
             Additional parameters to pass to the API call.
@@ -329,9 +327,9 @@ class ContextEntityCRUDProcessor:
         ----------
         identifier : str
             Entity key (store://...) or entity name identifier.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to read versions for.
-        project : str, optional
+        project : str
             Project name for context resolution.
         **kwargs : dict
             Additional parameters to pass to the API call.
@@ -541,11 +539,11 @@ class ContextEntityCRUDProcessor:
             The project context instance.
         identifier : str
             Entity key (store://...) or entity name identifier.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to delete.
-        project : str, optional
+        project : str
             Project name (used for identifier parsing).
-        entity_id : str, optional
+        entity_id : str
             Specific entity ID to delete.
         **kwargs : dict
             Additional parameters including:
@@ -606,11 +604,11 @@ class ContextEntityCRUDProcessor:
         ----------
         identifier : str
             Entity key (store://...) or entity name identifier.
-        project : str, optional
+        project : str
             Project name for context resolution.
-        entity_type : str, optional
+        entity_type : str
             The type of entity to delete.
-        entity_id : str, optional
+        entity_id : str
             Specific entity ID to delete.
         **kwargs : dict
             Additional parameters including deletion options.

digitalhub/entities/_processors/context/import_export.py

@@ -47,7 +47,7 @@ class ContextEntityImportExportProcessor:
             Storage key (store://...) to read the entity from.
         reset_id : bool
             Flag to determine if the ID of context entities should be reset.
-        context : str, optional
+        context : str
             Project name to use for context resolution. If None, uses
             the project specified in the YAML file.
 
@@ -110,7 +110,7 @@ class ContextEntityImportExportProcessor:
             Storage key (store://...) to read the entity from.
         reset_id : bool
             Flag to determine if the ID of executable entities should be reset.
-        context : str, optional
+        context : str
             Project name to use for context resolution.
 
         Returns

digitalhub/entities/_processors/context/special_ops.py

@@ -47,7 +47,7 @@ class ContextEntitySpecialOpsProcessor:
             The kind/subtype of entity.
         entity_name : str
             The name of the entity.
-        entity_id : str, optional
+        entity_id : str
             The unique identifier of the entity version.
 
         Returns
@@ -336,7 +336,7 @@ class ContextEntitySpecialOpsProcessor:
             The type of entity to read metrics from.
         entity_id : str
             The unique identifier of the entity.
-        metric_name : str, optional
+        metric_name : str
             The name of a specific metric to retrieve.
             If None, retrieves all available metrics.
         **kwargs : dict
@@ -428,22 +428,22 @@ class ContextEntitySpecialOpsProcessor:
             The CRUD processor instance for entity operations.
         project : str
             The project name to search within.
-        query : str, optional
+        query : str
             Free-text search query to match against entity content.
-        entity_types : list[str], optional
+        entity_types : list[str]
             List of entity types to filter by.
             If None, searches all entity types.
-        name : str, optional
+        name : str
             Entity name pattern to match.
-        kind : str, optional
+        kind : str
             Entity kind to filter by.
-        created : str, optional
+        created : str
             Creation date filter (ISO format).
-        updated : str, optional
+        updated : str
             Last update date filter (ISO format).
-        description : str, optional
+        description : str
             Description pattern to match.
-        labels : list[str], optional
+        labels : list[str]
             List of label patterns to match.
         **kwargs : dict
             Additional search parameters to pass to the API call.

digitalhub/entities/_processors/utils.py

@@ -38,13 +38,13 @@ def parse_identifier(
     identifier : str
         The entity identifier to parse. Can be either a full entity key
         (store://project/entity_type/kind/name:id) or a simple entity name.
-    project : str, optional
+    project : str
         The project name. Required when identifier is not a full key.
-    entity_type : str, optional
+    entity_type : str
         The entity type. Required when identifier is not a full key.
-    entity_kind : str, optional
+    entity_kind : str
         The entity kind specification.
-    entity_id : str, optional
+    entity_id : str
         The entity version identifier.
 
     Returns
@@ -81,7 +81,7 @@ def get_context_from_identifier(
     identifier : str
         The entity identifier to extract context from. Can be either
         a full entity key (store://...) or a simple entity name.
-    project : str, optional
+    project : str
         The project name. Required when identifier is not a full key.
 
     Returns

digitalhub/entities/artifact/utils.py

@@ -23,7 +23,7 @@ def eval_source(
 
     Parameters
     ----------
-    source : str, list[str], or None, optional
+    source : str, list[str], or None
         The source specification(s) to evaluate. Can be a single
         source string, a list of source strings, or None.
 
@@ -59,7 +59,7 @@ def process_kwargs(
     source : str or list[str]
         The source specification(s) for the artifact content.
         Can be a single source or multiple sources.
-    path : str, optional
+    path : str
         The destination path for the artifact entity.
         If None, a path will be automatically generated.
     **kwargs : dict

digitalhub/entities/dataitem/utils.py

@@ -41,17 +41,17 @@ def eval_source(
 
     Parameters
     ----------
-    source : SourcesOrListOfSources, optional
+    source : SourcesOrListOfSources
         The source specification(s) for the dataitem. Can be file paths,
         URLs, or other source identifiers.
-    data : Any, optional
+    data : Any
         The data object to process (e.g., DataFrame). Alternative to source.
         Exactly one of source or data must be provided.
-    kind : str, optional
+    kind : str
         The kind of dataitem being created (e.g., 'table').
-    name : str, optional
+    name : str
         The name of the dataitem, used for generating file paths.
-    project : str, optional
+    project : str
         The project name, used for context and path generation.
 
     Returns
@@ -105,13 +105,13 @@ def eval_data(
         how data should be processed.
     source : SourcesOrListOfSources
         The source specification(s) to load data from.
-    data : Any, optional
+    data : Any
         Pre-loaded data object. If provided, may be returned directly
         depending on the dataitem kind.
-    file_format : str, optional
+    file_format : str
         The file format specification for reading the source
         (e.g., 'parquet', 'csv').
-    engine : str, optional
+    engine : str
         The engine to use for reading the data (e.g., 'pandas', 'polars').
 
     Returns
@@ -159,10 +159,10 @@ def process_kwargs(
         The kind of dataitem being created (e.g., 'table').
     source : SourcesOrListOfSources
         The source specification(s) for the dataitem content.
-    data : Any, optional
+    data : Any
         The data object for schema extraction and processing.
         Used as an alternative to source for table dataitems.
-    path : str, optional
+    path : str
         The destination path for the dataitem entity.
         If None, a path will be automatically generated.
     **kwargs : dict
@@ -201,10 +201,6 @@ def clean_tmp_path(pth: SourcesOrListOfSources) -> None:
     pth : SourcesOrListOfSources
         The path or list of paths to clean up. Can be file paths
         or directory paths that need to be removed.
-
-    Returns
-    -------
-    None
     """
     if isinstance(pth, list):
         for p in pth:

digitalhub/entities/model/utils.py

@@ -23,7 +23,7 @@ def eval_source(
 
     Parameters
     ----------
-    source : str, list[str], or None, optional
+    source : str, list[str], or None
         The source specification(s) to evaluate. Can be a single
         source string, a list of source strings, or None.
 
@@ -59,7 +59,7 @@ def process_kwargs(
     source : str or list[str]
         The source specification(s) for the model content.
         Can be a single source or multiple sources.
-    path : str, optional
+    path : str
         The destination path for the model entity.
         If None, a path will be automatically generated.
     **kwargs : dict