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

digitalhub/stores/client/dhcore/configurator.py

@@ -47,10 +47,6 @@ class ClientDHCoreConfigurator(Configurator):
     def __init__(self) -> None:
         """
         Initialize DHCore configurator and evaluate authentication type.
-
-        Returns
-        -------
-        None
         """
         super().__init__()
         self._auth_type: str | None = None
@@ -66,10 +62,6 @@ class ClientDHCoreConfigurator(Configurator):
 
         Sanitizes endpoint and issuer URLs to ensure proper HTTP/HTTPS schemes
         and removes trailing slashes.
-
-        Returns
-        -------
-        None
         """
         env_creds = self._creds_handler.load_from_env(self.keys)
         env_creds = self._sanitize_env_vars(env_creds)
@@ -107,10 +99,6 @@ class ClientDHCoreConfigurator(Configurator):
 
         Handles keys without "DHCORE_" prefix for CLI compatibility. Falls back
         to environment variables for missing endpoint and personal access token values.
-
-        Returns
-        -------
-        None
         """
         file_creds = self._creds_handler.load_from_file(self.keys)
 
@@ -119,6 +107,11 @@ class ClientDHCoreConfigurator(Configurator):
         if file_creds[pat] is None:
             file_creds[pat] = self._creds_handler.load_from_env([pat]).get(pat)
 
+        # Because in the response there is no endpoint
+        endpoint = CredsEnvVar.DHCORE_ENDPOINT.value
+        if file_creds[endpoint] is None:
+            file_creds[endpoint] = self._creds_handler.load_from_env([endpoint]).get(endpoint)
+
         file_creds = self._sanitize_file_vars(file_creds)
         self._creds_handler.set_credentials(self._file, file_creds)
 
@@ -208,10 +201,6 @@ class ClientDHCoreConfigurator(Configurator):
 
         Changes between environment and file credential sources, then re-evaluates
         authentication type based on the new credentials.
-
-        Returns
-        -------
-        None
         """
         super().change_origin()
 
@@ -230,10 +219,6 @@ class ClientDHCoreConfigurator(Configurator):
         OAUTH2 (access + refresh tokens), ACCESS_TOKEN (access only), BASIC
         (username + password). For EXCHANGE type, automatically exchanges the
         personal access token and switches to file-based credentials storage.
-
-        Returns
-        -------
-        None
         """
         creds = creds_handler.get_credentials(self._origin)
         self._auth_type = self._eval_auth_type(creds)
@@ -305,10 +290,6 @@ class ClientDHCoreConfigurator(Configurator):
         change_origin : bool, default False
             Whether to switch credential sources on auth failure.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         ClientError
@@ -462,10 +443,6 @@ class ClientDHCoreConfigurator(Configurator):
         ----------
         response : dict
             OAuth2 token response with new credentials.
-
-        Returns
-        -------
-        None
         """
         for key in self.keys_to_prefix:
             key = key.lower()

digitalhub/stores/client/dhcore/error_parser.py

@@ -44,10 +44,6 @@ class ErrorParser:
         response : Response
             The HTTP response object from requests.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         TimeoutError

digitalhub/stores/client/dhcore/params_builder.py

@@ -4,9 +4,13 @@
 
 from __future__ import annotations
 
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
 from digitalhub.stores.client._base.params_builder import ClientParametersBuilder
 
+DEFAULT_START_PAGE = 0
+DEFAULT_SIZE = 25
+DEFAULT_SORT = "metadata.updated,DESC"
+
 
 class ClientDHCoreParametersBuilder(ClientParametersBuilder):
     """
@@ -33,11 +37,6 @@ class ClientDHCoreParametersBuilder(ClientParametersBuilder):
         """
         Build HTTP request parameters for DHCore API calls.
 
-        Routes parameter building to appropriate method based on API category
-        (base or context operations) and applies operation-specific transformations.
-        Acts as dispatcher, initializing parameter dictionaries with 'params' key
-        for query parameters.
-
         Parameters
         ----------
         category : str
@@ -61,108 +60,105 @@ class ClientDHCoreParametersBuilder(ClientParametersBuilder):
 
     def build_parameters_base(self, operation: str, **kwargs) -> dict:
         """
