Merge pull request #159 from tcharding/datastore_docstring

Added doc strins to MessageStore

Author: cpacia

db/datastore.py

@@ -362,6 +362,9 @@ def __init__(self):
 
         def save_message(self, guid, handle, signed_pubkey, encryption_pubkey, subject,
                          message_type, message, timestamp, avatar_hash, signature, is_outgoing):
+            """
+            Store message in database.
+            """
             outgoing = 1 if is_outgoing else 0
             msgID = digest(message + str(timestamp)).encode("hex")
             cursor = self.db.cursor()
@@ -372,13 +375,22 @@ def save_message(self, guid, handle, signed_pubkey, encryption_pubkey, subject,
             self.db.commit()
 
         def get_messages(self, guid, message_type):
+            """
+            Return all messages matching guid and message_type.
+            """
             cursor = self.db.cursor()
             cursor.execute('''SELECT guid, handle, signedPubkey, encryptionPubkey, subject, messageType, message,
     timestamp, avatarHash, signature, outgoing, read FROM messages WHERE guid=? AND messageType=?''',
                            (guid, message_type))
             return cursor.fetchall()
 
         def get_conversations(self):
+            """
+            Get all 'conversations' composed of messages of type 'CHAT'.
+
+            Returns:
+              Array of dictionaries, one element for each guid. Dictionaries
+              include last message only."""
             cursor = self.db.cursor()
             cursor.execute('''SELECT DISTINCT guid FROM messages''',)
             guids = cursor.fetchall()
@@ -398,6 +410,9 @@ def get_conversations(self):
             return ret
 
         def get_unread(self):
+            """
+            Get Counter of guids which have unread, incoming messages.
+            """
             cursor = self.db.cursor()
             cursor.execute('''SELECT guid FROM messages WHERE read=0 and outgoing=0''',)
             ret = []
@@ -407,11 +422,17 @@ def get_unread(self):
             return Counter(ret)
 
         def mark_as_read(self, guid):
+            """
+            Mark all messages for guid as read.
+            """
             cursor = self.db.cursor()
             cursor.execute('''UPDATE messages SET read=? WHERE guid=?;''', (1, guid))
             self.db.commit()
 
         def delete_message(self, guid):
+            """
+            Delete all messages of type 'CHAT' for guid.
+            """
             cursor = self.db.cursor()
             cursor.execute('''DELETE FROM messages WHERE guid=? AND messageType="CHAT"''', (guid, ))
             self.db.commit()