Move some files, comment visiblegraphstate

server/server.py → abp/server.py

@@ -4,10 +4,6 @@ import abp
 import json
 
 clients = []
-state = abp.VisibleGraphState()
-
-def compute_diff(decoded_message):
-
 
 def new_message(client, server, message):
     decoded_message = json.loads(message)
@@ -29,7 +25,7 @@ def client_left(client, server):
     clients.remove(client)
 
 if __name__ == '__main__':
-    server = WebsocketServer(5001)
+    server = WebsocketServer(5000)
     server.set_fn_new_client(new_client)
     server.set_fn_message_received(new_message)
     server.set_fn_client_left(client_left)

abp/visiblegraphstate.py

@@ -9,25 +9,29 @@ from websocket import create_connection
 from graphstate import GraphState
 import json
 
+
 class VisibleGraphState(GraphState):
 
+    """ Overloads the graph state with methods for sending to the browser over a websocket """
+
     def __init__(self, *args, **kwargs):
+        """ Constructor """
         GraphState.__init__(self, *args, **kwargs)
-        self.ws = create_connection("ws://localhost:5001")
+        self.ws = create_connection("ws://localhost:5000")
         atexit.register(self.shutdown)
-        #self.ws.send(json.dumps({"method":"clear"}))
 
     def shutdown(self):
+        """ The client should shut down automatically on close """
         self.update()
         self.ws.close()
 
     def to_json(self):
-        ngbh = {a: {b : True for b in self.ngbh[a]} 
+        """ We override to_json() so that we send the whole `ngbh` structure in JS-friendly form """
+        ngbh = {a: {b: True for b in self.ngbh[a]}
                 for a in self.ngbh}
         return {"vops": self.vops, "ngbh": ngbh, "meta": self.meta}
 
     def update(self):
+        """ Call this function when you are ready to send data to the browser """
         data = json.dumps(self.to_json())
         self.ws.send(data)
-
-