digitalhub 0.14.0b5__py3-none-any.whl → 0.14.9__py3-none-any.whl

digitalhub/entities/project/_base/entity.py

@@ -72,9 +72,8 @@ from digitalhub.entities.workflow.crud import (
     update_workflow,
 )
 from digitalhub.factory.entity import entity_factory
-from digitalhub.stores.client.api import get_client
+from digitalhub.stores.client.builder import get_client
 from digitalhub.utils.exceptions import BackendError, EntityAlreadyExistsError, EntityError
-from digitalhub.utils.generic_utils import get_timestamp
 from digitalhub.utils.io_utils import write_yaml
 from digitalhub.utils.uri_utils import has_local_scheme
 
@@ -107,7 +106,6 @@ class Project(Entity):
         spec: ProjectSpec,
         status: ProjectStatus,
         user: str | None = None,
-        local: bool = False,
     ) -> None:
         super().__init__(kind, metadata, spec, status, user)
         self.spec: ProjectSpec
@@ -115,12 +113,12 @@ class Project(Entity):
 
         self.id = name
         self.name = name
-        self.key = base_processor.build_project_key(self.name, local=local)
+        self.key = base_processor.build_project_key(self.name)
 
         self._obj_attr.extend(["id", "name"])
 
         # Set client
-        self._client = get_client(local)
+        self._client = get_client()
 
         # Set context
         build_context(self)
@@ -144,13 +142,10 @@ class Project(Entity):
             Entity saved.
         """
         if update:
-            if self._client.is_local():
-                self.metadata.updated = get_timestamp()
             new_obj = base_processor.update_project_entity(
                 entity_type=self.ENTITY_TYPE,
                 entity_name=self.name,
                 entity_dict=self.to_dict(),
-                local=self._client.is_local(),
             )
         else:
             new_obj = base_processor.create_project_entity(_entity=self)
@@ -169,7 +164,6 @@ class Project(Entity):
         new_obj = base_processor.read_project_entity(
             entity_type=self.ENTITY_TYPE,
             entity_name=self.name,
-            local=self._client.is_local(),
         )
         self._update_attributes(new_obj)
         return self
@@ -241,7 +235,7 @@ class Project(Entity):
             Exported filepath.
         """
         obj = self._refresh_to_dict()
-        pth = Path(self.spec.context) / f"{self.ENTITY_TYPE}s-{self.name}.yaml"
+        pth = Path(self.spec.source) / f"{self.ENTITY_TYPE}s-{self.name}.yaml"
         obj = self._export_not_embedded(obj)
         write_yaml(pth, obj)
         return str(pth)
@@ -532,7 +526,6 @@ class Project(Entity):
         self,
         identifier: str,
         entity_id: str | None = None,
-        **kwargs,
     ) -> Artifact:
         """
         Get object from backend.
@@ -543,8 +536,6 @@ class Project(Entity):
             Entity key (store://...) or entity name.
         entity_id : str
             Entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -564,7 +555,6 @@ class Project(Entity):
             identifier=identifier,
             project=self.name,
             entity_id=entity_id,
-            **kwargs,
         )
         self.refresh()
         return obj
@@ -572,7 +562,6 @@ class Project(Entity):
     def get_artifact_versions(
         self,
         identifier: str,
-        **kwargs,
     ) -> list[Artifact]:
         """
         Get object versions from backend.
@@ -581,8 +570,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity name.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -597,16 +584,40 @@ class Project(Entity):
         Using entity name:
         >>> obj = project.get_artifact_versions("my-artifact-name")
         """
-        return get_artifact_versions(identifier, project=self.name, **kwargs)
+        return get_artifact_versions(identifier, project=self.name)
 
-    def list_artifacts(self, **kwargs) -> list[Artifact]:
+    def list_artifacts(
+        self,
+        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,
+        versions: str | None = None,
+    ) -> list[Artifact]:
         """
         List all latest version objects from backend.
 
         Parameters
         ----------
-        **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
         -------
@@ -617,7 +628,17 @@ class Project(Entity):
         --------
         >>> objs = project.list_artifacts()
         """
-        return list_artifacts(self.name, **kwargs)
+        return list_artifacts(
+            self.name,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            versions=versions,
+        )
 
     def import_artifact(
         self,
@@ -675,7 +696,7 @@ class Project(Entity):
         identifier: str,
         entity_id: str | None = None,
         delete_all_versions: bool = False,
-        **kwargs,
+        cascade: bool = False,
     ) -> None:
         """
         Delete object from backend.
