Representation defined by traits

client/ayon_core/pipeline/traits/__init__.py

@@ -0,0 +1,60 @@
+"""Trait classes for the pipeline."""
+from .content import (
+    Bundle,
+    Compressed,
+    FileLocation,
+    MimeType,
+    RootlessLocation,
+)
+from .lifecycle import Persistent, Transient
+from .meta import Tagged, TemplatePath
+from .three_dimensional import Spatial
+from .time import Clip, GapPolicy, Sequence, SMPTETimecode
+from .trait import Representation, TraitBase
+from .two_dimensional import (
+    UDIM,
+    Deep,
+    Image,
+    Overscan,
+    PixelBased,
+    Planar,
+)
+
+__all__ = [
+    # base
+    "Representation",
+    "TraitBase",
+
+    # content
+    "Bundle",
+    "Compressed",
+    "FileLocation",
+    "MimeType",
+    "RootlessLocation",
+
+    # life cycle
+    "Persistent",
+    "Transient",
+
+    # meta
+    "Tagged",
+    "TemplatePath",
+
+    # two-dimensional
+    "Compressed",
+    "Deep",
+    "Image",
+    "Overscan",
+    "PixelBased",
+    "Planar",
+    "UDIM",
+
+    # three-dimensional
+    "Spatial",
+
+    # time
+    "Clip",
+    "GapPolicy",
+    "Sequence",
+    "SMPTETimecode",
+]

client/ayon_core/pipeline/traits/content.py

@@ -0,0 +1,135 @@
+"""Content traits for the pipeline."""
+from __future__ import annotations
+
+# TCH003 is there because Path in TYPECHECKING will fail in tests
+from pathlib import Path  # noqa: TCH003
+from typing import ClassVar, Optional
+
+from pydantic import Field
+
+from .trait import Representation, TraitBase
+
+
+class MimeType(TraitBase):
+    """MimeType trait model.
+
+    This model represents a mime type trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        mime_type (str): Mime type.
+
+    """
+
+    name: ClassVar[str] = "MimeType"
+    description: ClassVar[str] = "MimeType Trait Model"
+    id: ClassVar[str] = "ayon.content.MimeType.v1"
+    mime_type: str = Field(..., title="Mime Type")
+
+class FileLocation(TraitBase):
+    """FileLocation trait model.
+
+    This model represents a file location trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        file_path (str): File path.
+        file_size (int): File size in bytes.
+        file_hash (str): File hash.
+
+    """
+
+    name: ClassVar[str] = "FileLocation"
+    description: ClassVar[str] = "FileLocation Trait Model"
+    id: ClassVar[str] = "ayon.content.FileLocation.v1"
+    file_path: Path = Field(..., title="File Path")
+    file_size: int = Field(..., title="File Size")
+    file_hash: Optional[str] = Field(None, title="File Hash")
+
+class RootlessLocation(TraitBase):
+    """RootlessLocation trait model.
+
+    This model represents a rootless location trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        rootless_path (str): Rootless path.
+
+    """
+
+    name: ClassVar[str] = "RootlessLocation"
+    description: ClassVar[str] = "RootlessLocation Trait Model"
+    id: ClassVar[str] = "ayon.content.RootlessLocation.v1"
+    rootless_path: str = Field(..., title="File Path")
+
+
+class Compressed(TraitBase):
+    """Compressed trait model.
+
+    This model represents a compressed trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        compression_type (str): Compression type.
+
+    """
+
+    name: ClassVar[str] = "Compressed"
+    description: ClassVar[str] = "Compressed Trait"
+    id: ClassVar[str] = "ayon.content.Compressed.v1"
+    compression_type: str = Field(..., title="Compression Type")
+
+
+class Bundle(TraitBase):
+    """Bundle trait model.
+
+    This model list of independent Representation traits
+    that are bundled together. This is useful for representing
+    a collection of representations that are part of a single
+    entity.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        items (list[list[TraitBase]]): List of representations.
+
+    """
+
+    name: ClassVar[str] = "Bundle"
+    description: ClassVar[str] = "Bundle Trait"
+    id: ClassVar[str] = "ayon.content.Bundle.v1"
+    items: list[list[TraitBase]] = Field(
+        ..., title="Bundles of traits")
+
+    def to_representation(self) -> Representation:
+        """Convert to a representation."""
+        return Representation(traits=self.items)
+
+
+class Fragment(TraitBase):
+    """Fragment trait model.
+
+    This model represents a fragment trait. A fragment is a part of
+    a larger entity that is represented by a representation.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        parent (str): Parent representation id.
+
+    """
+
+    name: ClassVar[str] = "Fragment"
+    description: ClassVar[str] = "Fragment Trait"
+    id: ClassVar[str] = "ayon.content.Fragment.v1"
+    parent: str = Field(..., title="Parent Representation Id")

client/ayon_core/pipeline/traits/lifecycle.py

@@ -0,0 +1,37 @@
+"""Lifecycle traits."""
+from typing import ClassVar
+
+from .trait import TraitBase
+
+
+class Transient(TraitBase):
+    """Transient trait model.
+
+    This model represents a transient trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        tags (List[str]): Tags.
+    """
+
+    name: ClassVar[str] = "Transient"
+    description: ClassVar[str] = "Transient Trait Model"
+    id: ClassVar[str] = "ayon.lifecycle.Transient.v1"
+
+
+class Persistent(TraitBase):
+    """Persistent trait model.
+
+    This model represents a persistent trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+    """
+
+    name: ClassVar[str] = "Persistent"
+    description: ClassVar[str] = "Persistent Trait Model"
+    id: ClassVar[str] = "ayon.lifecycle.Persistent.v1"

