Source code for medkit.core.annotation

__all__ = ["Annotation", "AnnotationType"]

from typing import Set, TypeVar
from typing_extensions import Protocol, runtime_checkable

from medkit.core.attribute_container import AttributeContainer


@runtime_checkable
class Annotation(Protocol):
    """
    Base annotation protocol that must be implemented by annotations classes of all
    modalities (text, audio, etc).

    Annotations can be attached to :class:`~medkit.core.document.Document`
    objects and can contain :class:`~medkit.core.attribute.Attribute` objects.

    Attributes
    ----------
    uid:
        Unique identifier of the annotation
    label:
        Label of the annotation, can be used to represent the "kind" of
        annotation. (ex: "sentence", "disease", etc)
    keys:
        Pipeline output keys to which the segment belongs to (cf
        :class:`~medkit.core.pipeline.Pipeline`.)
    attrs:
        Attributes of the annotation, stored in an
        :class:`~medkit.core.attribute_container.AttributeContainer` for easier
        access.
    """

    uid: str
    label: str
    keys: Set[str]
    attrs: AttributeContainer


#: Annotation type
AnnotationType = TypeVar("AnnotationType", bound=Annotation)