-        Build parameters for base-level API operations.
-
-        Constructs HTTP request parameters for project-level operations and
-        entity sharing functionality. Handles CASCADE (boolean to lowercase string),
-        SHARE (user parameter to query params), and UNSHARE (requires unshare=True
-        and entity id).
+        Constructs HTTP request parameters for project operations.
 
         Parameters
         ----------
         operation : str
-            API operation: DELETE (project deletion with optional cascade)
-            or SHARE (entity sharing/unsharing with users).
+            API operation.
         **kwargs : dict
-            Operation-specific parameters:
-            - cascade (bool): For DELETE, whether to cascade delete
-            - user (str): For SHARE, target user for sharing
-            - unshare (bool): For SHARE, whether to unshare instead
-            - id (str): For SHARE unshare, entity ID to unshare
-
+            Operation-specific parameters.
         Returns
         -------
         dict
             Formatted parameters with 'params' containing query parameters.
         """
-        kwargs = self._set_params(**kwargs)
+        kwargs = self._ensure_params(**kwargs)
+
+        # Handle delete
         if operation == BackendOperations.DELETE.value:
             if (cascade := kwargs.pop("cascade", None)) is not None:
-                kwargs["params"]["cascade"] = str(cascade).lower()
+                kwargs = self._add_param("cascade", str(cascade).lower(), **kwargs)
+
+        # Handle share
         elif operation == BackendOperations.SHARE.value:
-            kwargs["params"]["user"] = kwargs.pop("user")
+            kwargs = self._add_param("user", kwargs.pop("user"), **kwargs)
             if kwargs.pop("unshare", False):
-                kwargs["params"]["id"] = kwargs.pop("id")
+                kwargs = self._add_param("id", kwargs.pop("id"), **kwargs)
 
         return kwargs
 
     def build_parameters_context(self, operation: str, **kwargs) -> dict:
         """
-        Build parameters for context-level API operations.
-
         Constructs HTTP request parameters for entity management and search within
-        projects. Handles search filters via 'filter' parameter, pagination with
-        'page' and 'size', result ordering with 'sort' parameter. READ supports
-        embedded entity inclusion, DELETE requires entity 'id' parameter.
+        projects.
 
         Parameters
         ----------
         operation : str
-            API operation: SEARCH (search entities with filtering), READ_MANY
-            (retrieve multiple with pagination), DELETE (delete by ID),
-            READ (read by ID with optional embedded).
+            API operation.
         **kwargs : dict
-            Operation-specific parameters:
-            - params (dict): Search filters and conditions
-            - page (int): Page number for pagination (default: 0)
-            - size (int): Items per page (default: 20)
-            - order_by (str): Field to order results by
-            - order (str): Order direction ('asc' or 'desc')
-            - embedded (bool): For READ, whether to include embedded entities
-            - id (str): For READ/DELETE, entity identifier
+            Operation-specific parameters.
 
         Returns
         -------
         dict
