forked from docarray/docarray
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbase_node.py
More file actions
37 lines (28 loc) · 958 Bytes
/
base_node.py
File metadata and controls
37 lines (28 loc) · 958 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
from abc import ABC, abstractmethod
from typing import TYPE_CHECKING, TypeVar, Optional, Type
if TYPE_CHECKING:
from docarray.proto import NodeProto
T = TypeVar('T')
class BaseNode(ABC):
"""
A DocumentNode is an object than can be nested inside a Document.
A Document itself is a DocumentNode as well as prebuilt type
"""
_proto_type_name: Optional[str] = None
@abstractmethod
def _to_node_protobuf(self) -> 'NodeProto':
"""Convert itself 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
"""
...
@classmethod
@abstractmethod
def from_protobuf(cls: Type[T], pb_msg: T) -> T:
...
def _docarray_to_json_compatible(self):
"""
Convert itself into a json compatible object
"""
...