@@ -688,8 +709,8 @@ class Project(Entity):
             Entity ID.
         delete_all_versions : bool
             Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        cascade : bool
+            Cascade delete related entities.
 
         Returns
         -------
@@ -710,7 +731,7 @@ class Project(Entity):
             project=self.name,
             entity_id=entity_id,
             delete_all_versions=delete_all_versions,
-            **kwargs,
+            cascade=cascade,
         )
         self.refresh()
 
@@ -838,7 +859,6 @@ class Project(Entity):
         self,
         identifier: str,
         entity_id: str | None = None,
-        **kwargs,
     ) -> Dataitem:
         """
         Get object from backend.
@@ -849,8 +869,6 @@ class Project(Entity):
             Entity key (store://...) or entity name.
         entity_id : str
             Entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -870,7 +888,6 @@ class Project(Entity):
             identifier=identifier,
             project=self.name,
             entity_id=entity_id,
-            **kwargs,
         )
         self.refresh()
         return obj
@@ -878,7 +895,6 @@ class Project(Entity):
     def get_dataitem_versions(
         self,
         identifier: str,
-        **kwargs,
     ) -> list[Dataitem]:
         """
         Get object versions from backend.
@@ -887,8 +903,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity name.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -903,16 +917,40 @@ class Project(Entity):
         Using entity name:
         >>> obj = project.get_dataitem_versions("my-dataitem-name")
         """
-        return get_dataitem_versions(identifier, project=self.name, **kwargs)
+        return get_dataitem_versions(identifier, project=self.name)
 
-    def list_dataitems(self, **kwargs) -> list[Dataitem]:
+    def list_dataitems(
+        self,
+        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,
+        versions: str | None = None,
+    ) -> list[Dataitem]:
         """
         List all latest version objects from backend.
 
         Parameters
         ----------
-        **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
         -------
@@ -923,7 +961,17 @@ class Project(Entity):
         --------
         >>> objs = project.list_dataitems()
         """
-        return list_dataitems(self.name, **kwargs)
+        return list_dataitems(
+            self.name,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            versions=versions,
+        )
 
     def import_dataitem(
         self,
@@ -981,7 +1029,7 @@ class Project(Entity):
         identifier: str,
         entity_id: str | None = None,
         delete_all_versions: bool = False,
-        **kwargs,
+        cascade: bool = False,
     ) -> None:
         """
         Delete object from backend.
@@ -994,8 +1042,8 @@ class Project(Entity):
             Entity ID.
         delete_all_versions : bool
             Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        cascade : bool
+            Cascade delete related entities.
 
         Returns
         -------
@@ -1017,7 +1065,7 @@ class Project(Entity):
             project=self.name,
             entity_id=entity_id,
             delete_all_versions=delete_all_versions,
-            **kwargs,
+            cascade=cascade,
         )
         self.refresh()
 
@@ -1133,7 +1181,6 @@ class Project(Entity):
         self,
         identifier: str,
         entity_id: str | None = None,
-        **kwargs,
     ) -> Model:
         """
         Get object from backend.
@@ -1144,8 +1191,6 @@ class Project(Entity):
             Entity key (store://...) or entity name.
         entity_id : str
             Entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1165,7 +1210,6 @@ class Project(Entity):
             identifier=identifier,
             project=self.name,
             entity_id=entity_id,
-            **kwargs,
         )
         self.refresh()
         return obj
@@ -1173,7 +1217,6 @@ class Project(Entity):
     def get_model_versions(
         self,
         identifier: str,
-        **kwargs,
     ) -> list[Model]:
         """
         Get object versions from backend.
@@ -1182,8 +1225,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity name.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1198,16 +1239,40 @@ class Project(Entity):
         Using entity name:
         >>> obj = project.get_model_versions("my-model-name")
         """
-        return get_model_versions(identifier, project=self.name, **kwargs)
+        return get_model_versions(identifier, project=self.name)
 
-    def list_models(self, **kwargs) -> list[Model]:
+    def list_models(
+        self,
+        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,
+        versions: str | None = None,
+    ) -> list[Model]:
         """
         List all latest version objects from backend.
 
         Parameters
         ----------
-        **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
         -------
@@ -1218,7 +1283,17 @@ class Project(Entity):
         --------
         >>> objs = project.list_models()
         """
-        return list_models(self.name, **kwargs)
+        return list_models(
+            self.name,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            versions=versions,
+        )
 
     def import_model(
         self,
@@ -1276,7 +1351,7 @@ class Project(Entity):
         identifier: str,
         entity_id: str | None = None,
         delete_all_versions: bool = False,
-        **kwargs,
+        cascade: bool = False,
     ) -> None:
         """
         Delete object from backend.