-            Formatted parameters with 'params' for query parameters and
-            other request-specific parameters like 'id' for entity operations.
+            Formatted parameters with 'params'.
         """
-        kwargs = self._set_params(**kwargs)
+        kwargs = self._ensure_params(**kwargs)
 
         # Handle read
         if operation == BackendOperations.READ.value:
-            name = kwargs.pop("entity_name", None)
-            if name is not None:
-                kwargs["params"]["name"] = name
+            if (name := kwargs.pop("name", None)) is not None:
+                kwargs = self._add_param("name", name, **kwargs)
+
+        # Handle read all versions
         elif operation == BackendOperations.READ_ALL_VERSIONS.value:
-            kwargs["params"]["versions"] = "all"
-            kwargs["params"]["name"] = kwargs.pop("entity_name")
+            kwargs = self._add_param("versions", "all", **kwargs)
+            kwargs = self._add_param("name", kwargs.pop("name"), **kwargs)
+
+        # Handle list
+        elif operation == BackendOperations.LIST.value:
+            possible_list_params = [
+                "q",
+                "name",
+                "kind",
+                "user",
+                "state",
+                "created",
+                "updated",
+                "versions",
+                "function",
+                "workflow",
+                "action",
+                "task",
+            ]
+            list_params = {k: kwargs.get(k, None) for k in possible_list_params}
+            list_params = self._filter_none_params(**list_params)
+            for k, v in list_params.items():
+                kwargs = self._add_param(k, v, **kwargs)
+            for k in possible_list_params:
+                kwargs.pop(k, None)
+
         # Handle delete
         elif operation == BackendOperations.DELETE.value:
-            # Handle cascade
             if (cascade := kwargs.pop("cascade", None)) is not None:
-                kwargs["params"]["cascade"] = str(cascade).lower()
-
-            # Handle delete all versions
-            entity_id = kwargs.pop("entity_id")
-            entity_name = kwargs.pop("entity_name")
-            if not kwargs.pop("delete_all_versions", False):
-                if entity_id is None:
-                    raise ValueError(
-                        "If `delete_all_versions` is False, `entity_id` must be provided,"
-                        " either as an argument or in key `identifier`.",
-                    )
-            else:
-                kwargs["params"]["name"] = entity_name
+                kwargs = self._add_param("cascade", str(cascade).lower(), **kwargs)
+
+        elif operation == BackendOperations.DELETE_ALL_VERSIONS.value:
+            if (cascade := kwargs.pop("cascade", None)) is not None:
+                kwargs = self._add_param("cascade", str(cascade).lower(), **kwargs)
+            kwargs = self._add_param("name", kwargs.pop("name"), **kwargs)
+
         # Handle search
         elif operation == BackendOperations.SEARCH.value:
             # Handle fq
             if (fq := kwargs.pop("fq", None)) is not None:
-                kwargs["params"]["fq"] = fq
+                kwargs = self._add_param("fq", fq, **kwargs)
 
             # Add search query
             if (query := kwargs.pop("query", None)) is not None:
-                kwargs["params"]["q"] = query
+                kwargs = self._add_param("q", query, **kwargs)
 
             # Add search filters
             fq = []
@@ -205,17 +201,63 @@ class ClientDHCoreParametersBuilder(ClientParametersBuilder):
                 fq.append(f"metadata.labels:({labels})")
 
             # Add filters
-            kwargs["params"]["fq"] = fq
+            kwargs = self._add_param("fq", fq, **kwargs)
+
+        return kwargs
+
+    def set_pagination(self, partial: bool = False, **kwargs) -> dict:
+        """
+        Ensure pagination parameters are set in kwargs.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments to format. May be empty or contain various
+            parameters for API operations.
+
+        Returns
+        -------
+        dict
+            Pagination parameters set in 'params' of kwargs.
+        """
+        kwargs = self._ensure_params(**kwargs)
+
+        if "page" not in kwargs["params"]:
+            kwargs["params"]["page"] = DEFAULT_START_PAGE
+
+        if partial:
+            return kwargs
+
+        if "size" not in kwargs["params"]:
+            kwargs["params"]["size"] = DEFAULT_SIZE
+
+        if "sort" not in kwargs["params"]:
+            kwargs["params"]["sort"] = DEFAULT_SORT
 
         return kwargs
 
     @staticmethod
-    def _set_params(**kwargs) -> dict:
+    def read_page_number(**kwargs) -> int:
+        """
+        Read current page number from kwargs.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments to format. May be empty or contain various
+            parameters for API operations.
+
+        Returns
+        -------
+        int
+            Current page number.
         """
-        Initialize parameter dictionary with query parameters structure.
+        return kwargs["params"]["page"]
 
-        Ensures parameter dictionary has 'params' key for HTTP query parameters,
-        guaranteeing consistent structure for all parameter building methods.
+    @staticmethod
+    def increment_page_number(**kwargs) -> dict:
+        """
+        Increment page number in kwargs.
 
         Parameters
         ----------
@@ -226,11 +268,24 @@ class ClientDHCoreParametersBuilder(ClientParametersBuilder):
         Returns
         -------
         dict