client/ayon_core/pipeline/traits/meta.py

@@ -0,0 +1,44 @@
+"""Metadata traits."""
+from typing import ClassVar, List
+
+from pydantic import Field
+
+from .trait import TraitBase
+
+
+class Tagged(TraitBase):
+    """Tagged trait model.
+
+    This model represents a tagged trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        tags (List[str]): Tags.
+    """
+
+    name: ClassVar[str] = "Tagged"
+    description: ClassVar[str] = "Tagged Trait Model"
+    id: ClassVar[str] = "ayon.meta.Tagged.v1"
+    tags: List[str] = Field(..., title="Tags")
+
+
+class TemplatePath(TraitBase):
+    """TemplatePath trait model.
+
+    This model represents a template path with formatting data.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        template_path (str): Template path.
+        data (dict[str]): Formatting data.
+    """
+
+    name: ClassVar[str] = "TemplatePath"
+    description: ClassVar[str] = "Template Path Trait Model"
+    id: ClassVar[str] = "ayon.meta.TemplatePath.v1"
+    template: str = Field(..., title="Template Path")
+    data: dict = Field(..., title="Formatting Data")

client/ayon_core/pipeline/traits/three_dimensional.py

@@ -0,0 +1,23 @@
+"""Two-dimensional image traits."""
+from typing import ClassVar
+
+from pydantic import Field
+
+from .trait import TraitBase
+
+
+class Spatial(TraitBase):
+    """Spatial trait model.
+
+    Attributes:
+        up_axis (str): Up axis.
+        handedness (str): Handedness.
+        meters_per_unit (float): Meters per unit.
+
+    """
+    id: ClassVar[str] = "ayon.3d.Spatial.v1"
+    name: ClassVar[str] = "Spatial"
+    description: ClassVar[str] = "Spatial trait model."
+    up_axis: str = Field(..., title="Up axis")
+    handedness: str = Field(..., title="Handedness")
+    meters_per_unit: float = Field(..., title="Meters per unit")

client/ayon_core/pipeline/traits/time.py

@@ -0,0 +1,86 @@
+"""Temporal (time related) traits."""
+from __future__ import annotations
+
+from enum import Enum, auto
+from typing import ClassVar, Optional
+
+from pydantic import Field
+
+from .trait import TraitBase
+
+
+class GapPolicy(Enum):
+    """Gap policy enumeration.
+
+    Attributes:
+        forbidden (int): Gaps are forbidden.
+        missing (int): Gaps are interpreted as missing frames.
+        hold (int): Gaps are interpreted as hold frames (last existing frames).
+        black (int): Gaps are interpreted as black frames.
+    """
+    forbidden = auto()
+    missing = auto()
+    hold = auto()
+    black = auto()
+
+class Clip(TraitBase):
+    """Clip trait model.
+
+    Model representing a clip trait.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        frame_start (int): Frame start.
+        frame_end (int): Frame end.
+        frame_start_handle (int): Frame start handle.
+        frame_end_handle (int): Frame end handle.
+
+    """
+    name: ClassVar[str] = "Clip"
+    description: ClassVar[str] = "Clip Trait"
+    id: ClassVar[str] = "ayon.time.Clip.v1"
+    frame_start: int = Field(..., title="Frame Start")
+    frame_end: int = Field(..., title="Frame End")
+    frame_start_handle: Optional[int] = Field(0, title="Frame Start Handle")
+    frame_end_handle: Optional[int] = Field(0, title="Frame End Handle")
+
+class Sequence(Clip):
+    """Sequence trait model.
+
+    This model represents a sequence trait. Based on the Clip trait,
+    adding handling for steps, gaps policy and frame padding.
+
+    Attributes:
+        name (str): Trait name.
+        description (str): Trait description.
+        id (str): id should be namespaced trait name with version
+        step (int): Frame step.
+        gaps_policy (GapPolicy): Gaps policy - how to handle gaps in
+            sequence.
+        frame_padding (int): Frame padding.
+        frame_regex (str): Frame regex - regular expression to match
+            frame numbers.
+        frame_list (str): Frame list specification of frames. This takes
+            string like "1-10,20-30,40-50" etc.
+
+    """
+    name: ClassVar[str] = "Sequence"
+    description: ClassVar[str] = "Sequence Trait Model"
+    id: ClassVar[str] = "ayon.time.Sequence.v1"
+    step: Optional[int] = Field(1, title="Step")
+    gaps_policy: GapPolicy = Field(
+        GapPolicy.forbidden, title="Gaps Policy")
+    frame_padding: int = Field(..., title="Frame Padding")
+    frame_regex: str = Field(..., title="Frame Regex")
+    frame_list: Optional[str] = Field(None, title="Frame List")
+
+
+# Do we need one for drop and non-drop frame?
+class SMPTETimecode(TraitBase):
+    """Timecode trait model."""
+    name: ClassVar[str] = "Timecode"
+    description: ClassVar[str] = "SMPTE Timecode Trait"
+    id: ClassVar[str] = "ayon.time.SMPTETimecode.v1"
+    timecode: str = Field(..., title="SMPTE Timecode HH:MM:SS:FF")