digitalhub 0.8.0b0__py3-none-any.whl → 0.8.0b1__py3-none-any.whl

digitalhub/entities/_base/api.py

@@ -0,0 +1,346 @@
+from __future__ import annotations
+
+API_BASE = "/api/v1"
+API_CONTEXT = f"{API_BASE}/-"
+
+
+##############################
+# Context APIs
+##############################
+
+
+def api_ctx_create(
+    project: str,
+    entity_type: str,
+) -> str:
+    """
+    Create context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        The name of the entity_type.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}"
+
+
+def api_ctx_read(project: str, entity_type: str, entity_id: str) -> str:
+    """
+    Read context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}"
+
+
+def api_ctx_update(
+    project: str,
+    entity_type: str,
+    entity_id: str,
+) -> str:
+    """
+    Update context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}"
+
+
+def api_ctx_delete(project: str, entity_type: str, entity_id: str) -> str:
+    """
+    Delete context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}"
+
+
+def api_ctx_list(project: str, entity_type: str) -> str:
+    """
+    List context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}"
+
+
+def api_ctx_data(project: str, entity_type: str) -> str:
+    """
+    Data context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/data"
+
+
+def api_ctx_logs(project: str, entity_type: str, entity_id: str) -> str:
+    """
+    Logs context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/logs"
+
+
+def api_ctx_stop(project: str, entity_type: str, entity_id: str) -> str:
+    """
+    Stop context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/stop"
+
+
+def api_ctx_resume(project: str, entity_type: str, entity_id: str) -> str:
+    """
+    Resume context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/resume"
+
+
+def api_ctx_files(project: str, entity_type: str, entity_id: str) -> str:
+    """
+    Files context API.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_CONTEXT}/{project}/{entity_type}/{entity_id}/files/info"
+
+
+##############################
+# Base APIs
+##############################
+
+
+def api_base_list(entity_type: str) -> str:
+    """
+    List base API.
+
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_BASE}/{entity_type}"
+
+
+def api_base_create(entity_type: str) -> str:
+    """
+    Create base API.
+
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_BASE}/{entity_type}"
+
+
+def api_base_read(entity_type: str, entity_id: str) -> str:
+    """
+    Read base API.
+
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_BASE}/{entity_type}/{entity_id}"
+
+
+def api_base_update(entity_type: str, entity_id: str) -> str:
+    """
+    Update base API.
+
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_BASE}/{entity_type}/{entity_id}"
+
+
+def api_base_delete(entity_type: str, entity_id: str) -> str:
+    """
+    Delete base API.
+
+    Parameters
+    ----------
+    entity_type : str
+        Entity type.
+    entity_id : str
+        Entity ID.
+
+    Returns
+    -------
+    str
+        The API string formatted.
+    """
+    if not entity_type.endswith("s"):
+        entity_type += "s"
+    return f"{API_BASE}/{entity_type}/{entity_id}"

digitalhub/entities/_base/base.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from digitalhub.utils.generic_utils import dict_to_json
+
+
+class ModelObj:
+    """
+    Base class for all entities.
+    It implements to_dict abd to_json method to represent
+    the object as a dictionary/json and an any_setter method to
+    set generic attributes coming from a constructor.
+    """
+
+    def to_dict(self) -> dict:
+        """
+        Return object as dict with all non private keys.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the attributes of the entity instance.
+        """
+        obj = {}
+        for key, value in self.__dict__.items():
+            if not key.startswith("_") and value is not None:
+                if hasattr(value, "to_dict"):
+                    sub_dict = value.to_dict()
+                    if sub_dict:
+                        obj[key] = sub_dict
+                else:
+                    obj[key] = value
+        return obj
+
+    def to_json(self) -> str:
+        """
+        Return object as json with all non private keys.
+
+        Returns
+        -------
+        str
+            A json string containing the attributes of the entity instance.
+        """
+        return dict_to_json(self.to_dict())
+
+    def _any_setter(self, **kwargs) -> None:
+        """
+        Set any attribute of the object.
+
+        Parameters
+        ----------
+        **kwargs : dict
+            Keyword arguments to be set as attributes.
+
+        Returns
+        -------
+        None
+        """
+        for k, v in kwargs.items():
+            if k not in self.__dict__:
+                setattr(self, k, v)
+
+    def _get_private_attrs(self) -> dict:
+        """
+        Return all private attributes of the object.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the private attributes of the entity instance.
+        """
+        return {k: v for k, v in self.__dict__.items() if k.startswith("_")}
+
+    def __repr__(self) -> str:
+        """
+        Return string representation of the entity object.
+
+        Returns
+        -------
+        str
+            A string representing the entity instance.
+        """
+        return str(self.to_dict())