From 4e8c3cbb08faf6c474a0639fcdac9bc04e8cb40e Mon Sep 17 00:00:00 2001
From: izzy lyseggen <izzy.lyseggen@gmail.com>
Date: Mon, 23 Nov 2020 18:33:03 +0000
Subject: [PATCH] feat(transports): abstract base

---
 speckle/transports/__init__.py           |  0
 speckle/transports/abstract_transport.py | 66 ++++++++++++++++++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 speckle/transports/__init__.py
 create mode 100644 speckle/transports/abstract_transport.py

diff --git a/speckle/transports/__init__.py b/speckle/transports/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/speckle/transports/abstract_transport.py b/speckle/transports/abstract_transport.py
new file mode 100644
index 0000000..e740841
--- /dev/null
+++ b/speckle/transports/abstract_transport.py
@@ -0,0 +1,66 @@
+from abc import ABC, abstractmethod
+from typing import Any
+from pydantic import BaseModel
+from pydantic.dataclasses import dataclass
+
+#  __________________
+# |                  |
+# |  this is v wip   |
+# |  pls be careful  |
+# |__________________|
+# (\__/) ||
+# (•ㅅ•)  ||
+# / 　 づ
+
+
+class Transport(ABC):
+    """Literally just so I can put a type hint in the AbstractTransport. If there is a better way to do this pls lemme know, my dude"""
+
+    @abstractmethod
+    def name(self):
+        pass
+
+
+@dataclass
+class AbstractTransport(Transport):
+    _name: str = "Abstract"
+
+    @property
+    def name(self):
+        return type(self)._name
+
+    @abstractmethod
+    def begin_write(self):
+        pass
+
+    @abstractmethod
+    def save_object(self, id: str, serialized_object: str) -> None:
+        """Saves the given serialized object.
+
+        Arguments:
+            id {str} -- the hash of the object
+            serialized_object {str} -- the full string representation of the object
+        """
+        pass
+
+    @abstractmethod
+    def save_object_from_transport(self, id: str, source_transport: Transport) -> None:
+        """Saves an object from the given source transport.
+
+        Arguments:
+            id {str} -- the hash of the object
+            source_transport {AbstractTransport) -- the transport through which the object can be found
+        """
+        pass
+
+    @abstractmethod
+    def get_object(self, id: str) -> str:
+        """Gets an object
+
+        Arguments:
+            id {str} -- the hash of the object
+
+        Returns:
+            str -- the full string representation of the object (or null of no object is found)
+        """
+        pass