Source code for docarray.document.mixins.protobuf

from typing import TYPE_CHECKING, Type, Optional

if TYPE_CHECKING:
    from docarray.typing import T
    from docarray.proto.docarray_pb2 import DocumentProto


[docs]class ProtobufMixin:
[docs] @classmethod def from_protobuf(cls: Type['T'], pb_msg: 'DocumentProto') -> 'T': from docarray.proto.io import parse_proto return parse_proto(pb_msg)
[docs] def to_protobuf(self, ndarray_type: Optional[str] = None) -> 'DocumentProto': """Convert Document into a Protobuf message. :param ndarray_type: can be ``list`` or ``numpy``, if set it will force all ndarray-like object to be ``List`` or ``numpy.ndarray``. :return: the protobuf message """ from docarray.proto.io import flush_proto return flush_proto(self, ndarray_type)