-            Parameters dictionary with guaranteed 'params' key containing
-            empty dict if not already present.
+            Parameters dictionary with incremented 'page' number in 'params'.
         """
-        if not kwargs:
-            kwargs = {}
-        if "params" not in kwargs:
-            kwargs["params"] = {}
+        kwargs["params"]["page"] += 1
         return kwargs
+
+    @staticmethod
+    def _filter_none_params(**kwargs) -> dict:
+        """
+        Filter out None values from kwargs.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments to filter.
+
+        Returns
+        -------
+        dict
+            Filtered kwargs.
+        """
+        return {k: v for k, v in kwargs.items() if v is not None}

digitalhub/stores/client/local/api_builder.py

@@ -4,8 +4,8 @@
 
 from __future__ import annotations
 
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
 from digitalhub.stores.client._base.api_builder import ClientApiBuilder
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
 from digitalhub.stores.client.local.enums import LocalClientVar
 from digitalhub.utils.exceptions import BackendError
 

digitalhub/stores/client/local/params_builder.py

@@ -4,7 +4,7 @@
 
 from __future__ import annotations
 
-from digitalhub.entities._commons.enums import ApiCategories, BackendOperations
+from digitalhub.stores.client._base.enums import ApiCategories, BackendOperations
 from digitalhub.stores.client._base.params_builder import ClientParametersBuilder
 
 
@@ -51,10 +51,13 @@ class ClientLocalParametersBuilder(ClientParametersBuilder):
         dict
             Parameters formatted.
         """
-        kwargs = self._set_params(**kwargs)
+        kwargs = self._ensure_params(**kwargs)
+
+        # Handle delete
         if operation == BackendOperations.DELETE.value:
             if (cascade := kwargs.pop("cascade", None)) is not None:
-                kwargs["params"]["cascade"] = str(cascade).lower()
+                kwargs = self._add_param("cascade", str(cascade).lower(), **kwargs)
+
         return kwargs
 
     def build_parameters_context(self, operation: str, **kwargs) -> dict:
@@ -73,48 +76,22 @@ class ClientLocalParametersBuilder(ClientParametersBuilder):
         dict
             Parameters formatted.
         """
-        kwargs = self._set_params(**kwargs)
+        kwargs = self._ensure_params(**kwargs)
 
-        # Handle read
+        # Handle read all versions
         if operation == BackendOperations.READ_ALL_VERSIONS.value:
-            kwargs["params"]["versions"] = "all"
-            kwargs["params"]["name"] = kwargs.pop("entity_name")
+            kwargs = self._add_param("versions", "all", **kwargs)
+            kwargs = self._add_param("name", kwargs.pop("name"), **kwargs)
+
         # Handle delete
         elif operation == BackendOperations.DELETE.value:
-            # Handle cascade
-            if cascade := kwargs.pop("cascade", None) is not None:
-                kwargs["params"]["cascade"] = str(cascade).lower()
-
-            # Handle delete all versions
-            entity_id = kwargs.pop("entity_id")
-            entity_name = kwargs.pop("entity_name")
-            if not kwargs.pop("delete_all_versions", False):
-                if entity_id is None:
-                    raise ValueError(
-                        "If `delete_all_versions` is False, `entity_id` must be provided,"
-                        " either as an argument or in key `identifier`.",
-                    )
-            else:
-                kwargs["params"]["name"] = entity_name
-        return kwargs
-
-    @staticmethod
-    def _set_params(**kwargs) -> dict:
-        """
-        Format params parameter.
+            if (cascade := kwargs.pop("cascade", None)) is not None:
+                kwargs = self._add_param("cascade", str(cascade).lower(), **kwargs)
 
-        Parameters
-        ----------
-        **kwargs : dict
-            Keyword arguments.
+        # Handle delete all versions
+        elif operation == BackendOperations.DELETE_ALL_VERSIONS.value:
+            if (cascade := kwargs.pop("cascade", None)) is not None:
+                kwargs = self._add_param("cascade", str(cascade).lower(), **kwargs)
+            kwargs = self._add_param("name", kwargs.pop("name"), **kwargs)
 
-        Returns
-        -------
-        dict
-            Parameters with initialized params.
-        """
-        if not kwargs:
-            kwargs = {}
-        if "params" not in kwargs:
-            kwargs["params"] = {}
         return kwargs

digitalhub/stores/credentials/configurator.py

@@ -53,10 +53,6 @@ class Configurator:
     def load_configs(self) -> None:
         """
         Load the configuration from both environment and file sources.
