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

digitalhub/entities/_builders/metadata.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
+from digitalhub.utils.generic_utils import get_timestamp
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.metadata import Metadata
+    from digitalhub.registry.models import RegistryEntry
+
+
+def build_metadata(kind: str, **kwargs) -> Metadata:
+    """
+    Build entity metadata object. The builder takes as input
+    the kind of metadata's object to build and the keyword
+    arguments to pass to the metadata's constructor.
+    The specific Metadata class is searched in the global
+    registry, where lies info about where to find the class.
+    The arguments are parsed, eventually adding default values,
+    and then passed to the constructor.
+
+    Parameters
+    ----------
+    kind : str
+        Registry entry kind.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Metadata
+        Metadata object.
+    """
+    infos: RegistryEntry = getattr(registry, kind)
+    metadata = import_class(infos.metadata.module, infos.metadata.class_name)
+    kwargs = parse_arguments(**kwargs)
+    return metadata(**kwargs)
+
+
+def parse_arguments(**kwargs) -> dict:
+    """
+    Parse keyword arguments and add default values if necessary.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    dict
+        A dictionary containing the entity metadata attributes.
+    """
+    if "created" not in kwargs or kwargs["created"] is None:
+        kwargs["created"] = get_timestamp()
+    if "updated" not in kwargs or kwargs["updated"] is None:
+        kwargs["updated"] = kwargs["created"]
+    return kwargs

digitalhub/entities/_builders/name.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+NAME_REGEX = r"^[a-zA-Z0-9._+-]+$"
+
+
+class NameValidator(BaseModel):
+    """
+    Validate name format.
+    """
+
+    name: str = Field(min_length=1, max_length=256, regex=NAME_REGEX)
+
+
+def build_name(name: str) -> str:
+    """
+    Build name.
+
+    Parameters
+    ----------
+    name : str
+        The name.
+
+    Returns
+    -------
+    str
+        The name.
+    """
+    NameValidator(name=name)
+    return name

digitalhub/entities/_builders/spec.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.spec.base import Spec
+    from digitalhub.registry.models import RegistryEntry
+
+
+def build_spec(kind: str, validate: bool = True, **kwargs) -> Spec:
+    """
+    Build entity spec object. The builder takes as input
+    the kind of spec's object to build, a validation flag
+    and the keyword arguments to pass to the spec's constructor.
+    The specific Spec class is searched in the global registry,
+    where lies info about where to find the class.
+    If the validation flag is set to True, the arguments are
+    validated against a pydantic schema and then passed to the
+    constructor.
+
+    Parameters
+    ----------
+    kind : str
+        Registry entry kind.
+    validate : bool
+        Flag to determine if validate kwargs.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Spec
+        Spec object.
+    """
+    infos: RegistryEntry = getattr(registry, kind)
+    spec = import_class(infos.spec.module, infos.spec.class_name)
+    if validate:
+        validator = import_class(infos.spec.module, infos.spec.parameters_validator)
+        kwargs = validator(**kwargs).dict(by_alias=True, exclude_none=True)
+    return spec(**kwargs)

digitalhub/entities/_builders/status.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._base.state import State
+from digitalhub.registry.registry import registry
+from digitalhub.registry.utils import import_class
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities._base.status.base import Status
+    from digitalhub.registry.models import RegistryEntry
+
+
+def build_status(kind: str, **kwargs) -> Status:
+    """
+    Build entity status object. The builder takes as input
+    the kind of status's object to build and the keyword
+    arguments to pass to the status's constructor.
+    The specific Status class is searched in the global
+    registry, where lies info about where to find the class.
+    The arguments are parsed, eventually adding default values,
+    and then passed to the constructor.
+
+    Parameters
+    ----------
+    kind : str
+        Registry entry kind.
+    **kwargs : dict
+        Keyword arguments for the constructor.
+
+    Returns
+    -------
+    Status
+        Status object.
+    """
+    infos: RegistryEntry = getattr(registry, kind)
+    status = import_class(infos.status.module, infos.status.class_name)
+    kwargs = parse_arguments(**kwargs)
+    return status(**kwargs)
+
+
+def parse_arguments(**kwargs) -> dict:
+    """
+    Parse keyword arguments and add default values if necessary.
+
+    Parameters
+    ----------
+    **kwargs : dict
+        Keyword arguments.
+
+    Returns
+    -------
+    dict
+        Keyword arguments with default values.
+    """
+    state = kwargs.get("state")
+    if state is None:
+        kwargs["state"] = State.CREATED.value
+    else:
+        if kwargs["state"] not in State.__members__:
+            raise ValueError(f"Invalid state: {state}")
+    return kwargs

