More docs

services/bottom/V1.py

@@ -4,6 +4,10 @@ from services.bottom.V0 import Bottom as BottomV0
 
 
 class Bottom:
+    """
+    Implements services for LTM bottom.
+    Implemented using V0.Bottom
+    """
     def __init__(self, model: UUID, state: State):
         type_model_id = state.read_dict(state.read_root(), "Bottom")
         self.type_model = UUID(state.read_value(type_model_id))
@@ -11,7 +15,16 @@ class Bottom:
         self.bottom = BottomV0(state)
 
     def create_node(self, name: str, value=None):
+        """
+        Creates a node.
 
+        Args:
+            name: node name in model
+            value: value to be stored in the node
+
+        Returns:
+            Nothing
+        """
         if value is None:
             n = self.bottom.create_node()
         else:
@@ -19,6 +32,17 @@ class Bottom:
         self.bottom.create_edge(self.model, n, label=name)
 
     def create_edge(self, name: str, source: str, target: str):
+        """
+        Creates an edge.
+
+        Args:
+            name: edge name in model
+            source: source element of the edge
+            target: target element of the edge
+
+        Returns:
+            Nothing
+        """
         try:
             src, = self.bottom.read_outgoing_elements(self.model, source)
         except ValueError:
@@ -31,6 +55,15 @@ class Bottom:
         self.bottom.create_edge(self.model, e, label=name)
 
     def read_value(self, name: str):
+        """
+        Reads value stored in a node.
+
+        Args:
+            name: name of the node to read value from
+
+        Returns:
+            Value contained in the node. If no value is found, returns None
+        """
         try:
             element, = self.bottom.read_outgoing_elements(self.model, name)
             return self.bottom.read_value(element)
@@ -38,16 +71,47 @@ class Bottom:
             raise RuntimeError(f"No element named {name}")
 
     def read_edge_source(self, name: str):
+        """
+        Reads source element of an edge.
+
+        Args:
+            name: name of the edge to read source element of
+
+        Returns:
+            UUID of source element of the edge
+        """
         try:
             element, = self.bottom.read_outgoing_elements(self.model, name)
-            return self.bottom.read_value(element)
+            return self.bottom.read_edge_source(element)
         except ValueError:
             raise RuntimeError(f"No element named {name}")
 
     def read_edge_target(self, name: str):
-        pass
+        """
+        Reads target element of an edge.
+
+        Args:
+            name: name of the edge to read target element of
+
+        Returns:
+            UUID of target element of the edge
+        """
+        try:
+            element, = self.bottom.read_outgoing_elements(self.model, name)
+            return self.bottom.read_edge_target(element)
+        except ValueError:
+            raise RuntimeError(f"No element named {name}")
 
     def delete_element(self, name: str):
+        """
+        Delete an element
+
+        Args:
+            element: UUID of the element to be deleted
+
+        Returns:
+            Nothing
+        """
         try:
             element, = self.bottom.read_outgoing_elements(self.model, name)
             self.bottom.delete_element(element)
@@ -55,6 +119,12 @@ class Bottom:
             raise RuntimeError(f"No element named {name}")
 
     def list_elements(self):
+        """
+        Lists elements in the model.
+
+        Returns:
+            A list of elements in alphabetical order.
+        """
         tm_names = {}
         for key in self.bottom.read_keys(self.type_model):
             element, = self.bottom.read_outgoing_elements(self.type_model, key)