@@ -1289,8 +1364,8 @@ class Project(Entity):
             Entity ID.
         delete_all_versions : bool
             Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
-        **kwargs : dict
-            Parameters to pass to the API call.
+        cascade : bool
+            Cascade delete related entities.
 
         Returns
         -------
@@ -1312,7 +1387,7 @@ class Project(Entity):
             project=self.name,
             entity_id=entity_id,
             delete_all_versions=delete_all_versions,
-            **kwargs,
+            cascade=cascade,
         )
         self.refresh()
 
@@ -1379,7 +1454,6 @@ class Project(Entity):
         self,
         identifier: str,
         entity_id: str | None = None,
-        **kwargs,
     ) -> Function:
         """
         Get object from backend.
@@ -1390,8 +1464,6 @@ class Project(Entity):
             Entity key (store://...) or entity name.
         entity_id : str
             Entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1411,7 +1483,6 @@ class Project(Entity):
             identifier=identifier,
             project=self.name,
             entity_id=entity_id,
-            **kwargs,
         )
         self.refresh()
         return obj
@@ -1419,7 +1490,6 @@ class Project(Entity):
     def get_function_versions(
         self,
         identifier: str,
-        **kwargs,
     ) -> list[Function]:
         """
         Get object versions from backend.
@@ -1428,8 +1498,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity name.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1444,16 +1512,40 @@ class Project(Entity):
         Using entity name:
         >>> obj = project.get_function_versions("my-function-name")
         """
-        return get_function_versions(identifier, project=self.name, **kwargs)
+        return get_function_versions(identifier, project=self.name)
 
-    def list_functions(self, **kwargs) -> list[Function]:
+    def list_functions(
+        self,
+        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,
+        versions: str | None = None,
+    ) -> list[Function]:
         """
         List all latest version objects from backend.
 
         Parameters
         ----------
-        **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
         -------
@@ -1464,7 +1556,17 @@ class Project(Entity):
         --------
         >>> objs = project.list_functions()
         """
-        return list_functions(self.name, **kwargs)
+        return list_functions(
+            self.name,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            versions=versions,
+        )
 
     def import_function(
         self,
@@ -1523,7 +1625,6 @@ class Project(Entity):
         entity_id: str | None = None,
         delete_all_versions: bool = False,
         cascade: bool = True,
-        **kwargs,
     ) -> None:
         """
         Delete object from backend.
@@ -1538,8 +1639,6 @@ class Project(Entity):
             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
         -------
@@ -1561,7 +1660,6 @@ class Project(Entity):
             entity_id=entity_id,
             delete_all_versions=delete_all_versions,
             cascade=cascade,
-            **kwargs,
         )
         self.refresh()
 
@@ -1628,7 +1726,6 @@ class Project(Entity):
         self,
         identifier: str,
         entity_id: str | None = None,
-        **kwargs,
     ) -> Workflow:
         """
         Get object from backend.
@@ -1639,8 +1736,6 @@ class Project(Entity):
             Entity key (store://...) or entity name.
         entity_id : str
             Entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1660,7 +1755,6 @@ class Project(Entity):
             identifier=identifier,
             project=self.name,
             entity_id=entity_id,
-            **kwargs,
         )
         self.refresh()
         return obj
@@ -1668,7 +1762,6 @@ class Project(Entity):
     def get_workflow_versions(
         self,
         identifier: str,
-        **kwargs,
     ) -> list[Workflow]:
         """
         Get object versions from backend.
@@ -1677,8 +1770,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity name.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1693,16 +1784,40 @@ class Project(Entity):
         Using entity name:
         >>> obj = project.get_workflow_versions("my-workflow-name")
         """
-        return get_workflow_versions(identifier, project=self.name, **kwargs)
+        return get_workflow_versions(identifier, project=self.name)
 
-    def list_workflows(self, **kwargs) -> list[Workflow]:
+    def list_workflows(
+        self,
+        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,
+        versions: str | None = None,
+    ) -> list[Workflow]:
         """
         List all latest version objects from backend.
 
         Parameters
         ----------
-        **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
         -------
@@ -1713,7 +1828,17 @@ class Project(Entity):
         --------
         >>> objs = project.list_workflows()
         """
-        return list_workflows(self.name, **kwargs)
+        return list_workflows(
+            self.name,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            versions=versions,
+        )
 
     def import_workflow(
         self,
@@ -1772,7 +1897,6 @@ class Project(Entity):
         entity_id: str | None = None,
         delete_all_versions: bool = False,
         cascade: bool = True,
-        **kwargs,
     ) -> None:
         """
         Delete object from backend.
