Source code for encord.objects.ontology_object

from __future__ import annotations

from dataclasses import dataclass, field
from typing import Any, Dict, List, Optional, Sequence, Type, TypeVar

from encord.objects.attributes import (
from encord.objects.common import Shape
from encord.objects.ontology_element import OntologyElement

[docs]@dataclass class Object(OntologyElement): uid: int name: str color: str shape: Shape feature_node_hash: str attributes: List[Attribute] = field(default_factory=list) @property def title(self) -> str: return @property def children(self) -> Sequence[OntologyElement]: return self.attributes
[docs] def create_instance(self) -> ObjectInstance: """Create a :class:`encord.objects.ObjectInstance` to be used with a label row.""" return ObjectInstance(self)
[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] = [ attribute_from_dict(attribute_dict) for attribute_dict in d.get("attributes", []) ] return Object( uid=int(d["id"]), name=d["name"], color=d["color"], shape=shape_opt, feature_node_hash=d["featureNodeHash"], attributes=attributes_ret, )
[docs] def to_dict(self) -> Dict[str, Any]: ret: Dict[str, Any] = { "id": str(self.uid), "name":, "color": self.color, "shape": self.shape.value, "featureNodeHash": self.feature_node_hash, } if attributes_list := attributes_to_list_dict(self.attributes): 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, dynamic: 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' dynamic: whether the attribute can have a different answer for the same object across different frames. 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, dynamic)
from encord.objects.ontology_object_instance import ObjectInstance