-
-        Returns
-        -------
-        None
         """
         self.load_env_vars()
         self.load_file_vars()
@@ -71,10 +67,6 @@ class Configurator:
         """
         Check if the current profile has changed and reload
         the file credentials if needed.
-
-        Returns
-        -------
-        None
         """
         if (current := self._creds_handler.get_current_profile()) != self._current_profile:
             self.load_file_vars()
@@ -119,10 +111,6 @@ class Configurator:
         """
         Attempt to change the origin of credentials.
         Raise error if already evaluated.
-
-        Returns
-        -------
-        None
         """
         try:
             self.change_origin()
@@ -132,10 +120,6 @@ class Configurator:
     def change_origin(self) -> None:
         """
         Change the origin of credentials from env to file or vice versa.
-
-        Returns
-        -------
-        None
         """
         if self._changed_origin:
             raise ConfigError("Origin has already been changed.")
@@ -147,10 +131,6 @@ class Configurator:
     def change_to_file(self) -> None:
         """
         Set the credentials origin to file.
-
-        Returns
-        -------
-        None
         """
         if self._origin == self._env:
             self._changed_origin = True
@@ -159,10 +139,6 @@ class Configurator:
     def change_to_env(self) -> None:
         """
         Set the credentials origin to environment.
-
-        Returns
-        -------
-        None
         """
         if self._origin == self._file:
             self._changed_origin = True

digitalhub/stores/credentials/handler.py

@@ -64,10 +64,6 @@ class CredentialHandler:
         ----------
         creds_set : str
             Name of the credentials profile to set.
-
-        Returns
-        -------
-        None
         """
         self._profile = creds_set
         set_current_profile(creds_set)
@@ -127,10 +123,6 @@ class CredentialHandler:
         ----------
         creds : dict
             Credentials to write.
-
-        Returns
-        -------
-        None
         """
         write_config(creds, self._profile)
 
@@ -148,10 +140,6 @@ class CredentialHandler:
             The origin of the credentials ('env' or 'file').
         creds : dict
             Credentials to set.
-
-        Returns
-        -------
-        None
         """
         self._creds_store.set_credentials(self._profile, origin, creds)
 

digitalhub/stores/credentials/store.py

@@ -42,10 +42,6 @@ class CredentialsStore:
             Origin of the credentials ('env' or 'file').
         credentials : dict of str to Any
             Dictionary of credentials to set.
-
-        Returns
-        -------
-        None
         """
         if origin == CredsOrigin.ENV.value:
             for key, value in credentials.items():

digitalhub/stores/data/_base/store.py

@@ -114,10 +114,6 @@ class Store:
         src : str
             The source path.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError
@@ -135,10 +131,6 @@ class Store:
         dst : str
             The destination path.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError
@@ -158,10 +150,6 @@ class Store:
         overwrite : bool
             Specify if overwrite an existing file.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError
@@ -179,10 +167,6 @@ class Store:
         ----------
         path : str | Path
             The path to build.
-
-        Returns
-        -------
-        None
         """
         if not isinstance(path, Path):
             path = Path(path)

digitalhub/stores/data/builder.py

@@ -83,10 +83,6 @@ class StoreBuilder:
             The configurator class for store configuration.
             If None, the store will be instantiated without configuration.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         StoreError

digitalhub/stores/data/remote/store.py

@@ -174,10 +174,6 @@ class RemoteStore(Store):
         src : str
             The source location.
 
-        Returns
-        -------
-        None
-
         Raises
         ------
         HTTPError

digitalhub/stores/data/s3/configurator.py

@@ -46,10 +46,6 @@ class S3StoreConfigurator(Configurator):
     def load_env_vars(self) -> None:
         """
         Loads the credentials from the environment variables.
-
-        Returns
-        -------
-        None
         """
         env_creds = self._creds_handler.load_from_env(self.keys)
         self._creds_handler.set_credentials(self._env, env_creds)
@@ -57,10 +53,6 @@ class S3StoreConfigurator(Configurator):
     def load_file_vars(self) -> None:
         """
         Loads the credentials from a file.
-
-        Returns
-        -------
-        None
         """
         file_creds = self._creds_handler.load_from_file(self.keys)
         self._creds_handler.set_credentials(self._file, file_creds)