digitalhub/entities/_builders/uuid.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from uuid import uuid4
+
+from pydantic import UUID4, BaseModel
+
+
+class UUIDValidator(BaseModel):
+    """
+    Validate UUID format.
+    """
+
+    uuid: UUID4
+
+
+def build_uuid(uuid: str | None = None) -> str:
+    """
+    Create a uuid if not given. If given, validate it.
+
+    Parameters
+    ----------
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+
+    Returns
+    -------
+    str
+        Validated UUID4.
+    """
+    if uuid is not None:
+        UUIDValidator(uuid=uuid)
+        return uuid
+    return str(uuid4())

digitalhub/entities/artifact/builder.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+
+import typing
+
+from digitalhub.entities._builders.metadata import build_metadata
+from digitalhub.entities._builders.name import build_name
+from digitalhub.entities._builders.spec import build_spec
+from digitalhub.entities._builders.status import build_status
+from digitalhub.entities._builders.uuid import build_uuid
+from digitalhub.utils.exceptions import EntityError
+
+if typing.TYPE_CHECKING:
+    from digitalhub.entities.artifact.entity._base import Artifact
+
+# Manage class mapper
+cls_mapper = {}
+
+try:
+    from digitalhub.entities.artifact.entity.artifact import ArtifactArtifact
+
+    cls_mapper["artifact"] = ArtifactArtifact
+except ImportError:
+    pass
+
+
+def _choose_artifact_type(kind: str) -> type[Artifact]:
+    """
+    Choose class based on kind.
+
+    Parameters
+    ----------
+    kind : str
+        Kind the object.
+
+    Returns
+    -------
+    type[Artifact]
+        Class of the artifact.
+    """
+    try:
+        return cls_mapper[kind]
+    except KeyError:
+        raise EntityError(f"Unknown artifact kind: {kind}")
+
+
+def artifact_from_parameters(
+    project: str,
+    name: str,
+    kind: str,
+    uuid: str | None = None,
+    description: str | None = None,
+    labels: list[str] | None = None,
+    embedded: bool = True,
+    path: str | None = None,
+    **kwargs,
+) -> Artifact:
+    """
+    Create a new object.
+
+    Parameters
+    ----------
+    project : str
+        Project name.
+    name : str
+        Object name.
+    kind : str
+        Kind the object.
+    uuid : str
+        ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2).
+    description : str
+        Description of the object (human readable).
+    labels : list[str]
+        List of labels.
+    embedded : bool
+        Flag to determine if object spec must be embedded in project spec.
+    path : str
+        Object path on local file system or remote storage. It is also the destination path of upload() method.
+    **kwargs : dict
+        Spec keyword arguments.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+    """
+    if path is None:
+        raise EntityError("Path must be provided.")
+    name = build_name(name)
+    uuid = build_uuid(uuid)
+    metadata = build_metadata(
+        kind,
+        project=project,
+        name=name,
+        version=uuid,
+        description=description,
+        labels=labels,
+        embedded=embedded,
+    )
+    spec = build_spec(
+        kind,
+        path=path,
+        **kwargs,
+    )
+    status = build_status(kind)
+    cls = _choose_artifact_type(kind)
+    return cls(
+        project=project,
+        name=name,
+        uuid=uuid,
+        kind=kind,
+        metadata=metadata,
+        spec=spec,
+        status=status,
+    )
+
+
+def artifact_from_dict(obj: dict) -> Artifact:
+    """
+    Create a new object from dictionary.
+
+    Parameters
+    ----------
+    obj : dict
+        Dictionary to create object from.
+
+    Returns
+    -------
+    Artifact
+        Object instance.
+    """
+    kind = obj.get("kind")
+    cls = _choose_artifact_type(kind)
+    return cls.from_dict(obj)