Id

docarray.typing.id

ID

Bases: str, AbstractType

Represent an unique ID

Source code in docarray/typing/id.py

@_register_proto(proto_type_name='id')
class ID(str, AbstractType):
    """
    Represent an unique ID
    """

    @classmethod
    def _docarray_validate(
        cls: Type[T],
        value: Union[str, int, UUID],
    ) -> T:
        try:
            id: str = str(value)
            return cls(id)
        except Exception:
            raise ValueError(f'Expected a str, int or UUID, got {type(value)}')

    def _to_node_protobuf(self) -> 'NodeProto':
        """Convert an ID into a NodeProto message. This function should
        be called when the self is nested into another Document that need to be
        converted into a protobuf

        :return: the nested item protobuf message
        """
        from docarray.proto import NodeProto

        return NodeProto(text=self, type=self._proto_type_name)

    @classmethod
    def from_protobuf(cls: Type[T], pb_msg: 'str') -> T:
        """
        read ndarray from a proto msg
        :param pb_msg:
        :return: a string
        """
        return parse_obj_as(cls, pb_msg)

    if is_pydantic_v2:

        @classmethod
        def __get_pydantic_core_schema__(
            cls, source: Type[Any], handler: 'GetCoreSchemaHandler'
        ) -> core_schema.CoreSchema:
            return core_schema.general_plain_validator_function(
                cls.validate,
            )

        @classmethod
        def __get_pydantic_json_schema__(
            cls, core_schema: core_schema.CoreSchema, handler: GetJsonSchemaHandler
        ) -> JsonSchemaValue:
            field_schema: dict[str, Any] = {}
            field_schema.update(type='string')
            return field_schema

from_protobuf(pb_msg) classmethod

read ndarray from a proto msg

Parameters:

Name	Type	Description	Default
pb_msg	str		required

Returns:

Type	Description
T	a string

Source code in docarray/typing/id.py

@classmethod
def from_protobuf(cls: Type[T], pb_msg: 'str') -> T:
    """
    read ndarray from a proto msg
    :param pb_msg:
    :return: a string
    """
    return parse_obj_as(cls, pb_msg)