refactor: create io mixin for docuemnt array

Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
docarray · samsja · Feb 20, 2023 · Feb 17, 2023 · Feb 17, 2023 · Feb 17, 2023
commit 5e324cf5156b28f616f9d8234823d0b0eacaa417
diff --git a/docarray/array/array/array.py b/docarray/array/array/array.py
@@ -31,6 +31,7 @@
     from pydantic.fields import ModelField
 
     from docarray.array.stacked.array_stacked import DocumentArrayStacked
+    from docarray.proto import DocumentArrayProto
     from docarray.typing import TorchTensor
     from docarray.typing.tensor.abstract_tensor import AbstractTensor
 
@@ -433,3 +434,10 @@ def traverse_flat(
         flattened = AnyDocumentArray._flatten_one_level(nodes)
 
         return flattened
+
+    @classmethod
+    def from_protobuf(cls: Type[T], pb_msg: 'DocumentArrayProto') -> T:
+        """create a Document from a protobuf message
+        :param pb_msg: The protobuf message from where to construct the DocumentArray
+        """
+        return super().from_protobuf(pb_msg)
diff --git a/docarray/array/array/io.py b/docarray/array/array/io.py
@@ -4,13 +4,16 @@
 import os
 import pathlib
 import pickle
+from abc import abstractmethod
 from contextlib import nullcontext
 from typing import (
     TYPE_CHECKING,
     BinaryIO,
     ContextManager,
     Generator,
+    Iterable,
     Optional,
+    Sized,
     Tuple,
     Type,
     TypeVar,
@@ -78,7 +81,17 @@ def __getitem__(self, item: slice):
         return self.content[item]
 
 
-class IOMixinArray:
+class IOMixinArray(Iterable[BaseDocument], Sized):
+
+    document_type: Type[BaseDocument]
+
+    @abstractmethod
+    def __init__(
+        self,
+        docs: Optional[Iterable[BaseDocument]] = None,
+    ):
+        ...
+
     @classmethod
     def from_protobuf(cls: Type[T], pb_msg: 'DocumentArrayProto') -> T:
         """create a Document from a protobuf message