opaque

mlte/value/types/opaque.py

An opaque evaluation value, without semantics.

Opaque

Bases: Value

The 'default' Value instance for measurements that do not provide their own.

Source code in mlte/value/types/opaque.py

class Opaque(Value):
    """
    The 'default' Value instance for measurements that do not provide their own.
    """

    def __init__(self, metadata: EvidenceMetadata, data: Dict[str, Any]):
        """
        Initialize an Opaque instance.
        :param metadata: The generating measurement's metadata
        :param data: The output of the measurement
        """
        super().__init__(self, metadata)

        self.data = data
        """The raw output from measurement execution."""

    def to_model(self) -> ArtifactModel:
        """
        Convert an opaque value artifact to its corresponding model.
        :return: The artifact model
        """
        return ArtifactModel(
            header=self.build_artifact_header(),
            body=ValueModel(
                metadata=self.metadata,
                value_class=self.get_class_path(),
                value=OpaqueValueModel(
                    data=self.data,
                ),
            ),
        )

    @classmethod
    def from_model(cls, model: ArtifactModel) -> Opaque:
        """
        Convert an opaque value model to its corresponding artifact.
        :param model: The model representation
        :return: The real value
        """
        assert model.header.type == ArtifactType.VALUE, "Broken Precondition."
        body = typing.cast(ValueModel, model.body)

        assert body.value.value_type == ValueType.OPAQUE, "Broken Precondition."
        return Opaque(
            metadata=body.metadata,
            data=body.value.data,
        )

    def __getitem__(self, key: str) -> Any:
        """
        Access an item from the wrapped data object.
        :param key: The key that identifies the item to access
        :raises KeyError: If the key is not present
        :return: The value associated with `key`.
        """
        if key not in self.data:
            raise KeyError(f"Key {key} not found.")
        return self.data[key]

    def __setitem__(self, key: str, value: str) -> None:
        """Raise ValueError to indicate Opaque is read-only."""
        raise ValueError("Opaque is read-only.")

    def __eq__(self, other: object) -> bool:
        """Compare Opaque instances for equality."""
        if not isinstance(other, Opaque):
            return False
        return self._equal(other)

data = data instance-attribute

The raw output from measurement execution.

__eq__(other)

Compare Opaque instances for equality.

Source code in mlte/value/types/opaque.py

def __eq__(self, other: object) -> bool:
    """Compare Opaque instances for equality."""
    if not isinstance(other, Opaque):
        return False
    return self._equal(other)

__getitem__(key)

Access an item from the wrapped data object.

Parameters:

Name	Type	Description	Default
key	str	The key that identifies the item to access	required

Returns:

Type	Description
Any	The value associated with key.

Raises:

Type	Description
KeyError	If the key is not present

Source code in mlte/value/types/opaque.py

def __getitem__(self, key: str) -> Any:
    """
    Access an item from the wrapped data object.
    :param key: The key that identifies the item to access
    :raises KeyError: If the key is not present
    :return: The value associated with `key`.
    """
    if key not in self.data:
        raise KeyError(f"Key {key} not found.")
    return self.data[key]

__init__(metadata, data)

Initialize an Opaque instance.

Parameters:

Name	Type	Description	Default
metadata	EvidenceMetadata	The generating measurement's metadata	required
data	Dict[str, Any]	The output of the measurement	required

Source code in mlte/value/types/opaque.py

def __init__(self, metadata: EvidenceMetadata, data: Dict[str, Any]):
    """
    Initialize an Opaque instance.
    :param metadata: The generating measurement's metadata
    :param data: The output of the measurement
    """
    super().__init__(self, metadata)

    self.data = data
    """The raw output from measurement execution."""

__setitem__(key, value)

Raise ValueError to indicate Opaque is read-only.

Source code in mlte/value/types/opaque.py

def __setitem__(self, key: str, value: str) -> None:
    """Raise ValueError to indicate Opaque is read-only."""
    raise ValueError("Opaque is read-only.")

from_model(model) classmethod

Convert an opaque value model to its corresponding artifact.

Parameters:

Name	Type	Description	Default
model	ArtifactModel	The model representation	required

Returns:

Type	Description
Opaque	The real value

Source code in mlte/value/types/opaque.py

@classmethod
def from_model(cls, model: ArtifactModel) -> Opaque:
    """
    Convert an opaque value model to its corresponding artifact.
    :param model: The model representation
    :return: The real value
    """
    assert model.header.type == ArtifactType.VALUE, "Broken Precondition."
    body = typing.cast(ValueModel, model.body)

    assert body.value.value_type == ValueType.OPAQUE, "Broken Precondition."
    return Opaque(
        metadata=body.metadata,
        data=body.value.data,
    )

to_model()

Convert an opaque value artifact to its corresponding model.

Returns:

Type	Description
ArtifactModel	The artifact model

Source code in mlte/value/types/opaque.py

def to_model(self) -> ArtifactModel:
    """
    Convert an opaque value artifact to its corresponding model.
    :return: The artifact model
    """
    return ArtifactModel(
        header=self.build_artifact_header(),
        body=ValueModel(
            metadata=self.metadata,
            value_class=self.get_class_path(),
            value=OpaqueValueModel(
                data=self.data,
            ),
        ),
    )