from __future__ import annotations
from dataclasses import dataclass, field
from typing import List, Optional, Type, TypeVar
from encord.objects.common import (
Attribute,
Shape,
_add_attribute,
attribute_from_dict,
attributes_to_list_dict,
)
[docs]@dataclass
class Object:
"""
This class is currently in BETA. Its API might change in future minor version releases.
"""
uid: int
name: str
color: str
shape: Shape
feature_node_hash: str
attributes: List[Attribute] = field(default_factory=list)
[docs] @classmethod
def from_dict(cls, d: dict) -> Object:
shape_opt = Shape.from_string(d["shape"])
if shape_opt is None:
raise TypeError(f"The shape '{d['shape']}' of the object '{d}' is not recognised")
attributes_ret: List[Attribute] = list()
if "attributes" in d:
for attribute_dict in d["attributes"]:
attributes_ret.append(attribute_from_dict(attribute_dict))
object_ret = Object(
uid=int(d["id"]),
name=d["name"],
color=d["color"],
shape=shape_opt,
feature_node_hash=d["featureNodeHash"],
attributes=attributes_ret,
)
return object_ret
[docs] def to_dict(self) -> dict:
ret = dict()
ret["id"] = str(self.uid)
ret["name"] = self.name
ret["color"] = self.color
ret["shape"] = self.shape.value
ret["featureNodeHash"] = self.feature_node_hash
attributes_list = attributes_to_list_dict(self.attributes)
if attributes_list:
ret["attributes"] = attributes_list
return ret
T = TypeVar("T", bound=Attribute)
[docs] def add_attribute(
self,
cls: Type[T],
name: str,
local_uid: Optional[int] = None,
feature_node_hash: Optional[str] = None,
required: bool = False,
) -> T:
"""
Adds an attribute to the object.
Args:
cls: attribute type, one of `RadioAttribute`, `ChecklistAttribute`, `TextAttribute`
name: the user-visible name of the attribute
local_uid: integer identifier of the attribute. Normally auto-generated;
omit this unless the aim is to create an exact clone of existing ontology
feature_node_hash: global identifier of the attribute. Normally auto-generated;
omit this unless the aim is to create an exact clone of existing ontology
required: whether the label editor would mark this attribute as 'required'
Returns:
the created attribute that can be further specified with Options, where appropriate
Raises:
ValueError: if specified `local_uid` or `feature_node_hash` violate uniqueness constraints
"""
return _add_attribute(self.attributes, cls, name, [self.uid], local_uid, feature_node_hash, required)