@@ -1787,8 +1911,6 @@ class Project(Entity):
             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
         -------
@@ -1810,7 +1932,6 @@ class Project(Entity):
             entity_id=entity_id,
             delete_all_versions=delete_all_versions,
             cascade=cascade,
-            **kwargs,
         )
         self.refresh()
 
@@ -1875,7 +1996,6 @@ class Project(Entity):
         self,
         identifier: str,
         entity_id: str | None = None,
-        **kwargs,
     ) -> Secret:
         """
         Get object from backend.
@@ -1886,8 +2006,6 @@ class Project(Entity):
             Entity key (store://...) or entity name.
         entity_id : str
             Entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1907,7 +2025,6 @@ class Project(Entity):
             identifier=identifier,
             project=self.name,
             entity_id=entity_id,
-            **kwargs,
         )
         self.refresh()
         return obj
@@ -1915,7 +2032,6 @@ class Project(Entity):
     def get_secret_versions(
         self,
         identifier: str,
-        **kwargs,
     ) -> list[Secret]:
         """
         Get object versions from backend.
@@ -1924,8 +2040,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity name.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -1940,9 +2054,9 @@ class Project(Entity):
         Using entity name:
         >>> obj = project.get_secret_versions("my-secret-name")
         """
-        return get_secret_versions(identifier, project=self.name, **kwargs)
+        return get_secret_versions(identifier, project=self.name)
 
-    def list_secrets(self, **kwargs) -> list[Secret]:
+    def list_secrets(self) -> list[Secret]:
         """
         List all latest version objects from backend.
 
@@ -1960,7 +2074,7 @@ class Project(Entity):
         --------
         >>> objs = project.list_secrets()
         """
-        return list_secrets(self.name, **kwargs)
+        return list_secrets(self.name)
 
     def import_secret(
         self,
@@ -2018,7 +2132,6 @@ class Project(Entity):
         identifier: str,
         entity_id: str | None = None,
         delete_all_versions: bool = False,
-        **kwargs,
     ) -> None:
         """
         Delete object from backend.
@@ -2031,8 +2144,6 @@ class Project(Entity):
             Entity ID.
         delete_all_versions : bool
             Delete all versions of the named entity. If True, use entity name instead of entity key as identifier.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -2053,7 +2164,6 @@ class Project(Entity):
             project=self.name,
             entity_id=entity_id,
             delete_all_versions=delete_all_versions,
-            **kwargs,
         )
         self.refresh()
 
@@ -2064,7 +2174,6 @@ class Project(Entity):
     def get_run(
         self,
         identifier: str,
-        **kwargs,
     ) -> Run:
         """
         Get object from backend.
@@ -2073,8 +2182,6 @@ class Project(Entity):
         ----------
         identifier : str
             Entity key (store://...) or entity ID.
-        **kwargs : dict
-            Parameters to pass to the API call.
 
         Returns
         -------
@@ -2092,19 +2199,51 @@ class Project(Entity):
         obj = get_run(
             identifier=identifier,
             project=self.name,
-            **kwargs,
         )
         self.refresh()
         return obj
 
-    def list_runs(self, **kwargs) -> list[Run]:
+    def list_runs(
+        self,
+        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,
+        function: str | None = None,
+        workflow: str | None = None,
+        task: str | None = None,
+        action: str | None = None,
+    ) -> list[Run]:
         """
         List all latest objects from backend.
 
         Parameters
         ----------
-        **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.
+        function : str
+            Function key filter.
+        workflow : str
+            Workflow key filter.
+        task : str
+            Task string filter.
+        action : str
+            Action name filter.
 
         Returns
         -------
@@ -2115,7 +2254,20 @@ class Project(Entity):
         --------
         >>> objs = project.list_runs()
         """
-        return list_runs(self.name, **kwargs)
+        return list_runs(
+            self.name,
+            q=q,
+            name=name,
+            kind=kind,
+            user=user,
+            state=state,
+            created=created,
+            updated=updated,
+            function=function,
+            workflow=workflow,
+            task=task,
+            action=action,
+        )
 
     def delete_run(
         self,
@@ -2200,7 +2352,6 @@ class Project(Entity):
             entity_name=self.name,
             user=user,
             unshare=False,
-            local=self._client.is_local(),
         )
 
     def unshare(self, user: str) -> None:
@@ -2220,5 +2371,4 @@ class Project(Entity):
             entity_name=self.name,
             user=user,
             unshare=True,
-            local=self._client.is_local(),
         )