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

digitalhub/entities/dataitem/crud.py

@@ -8,7 +8,7 @@ import typing
 from typing import Any
 
 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.dataitem.utils import clean_tmp_path, eval_data, eval_source, post_process, process_kwargs
 from digitalhub.utils.types import SourcesOrListOfSources
 
@@ -161,7 +161,6 @@ def get_dataitem(
     identifier: str,
     project: str | None = None,
     entity_id: str | None = None,
-    **kwargs,
 ) -> Dataitem:
     """
     Get object from backend.
@@ -174,8 +173,6 @@ def get_dataitem(
         Project name.
     entity_id : str
         Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -185,9 +182,7 @@ def get_dataitem(
     Examples
     --------
     Using entity key:
-    >>> obj = get_dataitem(
-    ...     "store://my-dataitem-key"
-    ... )
+    >>> obj = get_dataitem("store://my-dataitem-key")
 
     Using entity name:
     >>> obj = get_dataitem("my-dataitem-name"
@@ -199,14 +194,12 @@ def get_dataitem(
         entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
-        **kwargs,
     )
 
 
 def get_dataitem_versions(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> list[Dataitem]:
     """
     Get object versions from backend.
@@ -217,8 +210,6 @@ def get_dataitem_versions(
         Entity key (store://...) or entity name.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -228,9 +219,7 @@ def get_dataitem_versions(
     Examples
     --------
     Using entity key:
-    >>> objs = get_dataitem_versions(
-    ...     "store://my-dataitem-key"
-    ... )
+    >>> objs = get_dataitem_versions("store://my-dataitem-key")
 
     Using entity name:
     >>> objs = get_dataitem_versions("my-dataitem-name",
@@ -240,11 +229,20 @@ def get_dataitem_versions(
         identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        **kwargs,
     )
 
 
-def list_dataitems(project: str, **kwargs) -> list[Dataitem]:
+def list_dataitems(
+    project: str,
+    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,
+    version: str | None = None,
+) -> list[Dataitem]:
     """
     List all latest version objects from backend.
 
@@ -252,8 +250,22 @@ def list_dataitems(project: str, **kwargs) -> list[Dataitem]:
     ----------
     project : str
         Project name.
-    **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.
+    version : str
+        Object version, default is latest.
 
     Returns
     -------
@@ -262,14 +274,19 @@ def list_dataitems(project: str, **kwargs) -> list[Dataitem]:
 
     Examples
     --------
-    >>> objs = list_dataitems(
-    ...     project="my-project"
-    ... )
+    >>> objs = list_dataitems(project="my-project")
     """
     return context_processor.list_context_entities(
         project=project,
         entity_type=ENTITY_TYPE,
-        **kwargs,
+        q=q,
+        name=name,
+        kind=kind,
+        user=user,
+        state=state,
+        created=created,
+        updated=updated,
+        version=version,
     )
 
 
@@ -300,9 +317,7 @@ def import_dataitem(
 
     Examples
     --------
-    >>> obj = import_dataitem(
-    ...     "my-dataitem.yaml"
-    ... )
+    >>> obj = import_dataitem("my-dataitem.yaml")
     """
     return context_processor.import_context_entity(
         file,
@@ -328,9 +343,7 @@ def load_dataitem(file: str) -> Dataitem:
 
     Examples
     --------
-    >>> obj = load_dataitem(
-    ...     "my-dataitem.yaml"
-    ... )
+    >>> obj = load_dataitem("my-dataitem.yaml")
     """
     return context_processor.load_context_entity(file)
 
@@ -351,11 +364,7 @@ def update_dataitem(entity: Dataitem) -> Dataitem:
 
     Examples
     --------
-    >>> obj = (
-    ...     update_dataitem(
-    ...         obj
-    ...     )
-    ... )
+    >>> obj = update_dataitem(obj)
     """
     return context_processor.update_context_entity(
         project=entity.project,
@@ -385,7 +394,8 @@ def delete_dataitem(
     entity_id : str
         Entity ID.
     delete_all_versions : bool
-        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+        Delete all versions of the named entity.
+        If True, use entity name instead of entity key as identifier.
     cascade : bool
         Cascade delete.
     **kwargs : dict
@@ -399,9 +409,7 @@ def delete_dataitem(
     Examples
     --------
     If delete_all_versions is False:
-    >>> obj = delete_dataitem(
-    ...     "store://my-dataitem-key"
-    ... )
+    >>> obj = delete_dataitem("store://my-dataitem-key")
 
     Otherwise:
     >>> obj = delete_dataitem("my-dataitem-name",

digitalhub/entities/dataitem/table/entity.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 import typing
 from typing import Any
 
+from digitalhub.entities._base.material.utils import refresh_decorator
 from digitalhub.entities.dataitem._base.entity import Dataitem
 from digitalhub.stores.data.api import get_store
 from digitalhub.utils.uri_utils import has_sql_scheme
@@ -63,6 +64,7 @@ class DataitemTable(Dataitem):
         self._query = query
         return self
 
+    @refresh_decorator
     def as_df(
         self,
         file_format: str | None = None,
@@ -105,6 +107,7 @@ class DataitemTable(Dataitem):
             **kwargs,
         )
 
+    @refresh_decorator
     def write_df(
         self,
         df: Any,
@@ -139,12 +142,8 @@ class DataitemTable(Dataitem):
         >>> import digitalhub as dh
         >>> import pandas as pd
         >>>
-        >>> p = dh.get_project(
-        ...     "my_project"
-        ... )
-        >>> df = pd.read_df(
-        ...     "data/my_data.csv"
-        ... )
+        >>> p = dh.get_project("my_project")
+        >>> df = pd.read_df("data/my_data.csv")
         >>> di = p.new_dataitem(
         ...     name="my_dataitem",
         ...     kind="table",

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
@@ -76,7 +76,6 @@ def get_function(
     identifier: str,
     project: str | None = None,
     entity_id: str | None = None,
-    **kwargs,
 ) -> Function:
     """
     Get object from backend.
@@ -89,8 +88,6 @@ def get_function(
         Project name.
     entity_id : str
         Entity ID.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -100,9 +97,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"
@@ -110,18 +105,16 @@ def get_function(
     >>>                    entity_id="my-function-id")
     """
     return context_processor.read_context_entity(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
         entity_id=entity_id,
-        **kwargs,
     )
 
 
 def get_function_versions(
     identifier: str,
     project: str | None = None,
-    **kwargs,
 ) -> list[Function]:
     """
     Get object versions from backend.
@@ -132,8 +125,6 @@ def get_function_versions(
         Entity key (store://...) or entity name.
     project : str
         Project name.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -143,23 +134,30 @@ 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"
     >>>                             project="my-project")
     """
     return context_processor.read_context_entity_versions(
-        identifier,
+        identifier=identifier,
         entity_type=ENTITY_TYPE,
         project=project,
-        **kwargs,
     )
 
 
-def list_functions(project: str, **kwargs) -> list[Function]:
+def list_functions(
+    project: str,
+    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,
+    version: str | None = None,
+) -> list[Function]:
     """
     List all latest version objects from backend.
 
@@ -167,8 +165,22 @@ def list_functions(project: str, **kwargs) -> list[Function]:
     ----------
     project : str
         Project name.
-    **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.
+    version : str
+        Object version, default is latest.
 
     Returns
     -------
@@ -177,14 +189,19 @@ 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,
         entity_type=ENTITY_TYPE,
-        **kwargs,
+        q=q,
+        name=name,
+        kind=kind,
+        user=user,
+        state=state,
+        created=created,
+        updated=updated,
+        version=version,
     )
 
 
@@ -215,9 +232,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 +253,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 +274,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,
@@ -281,7 +290,6 @@ def delete_function(
     entity_id: str | None = None,
     delete_all_versions: bool = False,
     cascade: bool = True,
-    **kwargs,
 ) -> dict:
     """
     Delete object from backend.
@@ -295,11 +303,10 @@ def delete_function(
     entity_id : str
         Entity ID.
     delete_all_versions : bool
-        Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
+        Delete all versions of the named entity.
+        If True, use entity name instead of entity key as identifier.
     cascade : bool
         Cascade delete.
-    **kwargs : dict
-        Parameters to pass to the API call.
 
     Returns
     -------
@@ -309,9 +316,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",
@@ -325,5 +330,4 @@ def delete_function(
         entity_id=entity_id,
         delete_all_versions=delete_all_versions,
         cascade=cascade,
-        **kwargs,
     )

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(